Introduction
This class allows an Inventory Item to be defined
Fields#
| Name | Description |
|---|---|
| Category Id | Category of the item |
| Weight | Weight of the item |
| Value | Value of the item |
| Rarity | Rarity of the item |
| Premium Item | Make item only unlockable with premium currency |
| Premium Id | Premium currency used to purchase item |
| Premimum Cost | Cost of item in premium currency |
| Parent Container | Container holding the item |
| On Count Changed | Event raised when count changes |
| On Initialized | Event raised when item is initialized |
| On Equip State Changed | Event raised when equip state changes |
| On Display Name Changed | Event raised when the display name changes |
| On Weight Changed | Event raised when item weight changes |
| On Stats Changed | Event raised when stats changes |
| Container | Container for items housed by this item |
Properties#
| Name | Description |
|---|---|
| count | Get/Set the current count of the object in a single stack |
| currentClient | Get/Set the Equip Slot Client this item is currently equipped to |
| customName | Get/Set the custom name for this item |
| displayName | Get the current display name to use for this item |
| info | Information about this object |
| initialized | Get if this object has been initialized |
| instanceId | Get the id of this instance of the object |
| isEquipped | Get/Set if this item is equipped |
| maxStacks | Get the maximum number of allowed stacks for this item |
| pluginWrappers | Get a list of plugin wrappers on this item |
| plugins | Get a list of plugins on this item |
| premimumValue | Get the premium value of this item |
| rarity | Get the rarity value of this item |
| statIds | Get a list of stat ids for this item |
| statSource | Get the Item Stat Source for this item |
| setId | Item Bonus Set assigned for this item |
| type | Gets the type of the object |
| value | Get the value of this item |
| weight | Get the weight of this item |
Methods#
| Name | Description |
|---|---|
| AddNameModifier | Add a name modifier to the item |
| AddPlugin | Add a plugin to the item |
| AddStatValue | Add to the value of a stat |
| CanPerformAction | Check if a plugin action can be performed |
| Clone | Create a clone of this object |
| CopyValues | Copy all values from another object to this one |
| DataLoad | Load data from a stream |
| DataSave | Save data to a stream |
| GetInheritsFrom | Gets the item this object inherits from |
| GetPlugin | Get a plugin of type T |
| GetPluginByInstance | Get a plugin of type T and matches supplied instanceId |
| GetPlugins | Get a list of plugins of type T |
| GetStat | Get a stat by id |
| GetStatValue | Get the value of a stat by id |
| Initialize | Initialize the object |
| Matches | Compare object to another copy |
| PerformAction | Perform a plugin action |
| RemoveNameModifier | Remove a name modifier |
| SetStatExpression | Set the expression of a stat |
| SetStatValue | Set the value of a stat by id |
| Shutdown | Shuts down the object |
| ToJSON | Convert item into JSON |