Custom Item Behaviour Library
Library focused on providing custom GrabbableObject scripts which can be used on item implementations for other modders
About this mod Author’s original text
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, Shopping Cart and Scifi Box.
- 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
Install & use Install: BepInEx plugin
- The archive from playbuff is the mod itself — usually a BepInEx plugin (a .dll or a plugin folder once unzipped).
- Recommended: use a community mod manager (such as r2modman) — pick this game, import the mod, and the manager sets up BepInEx and its dependencies for you.
- Manual route: install the BepInEx loader in the game folder, then drop the unzipped .dll or plugin folder into BepInEx/plugins/.
- Launch the game — the BepInEx console logs every plugin it loads; seeing this mod in the log means it is installed.
Mods with listed dependencies need those installed too, or they will not load. Options are usually changed in-game or in the plugin's config file.
Install these first, or the mod will not work: