V5 DocsAthena.systems.account ​
Functions ​
create ​
Usage
Athena.systems.account.create(player, dataToAppend): Promise<Account>
Create an account with default data.
Parameters ​
| Name | Type | Description |
|---|---|---|
player | Player | An alt:V Player Entity |
dataToAppend | Object | Any additional data / identifiers to add to an account. |
Returns ​
Promise<Account>
Defined in ​
getAccount ​
Usage
Athena.systems.account.getAccount(key, value): Promise<Account | undefined>
Fetch account for a player based on key / value pair.
Parameters ​
| Name | Type |
|---|---|
key | string |
value | any |
Returns ​
Promise<Account | undefined>
Defined in ​
override ​
Usage
Athena.systems.account.override(functionName, callback): any
Used to override any account system functionality
Parameters ​
| Name | Type |
|---|---|
functionName | "create" |
callback | (player: Player, dataToAppend: { [key: string]: any; }) => Promise<Account> |
Returns ​
any
Defined in ​
Usage
Athena.systems.account.override(functionName, callback): any
Used to override any account system functionality
Parameters ​
| Name | Type |
|---|---|
functionName | "getAccount" |
callback | (key: string, value: any) => Promise<Account | undefined> |
Returns ​
any