Introduction
This plugin adds a socket to an item. Multiple instances of this plugin can be added to a single item.
Fields#
| Name | Description |
|---|---|
| Socket Id | Id of the socket this ability is used with |
| Removal Type | Item removal type |
| On Attachment Changed | Event raised when attached item changes |
| On Item Attached | Event raised when an item is attached to the socket |
| On Item Removed | Event raised when an item is removed from the socket |
| On Action State Changed | Event raised whenever the action state changes |
Properties#
| Name | Description |
|---|---|
| attachedItem | Gets the item attached to this socket |
| isAction | Gets if the plugin is an action |
| title | Title of the plugin |
| description | Description of the plugin |
| actionKeys | Action keys the plugin responds to |
| host | Inventory hosting the plugin |
| item | Gets the item associated with the plugin |
| icon | Icon associated with the plugin |
| titlebarText | Text to display in the titlebar for the plugin |
Methods#
| Name | Description |
|---|---|
| IsActionReady | Get if a specific action is ready to perform |
| IsNewItemBetter | Check if a new item is better than the current attachment (if swapping allowed) |
| OnItemDropped | Method called when another item is dropped onto this one (return true if event handled) |
| PerformAction | Perform the default action |
| 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 |
| OnAfterAttack | Method to call whenever the player deals damage to another object |
| Shutdown | Shuts down the object |