Skip to main content

Introduction

This plugin adds a socket to an item. Multiple instances of this plugin can be added to a single item.

Fields#

NameDescription
Socket IdId of the socket this ability is used with
Removal TypeItem removal type
On Attachment ChangedEvent raised when attached item changes
On Item AttachedEvent raised when an item is attached to the socket
On Item RemovedEvent raised when an item is removed from the socket
On Action State ChangedEvent raised whenever the action state changes

Properties#

NameDescription
attachedItemGets the item attached to this socket
isActionGets if the plugin is an action
titleTitle of the plugin
descriptionDescription of the plugin
actionKeysAction keys the plugin responds to
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
IsActionReadyGet if a specific action is ready to perform
IsNewItemBetterCheck if a new item is better than the current attachment (if swapping allowed)
OnItemDroppedMethod called when another item is dropped onto this one (return true if event handled)
PerformActionPerform the default action
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
OnAfterAttackMethod to call whenever the player deals damage to another object
ShutdownShuts down the object