AthenaShared.interfaces.item.StoredItem ​

shared/interfaces/item.StoredItem

The StoredItem is stored in the player in the following locations: equipment, inventory, and toolbar

Interface

StoredItem

Type parameters ​

Hierarchy ​

• SharedItem<CustomData>

  ↳ StoredItem

Properties ​

data ​

• data: CustomData

Any custom data assigned to this item.

Inherited from ​

SharedItem.data

Defined in ​

shared/interfaces/item.ts:204

dbName ​

• dbName: string

The matching database name for this item.

Inherited from ​

SharedItem.dbName

Defined in ​

shared/interfaces/item.ts:196

disableCrafting ​

• Optional disableCrafting: boolean

Flag this item as uncraftable. Just in case it has a shared base.

Defined in ​

shared/interfaces/item.ts:277

icon ​

• Optional icon: string

Specify an icon to override the default base item icon with.

Defined in ​

shared/interfaces/item.ts:269

isEquipped ​

• Optional isEquipped: boolean

A generic way to flag an item to be equipped. Equipped can mean anything in the code base; it's up to the user to define its equip usage.

Defined in ​

shared/interfaces/item.ts:253

name ​

• Optional name: string

A new name to associate with this item.

This is completely optional, and uses the base item name by default

Memberof

StoredItem

Defined in ​

shared/interfaces/item.ts:287

quantity ​

• quantity: number

The amount of this item the player has.

Defined in ​

shared/interfaces/item.ts:236

slot ​

• slot: number

Where this item should be displayed in a toolbar, equipment bar, or inventory bar.

Defined in ​

shared/interfaces/item.ts:244

totalWeight ​

• Optional totalWeight: number

The weight calculated for this item.

Defined in ​

shared/interfaces/item.ts:261

version ​

• Optional version: number

The version of this item it is based upon.

Inherited from ​

SharedItem.version

Defined in ​

shared/interfaces/item.ts:212