Athena.player.inventory ​

Modules ​

• Internal

Functions ​

add ​

Add a new stored item to a user, must specify a quantity of greater than zero.

Automatically checks weight upon new item additions. Exceeding the weight; cancels the add.

Does not look into toolbar.

Example ​

const didAdd = await Athena.player.inventory.add(somePlayer, { dbName: 'burger', quantity: 1, data: {} })

Parameters ​

Returns ​

Promise<boolean>

Defined in ​

server/player/inventory.ts:24

getAt ​

Returns an item from a specific slot.

This item is cloned, and not attached to the inventory.

Never modify the item directly; this is only to get item information.

Example ​

const someData = Athena.player.inventory.getAt<{ myCustomStuff: string }>(somePlayer, someSlot);

Type parameters ​

Parameters ​

Returns ​

player<CustomData> | undefined

Defined in ​

server/player/inventory.ts:219

getItemData ​

Returns the custom item data assigned to a specific item.

Will return undefined if the custom data is not available.

Only checks the inventory.

Example ​

const someData = Athena.player.inventory.getItemData<{ myCustomStuff: string }>(somePlayer, someSlot);

Type parameters ​

Parameters ​

Returns ​

CustomData | undefined

Defined in ​

server/player/inventory.ts:178

has ​

Verify that the player has at least 'x' of an item in their inventory

Example ​

const hasItem = await Athena.player.inventory.has(somePlayer, 'burger', 1);

Parameters ​

Returns ​

any

Defined in ​

server/player/inventory.ts:143

modifyItemData ​

Find an item at a specific slot, and changes its entire custom data section.

Think of this like an easy to use 'setter' for item data.

Only checks the inventory.

Example ​

const someData = Athena.player.inventory.getItemData<{ myCustomStuff: string }>(somePlayer, someSlot);

someData.myCustomStuff = 'Hello World!';

await Athena.player.inventory.modifyItemData<typeof someData>(player, someSlot, someData);

Type parameters ​

Parameters ​

Returns ​

Promise<boolean>

Defined in ​

server/player/inventory.ts:264

override ​

Used to override any internal inventory functions

Parameters ​

Returns ​

any

Defined in ​

server/player/inventory.ts:305

Used to override any internal inventory functions

Parameters ​

Returns ​

any

Defined in ​

server/player/inventory.ts:306

Used to override any internal inventory functions

Parameters ​

Returns ​

any

Defined in ​

server/player/inventory.ts:307

Used to override any internal inventory functions

Parameters ​

Returns ​

any

Defined in ​

server/player/inventory.ts:308

Used to override any internal inventory functions

Parameters ​

Returns ​

any

Defined in ​

server/player/inventory.ts:309

Used to override any internal inventory functions

Parameters ​

Returns ​

any

Defined in ​

server/player/inventory.ts:310

Used to override any internal inventory functions

Parameters ​

Returns ​

any

Defined in ​

server/player/inventory.ts:311

remove ​

Delete an item in a specific slot in an inventory data set.

Does not look into toolbar.

Example ​

const didRemove = await Athena.player.inventory.remove(somePlayer, someSlot);

Parameters ​

Returns ​

Promise<boolean>

Defined in ​

server/player/inventory.ts:107

sub ​

Subtract a quantity of an item from a player's inventory. Does not look into toolbar.

Example ​

const didRemove = await Athena.player.inventory.sub(somePlayer, { dbName: 'burger', quantity: 1 });

Parameters ​

Returns ​

Promise<boolean>

Defined in ​

server/player/inventory.ts:70