Introduction
This plugin enables an item to be attached to a socket
Fields#
| Name | Description |
|---|---|
| Auto Attach | Auto attach mode |
| Name Modification Type | Name modifier type |
| Name Modifier | Name modifier to apply |
| Modifier Priority | Priority to assign to name modifier (lower numbers appear further left |
| Allowed Socket Ids | List of socket Ids this item can attached to |
| Spawn Item | Spawn item when equipping |
| Attach Spawn | Item to spawn on attach |
| On Action State Changed | Event raised whenever the action state changes |
Properties#
| Name | Description |
|---|---|
| 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 |
| preventAutoAttach | Get/Set if auto-attachment should be prevented |
| 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 |
|---|---|
| AllowAction | Check if an action is allowed |
| AfterAdd | Method run after item is added to inventory |
| 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 |
| RunCommand | Run a command |
| Shutdown | Shuts down the object |