V5 DocsAthena.player.sync ​
Functions ​
appearance ​
Usage
Athena.player.sync.appearance(player, document?): any
Apply an appearance on a player, or use a selected character document to update.
Export
Parameters ​
| Name | Type | Default value |
|---|---|---|
player | Player | undefined |
document? | Character | undefined |
Returns ​
any
Defined in ​
currencyData ​
Usage
Athena.player.sync.currencyData(player): void
Synchronize currency data like bank, cash, etc.
Parameters ​
| Name | Type |
|---|---|
player | Player |
Returns ​
void
Defined in ​
override ​
Usage
Athena.player.sync.override(functionName, callback): any
Used to override any sync functions
Parameters ​
| Name | Type |
|---|---|
functionName | "currencyData" |
callback | (player: Player) => void |
Returns ​
any
Defined in ​
Usage
Athena.player.sync.override(functionName, callback): any
Used to override any sync functions
Parameters ​
| Name | Type |
|---|---|
functionName | "appearance" |
callback | (player: Player, document?: Character) => any |
Returns ​
any
Defined in ​
Usage
Athena.player.sync.override(functionName, callback): any
Used to override any sync functions
Parameters ​
| Name | Type |
|---|---|
functionName | "syncedMeta" |
callback | (player: Player) => void |
Returns ​
any
Defined in ​
Usage
Athena.player.sync.override(functionName, callback): any
Used to override any sync functions
Parameters ​
| Name | Type |
|---|---|
functionName | "playTime" |
callback | (player: Player) => void |
Returns ​
any
Defined in ​
playTime ​
Usage
Athena.player.sync.playTime(player): void
Parameters ​
| Name | Type |
|---|---|
player | Player |
Returns ​
void
Defined in ​
syncedMeta ​
Usage
Athena.player.sync.syncedMeta(player): void
Updates synced meta for the current player. Basically updates data that may not be fully accessible everywhere.
Parameters ​
| Name | Type |
|---|---|
player | Player |
Returns ​
void