Item

Represents an item instance in the game.

Properties

ItemDataAsset ItemDataAsset

• Read-Only

• The item data asset this item is associated with.

Sprite Sprite

• Read-Only

• The icon of this item shown in the inventory.

string CustomName

• Gets or sets the custom name of this item instance.

string ItemName

• Read-Only

• The base name of the item from its item data asset.

string Name

• Gets the custom name if assigned or the base name. Sets the custom name.

int Count

• Read-Only

• The count of this item instance.

int Durability

• Gets or sets the durability of this item instance.

int ItemID

• Read-Only

• The item's item database ID.

int MaxCount

• Read-Only

• The maximum count allowed in a slot for this item.

int MaxDurability

• Read-Only

• The maximum durability allowed for this item.

Events

Action<int, int> CountChanged

• Called when the count of this item changes. Arguments are the old and the new count respectively.

Action<int, int> DurabilityChanged

• Called when the durability of this item changes. Arguments are the old and the new durability respectively.

Methods

GameObject InstantiateItemPrefab()

• Instantiates the prefab associated with this item.

bool IsStackable()

• Determines whether or not this item can be stacked together in item slots.

bool UseItem(EntityBase user, bool performAll, ActionContextFlags contextFlags)

• Performs the action sequences of this item.

• user The user of this item.

• performAll Whether or not to perform all the action sequences or just the first successful one.

• contextFlags The context in which this item is being used.

int AddCount(int amount)

• Adds the specified amount to this item's count.

• Clamped at the maximum count value.

• amount The amount to add.

int RemoveCount(int amount)

• Removes the specified amount from this item's count.

• amount The amount to remove.