V5 DocsAthenaClient.systems.inventory.get ​
Type Aliases ​
ItemChangeCallback ​
Ƭ ItemChangeCallback: (items: player[]) => void
Type declaration ​
Usage
AthenaClient.systems.inventory.get.(items): void
Parameters ​
| Name | Type |
|---|---|
items | player[] |
Returns ​
void
Defined in ​
client/systems/inventory/get.ts:4
WeightChangeCallback ​
Ƭ WeightChangeCallback: (weight: number) => void
Type declaration ​
Usage
AthenaClient.systems.inventory.get.(weight): void
Parameters ​
| Name | Type |
|---|---|
weight | number |
Returns ​
void
Defined in ​
client/systems/inventory/get.ts:5
Functions ​
inventory ​
Usage
AthenaClient.systems.inventory.get.inventory(): player[]
A list of the current items in the inventory.
Export
Returns ​
player[]
Defined in ​
client/systems/inventory/get.ts:31
onInventoryChange ​
Usage
AthenaClient.systems.inventory.get.onInventoryChange(callback): void
Invoke the callback whenever inventory changes.
Export
Parameters ​
| Name | Type |
|---|---|
callback | ItemChangeCallback |
Returns ​
void
Defined in ​
client/systems/inventory/get.ts:51
onToolbarChange ​
Usage
AthenaClient.systems.inventory.get.onToolbarChange(callback): void
Invoke the callback whenever the toolbar changes.
Export
Parameters ​
| Name | Type |
|---|---|
callback | ItemChangeCallback |
Returns ​
void
Defined in ​
client/systems/inventory/get.ts:61
onTotalWeightChange ​
Usage
AthenaClient.systems.inventory.get.onTotalWeightChange(callback): void
Invoke the weight change whenever the total weight changes.
Export
Parameters ​
| Name | Type |
|---|---|
callback | WeightChangeCallback |
Returns ​
void
Defined in ​
client/systems/inventory/get.ts:71
toolbar ​
Usage
AthenaClient.systems.inventory.get.toolbar(): player[]
A list of the current items in the toolbar.
Export
Returns ​
player[]
Defined in ​
client/systems/inventory/get.ts:21
totalWeight ​
Usage
AthenaClient.systems.inventory.get.totalWeight(): number
A list of the current total weight of inventory and toolbar.
Export
Returns ​
number