You are viewing a potentially older version of this package. View all versions.
WhiteSpike-Custom_Item_Behaviour_Library-1.2.4 icon

Custom Item Behaviour Library

Library focused on providing custom GrabbableObject scripts which can be used on item implementations for other modders

Date uploaded 2 weeks ago
Version 1.2.4
Download link WhiteSpike-Custom_Item_Behaviour_Library-1.2.4.zip
Downloads 37095
Dependency string WhiteSpike-Custom_Item_Behaviour_Library-1.2.4

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2100 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2100

README

Custom Item Behaviour Library

A library which provides several GrabbableObject behaviours which can be used by other modders for their own item implementations.

Currently provided behaviours

  • LookoutBehaviour - behaviour used to stop coil-heads from moving when placed on the floor. Example of item that uses this behaviour is the Peeper.
  • UnderwaterBreatherBehaviour - behaviour used to retain oxygen when underwater due to flooded weather. Example of item that uses this behaviour is the Diving Kit
  • ContainerBehaviour - behaviour used to store other items inside it to be transported along with it. Example of item that uses this behaviour is the Wheelbarrow and Shopping Cart
  • PortableTeleporterBehaviour - behaviour used to teleport the player that interacted with the item when a teleporter is present. Examples of item that uses this behaviour are the Portable Teleporters
  • ReplenishBatteryBehaviour - behaviour used to replenish other items that contain a battery to refill their battery life.
  • ReplenishSanityBehaviour - behaviour used to replenish the player's sanity level instantly when consumed and provide an buff which reduces the amount of sanity you lose overtime.

How to use these behaviours on your own item implementations

  • In the programatic way, you will just need to reference the assembly related to this library into your csproj file which then should allow you to see the several behaviours available to you.

License

This library is under MIT License. Meaning that you can decide to take this library for your own things and customize it as you need, so long as you follow the license's requirements

CHANGELOG

1.2.4
  • Fixed issue with Bag Belt from latest beta release where containers wouldn't update their holding weight.
  • Also doesn't allow to put containers inside the Bag Belt.
1.2.3
  • Fixed the same issue again due to changes in version 62 of the main game.
1.2.2
  • Fixed issue with LookoutBehaviour not working correctly due to modification in SpringManAI's Update function, leading to the related patch give unwanted result.
1.2.1
  • Made enemies not being able to deposited to the containers unless they are dead (due to the new enemy from v60 release).
1.2.0
  • Added "ReplenishSanityBehaviour" abstract class which focuses on restoring player's sanity when consumed and provide a sanity rate over time after consuming it.
  • Modified "ContainerBehaviour" abstract class to allow making depositted items invisible and to make the deposit triggers inactive when overriding the condition to be active.
1.1.0
  • Added "ReplenishBatteryBehaviour" abstract class which focuses on charging items with a battery upon activating the item (Left Click by default)
1.0.1
  • Fixed issue with ContainerBehaviour scripts not resetting the movement debuffs when the player dies holding one.
  • Fixed issue with Lategame Upgrades Compatibility not being correctly implemented.

1.0.0

  • Initial release