V5 DocsAthena.player.get ​
Modules ​
Functions ​
accountPermissions ​
Usage
Athena.player.get.accountPermissions(player): string[]
Return a list of account permissions.
Export
Parameters ​
| Name | Type |
|---|---|
player | Player |
Returns ​
string[]
Defined in ​
bank ​
Usage
Athena.player.get.bank(player): any
Get a characters current bank balance.
Export
Parameters ​
| Name | Type |
|---|---|
player | Player |
Returns ​
any
Defined in ​
cash ​
Usage
Athena.player.get.cash(player): any
Get a characters current cash balance.
Export
Parameters ​
| Name | Type |
|---|---|
player | Player |
Returns ​
any
Defined in ​
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 ​
| Name | Type |
|---|---|
player | Player |
Returns ​
number
Defined in ​
groups ​
Usage
Athena.player.get.groups(player): Object
Return a list of groups, with their dedicated group permissions for this character.
Export
Parameters ​
| Name | Type |
|---|---|
player | Player |
Returns ​
Object
Defined in ​
inventory ​
Get the characters inventory.
Returns a readable array, but cannot be modified.
Export
Parameters ​
| Name | Type |
|---|---|
player | Player |
Returns ​
Defined in ​
isDead ​
Usage
Athena.player.get.isDead(player): boolean
Check if a character is dead.
Export
Parameters ​
| Name | Type |
|---|---|
player | Player |
Returns ​
boolean
Defined in ​
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 ​
| Name | Type |
|---|---|
player | Player |
Returns ​
Athena.systems.job.builder
Defined in ​
name ​
Usage
Athena.player.get.name(player): any
Get a characters full character name.
Export
Parameters ​
| Name | Type |
|---|---|
player | Player |
Returns ​
any
Defined in ​
permissions ​
Usage
Athena.player.get.permissions(player): string[]
Return a list of character permissions.
Export
Parameters ​
| Name | Type |
|---|---|
player | Player |
Returns ​
string[]
Defined in ​
toolbar ​
Get the characters toolbar.
Returns a readable array, but cannot be modified.
Export
Parameters ​
| Name | Type |
|---|---|
player | Player |
Returns ​
Defined in ​
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 ​
| Name | Type |
|---|---|
player | Player |
Returns ​
number