Skip to main content

Introduction

This plugin allows an item to be equipped

Fields#

NameDescription
Auto EquipAuto-equip type
RequirementsExpression that must be true to allow equip
Slot IdsEquipSlots this item can use
Spawn ItemSpawn item when equipping
Equip SpawnItem to spawn on equip
On Action State ChangedEvent raised whenever the action state changes

Properties#

NameDescription
actionKeysAction keys the plugin responds to
isActionGets if the plugin is an action
titleTitle of the plugin
descriptionDescription of the plugin
hostInventory hosting the plugin
itemGets the item associated with the plugin
iconIcon associated with the plugin
titlebarTextText to display in the titlebar for the plugin

Methods#

NameDescription
AfterAddMethod run after item is added to inventory
HasActionKeyCheck if plugin has action key
IsActionReadyGet if a specific action is ready to perform
InitializeInitialize the plugin
PerformActionPerform the default action
AllowActionCheck if an action is allowed
BeforeAddMethod run before item is added to inventory
DataSavePrepare data for serialization and saving
OnItemDroppedMethod called when another item is dropped onto this one (return true if event handled)
OnAfterAttackMethod to call whenever the player deals damage to another object
RunCommandRun a command
ShutdownShuts down the object