Skip to content
On this page

Athena.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

NameTypeDefault value
playerPlayerundefined
document?Characterundefined

Returns

any

Defined in

server/player/sync.ts:36


currencyData

Usage

Athena.player.sync.currencyData(player): void

Synchronize currency data like bank, cash, etc.

Parameters

NameType
playerPlayer

Returns

void

Defined in

server/player/sync.ts:14


override

Usage

Athena.player.sync.override(functionName, callback): any

Used to override any sync functions

Parameters

NameType
functionName"currencyData"
callback(player: Player) => void

Returns

any

Defined in

server/player/sync.ts:174

Usage

Athena.player.sync.override(functionName, callback): any

Used to override any sync functions

Parameters

NameType
functionName"appearance"
callback(player: Player, document?: Character) => any

Returns

any

Defined in

server/player/sync.ts:175

Usage

Athena.player.sync.override(functionName, callback): any

Used to override any sync functions

Parameters

NameType
functionName"syncedMeta"
callback(player: Player) => void

Returns

any

Defined in

server/player/sync.ts:176

Usage

Athena.player.sync.override(functionName, callback): any

Used to override any sync functions

Parameters

NameType
functionName"playTime"
callback(player: Player) => void

Returns

any

Defined in

server/player/sync.ts:177


playTime

Usage

Athena.player.sync.playTime(player): void

Parameters

NameType
playerPlayer

Returns

void

Defined in

server/player/sync.ts:154


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

NameType
playerPlayer

Returns

void

Defined in

server/player/sync.ts:145

Created by Stuyk | Est. 2020