Skip to main content

Introduction

This plugin allows an item to be scrapped, meaning the item is destroyed and new items are added.

Fields#

NameDescription
ResultsList of items to add to inventory after scrapping this item
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
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
PerformActionPerform the default action
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
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
RunCommandRun a command
ShutdownShuts down the object