Skip to main content

Introduction

This plugin allows you to set a Blackboard value while the item is equipped. The value is unset when the item is unequiped.

Fields#

NameDescription
Equip Slot FilterFilter to use
Equip Slot IdsEquip Slot Ids to filter
SourceSource of the blackboard
Registry KeyToolRegistry key for blackboard
Field NameBlackboard field
Value TypeValue type
Bool ValueBool value
Int ValueInt value
Float ValueFloat value
String ValueString value
Vector 2 ValueVector2 value
Vector 3 ValueVector3 value
On Action State ChangedEvent raised whenever the action state changes

Properties#

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

Methods#

NameDescription
RunCommandRun a command
AfterAddMethod run after item is added to inventory
AllowActionCheck if an action is allowed
BeforeAddMethod run before item is added to inventory
DataSavePrepare data for serialization and saving
HasActionKeyCheck if plugin has action key
InitializeInitialize the plugin
IsActionReadyGet if a specific action is ready to perform
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
PerformActionPerform the default action
ShutdownShuts down the object