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#
| Name | Description |
|---|---|
| Equip Slot Filter | Filter to use |
| Equip Slot Ids | Equip Slot Ids to filter |
| Source | Source of the blackboard |
| Registry Key | ToolRegistry key for blackboard |
| Field Name | Blackboard field |
| Value Type | Value type |
| Bool Value | Bool value |
| Int Value | Int value |
| Float Value | Float value |
| String Value | String value |
| Vector 2 Value | Vector2 value |
| Vector 3 Value | Vector3 value |
| On Action State Changed | Event raised whenever the action state changes |
Properties#
| Name | Description |
|---|---|
| title | Title of the plugin |
| description | Description of the plugin |
| titlebarText | Text to display in the titlebar for the plugin |
| actionKeys | Action keys the plugin responds to |
| host | Inventory hosting the plugin |
| isAction | Gets if the plugin is an action |
| item | Gets the item associated with the plugin |
| icon | Icon associated with the plugin |
Methods#
| Name | Description |
|---|---|
| RunCommand | Run a command |
| AfterAdd | Method run after item is added to inventory |
| AllowAction | Check if an action is allowed |
| BeforeAdd | Method run before item is added to inventory |
| DataSave | Prepare data for serialization and saving |
| HasActionKey | Check if plugin has action key |
| Initialize | Initialize the plugin |
| IsActionReady | Get if a specific action is ready to perform |
| OnItemDropped | Method called when another item is dropped onto this one (return true if event handled) |
| OnAfterAttack | Method to call whenever the player deals damage to another object |
| PerformAction | Perform the default action |
| Shutdown | Shuts down the object |