AthenaShared.interfaces.item.BaseItem ​

shared/interfaces/item.BaseItem

The BaseItem is used as a way for the main items to point towards item information. This item stored in the database is used to construct front facing item information.

Interface

BaseItem

Type parameters ​

Hierarchy ​

• SharedItem<CustomData>

  ↳ BaseItem

Properties ​

_id ​

• Optional _id: unknown

Database entry for item. Do not add / append.

Defined in ​

shared/interfaces/item.ts:312

behavior ​

• Optional behavior: Behavior

Behavior associated with this item.

Defined in ​

shared/interfaces/item.ts:353

consumableEventToCall ​

• Optional consumableEventToCall: string | string[]

The event to call when this item is consumed.

Defined in ​

shared/interfaces/item.ts:361

customEventsToCall ​

• Optional customEventsToCall: CustomContextAction[]

Custom context actions in addition to the standard consumable event.

Defined in ​

shared/interfaces/item.ts:369

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

icon ​

• icon: string

A client-side icon name. They are specified and created by you.

Defined in ​

shared/interfaces/item.ts:329

maxStack ​

• Optional maxStack: number

If this value is defined it will be used as the maximum stack size for the item.

Defined in ​

shared/interfaces/item.ts:337

model ​

• Optional model: string

The drop model of this item when it is on the ground. If not defined it will default to a box of some sort.

Defined in ​

shared/interfaces/item.ts:378

msTimeout ​

• Optional msTimeout: number

An expiration time in milliseconds before the item drop is cleared. Stored items come with an expiration date.

Defined in ​

shared/interfaces/item.ts:387

name ​

• name: string

The name of this item.

Defined in ​

shared/interfaces/item.ts:320

version ​

• Optional version: number

The version of this item it is based upon.

Inherited from ​

SharedItem.version

Defined in ​

shared/interfaces/item.ts:212

weight ​

• Optional weight: number

The weight of this item.

Defined in ​

shared/interfaces/item.ts:345