Skip to content
On this page

Athena.player.get

Modules

Functions

accountPermissions

Usage

Athena.player.get.accountPermissions(player): string[]

Return a list of account permissions.

Export

Parameters

NameType
playerPlayer

Returns

string[]

Defined in

server/player/get.ts:144


bank

Usage

Athena.player.get.bank(player): any

Get a characters current bank balance.

Export

Parameters

NameType
playerPlayer

Returns

any

Defined in

server/player/get.ts:36


cash

Usage

Athena.player.get.cash(player): any

Get a characters current cash balance.

Export

Parameters

NameType
playerPlayer

Returns

any

Defined in

server/player/get.ts:24


food

Usage

Athena.player.get.food(player): number

Get the characters food value.

By default there is no food system in Athena, these values are placeholders.

Returns a readable array, but cannot be modified.

Export

Parameters

NameType
playerPlayer

Returns

number

Defined in

server/player/get.ts:92


groups

Usage

Athena.player.get.groups(player): Object

Return a list of groups, with their dedicated group permissions for this character.

Export

Parameters

NameType
playerPlayer

Returns

Object

Defined in

server/player/get.ts:120


inventory

Usage

Athena.player.get.inventory(player): Readonly<player[]>

Get the characters inventory.

Returns a readable array, but cannot be modified.

Export

Parameters

NameType
playerPlayer

Returns

Readonly<player[]>

Defined in

server/player/get.ts:62


isDead

Usage

Athena.player.get.isDead(player): boolean

Check if a character is dead.

Export

Parameters

NameType
playerPlayer

Returns

boolean

Defined in

server/player/get.ts:48


job

Usage

Athena.player.get.job(player): Athena.systems.job.builder

Return the current job instance.

Returns undefined if not on a job.

Export

Parameters

NameType
playerPlayer

Returns

Athena.systems.job.builder

Defined in

server/player/get.ts:158


name

Usage

Athena.player.get.name(player): any

Get a characters full character name.

Export

Parameters

NameType
playerPlayer

Returns

any

Defined in

server/player/get.ts:12


permissions

Usage

Athena.player.get.permissions(player): string[]

Return a list of character permissions.

Export

Parameters

NameType
playerPlayer

Returns

string[]

Defined in

server/player/get.ts:132


toolbar

Usage

Athena.player.get.toolbar(player): Readonly<player[]>

Get the characters toolbar.

Returns a readable array, but cannot be modified.

Export

Parameters

NameType
playerPlayer

Returns

Readonly<player[]>

Defined in

server/player/get.ts:76


water

Usage

Athena.player.get.water(player): number

Get the characters water value.

By default there is no water system in Athena, these values are placeholders.

Returns a readable array, but cannot be modified.

Export

Parameters

NameType
playerPlayer

Returns

number

Defined in

server/player/get.ts:108

Created by Stuyk | Est. 2020