Skip to main content

Introduction

This plugin enables an item to be attached to a socket

Fields#

NameDescription
Auto AttachAuto attach mode
Name Modification TypeName modifier type
Name ModifierName modifier to apply
Modifier PriorityPriority to assign to name modifier (lower numbers appear further left
Allowed Socket IdsList of socket Ids this item can attached to
Spawn ItemSpawn item when equipping
Attach SpawnItem to spawn on attach
On Action State ChangedEvent raised whenever the action state changes

Properties#

NameDescription
isActionGets if the plugin is an action
titleTitle of the plugin
descriptionDescription of the plugin
actionKeysAction keys the plugin responds to
preventAutoAttachGet/Set if auto-attachment should be prevented
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
AllowActionCheck if an action is allowed
AfterAddMethod run after item is added to inventory
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
RunCommandRun a command
ShutdownShuts down the object