V5 DocsAthena.controllers.admin ​
Functions ​
banPlayer ​
Usage
Athena.controllers.admin.banPlayer(player, reason): Promise<boolean>
Used to ban a player from the server.
Example ​
ts
Athena.controllers.admin.banPlayer(player, 'was a bad person :(')Parameters ​
| Name | Type | Description |
|---|---|---|
player | Player | An alt:V Player Entity |
reason | string |
Returns ​
Promise<boolean>
Defined in ​
server/controllers/admin.ts:21
override ​
Usage
Athena.controllers.admin.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "banPlayer" |
callback | (player: Player, reason: string) => Promise<boolean> |
Returns ​
any
Defined in ​
server/controllers/admin.ts:78
Usage
Athena.controllers.admin.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "unbanPlayerByDiscord" |
callback | (discord: string) => Promise<boolean> |
Returns ​
any
Defined in ​
server/controllers/admin.ts:79
unbanPlayerByDiscord ​
Usage
Athena.controllers.admin.unbanPlayerByDiscord(discord): Promise<boolean>
Used to unban a player from the server.
Example ​
ts
Athena.controllers.admin.unbanPlayerByDiscord('202685967935471617');Parameters ​
| Name | Type |
|---|---|
discord | string |
Returns ​
Promise<boolean>