V5 DocsAthenaClient.systems.playerConfig ​
Type Aliases ​
ConfigCallback ​
Ƭ ConfigCallback: (value: any) => void
Type declaration ​
Usage
AthenaClient.systems.playerConfig.(value): void
Parameters ​
| Name | Type |
|---|---|
value | any |
Returns ​
void
Defined in ​
client/systems/playerConfig.ts:6
Functions ​
addCallback ​
Usage
AthenaClient.systems.playerConfig.addCallback<CustomKeys>(key, callback): void
Add a custom callback to listen for config changes.
Type parameters ​
| Name |
|---|
CustomKeys |
Parameters ​
| Name | Type |
|---|---|
key | any |
callback | ConfigCallback |
Returns ​
void
Defined in ​
client/systems/playerConfig.ts:42
get ​
Usage
AthenaClient.systems.playerConfig.get(key): player | undefined
Get a value assigned by the server.
Parameters ​
| Name | Type |
|---|---|
key | "character-data" |
Returns ​
player | undefined
Defined in ​
client/systems/playerConfig.ts:22
Usage
AthenaClient.systems.playerConfig.get(key): player | undefined
Get a value assigned by the server.
Parameters ​
| Name | Type |
|---|---|
key | "account-data" |
Returns ​
player | undefined