Skip to content
On this page

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

NameTypeDescription
playerPlayerAn alt:V Player Entity
reasonstring

Returns

Promise<boolean>

Defined in

server/controllers/admin.ts:21


override

Usage

Athena.controllers.admin.override(functionName, callback): any

Parameters

NameType
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

NameType
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

NameType
discordstring

Returns

Promise<boolean>

Defined in

server/controllers/admin.ts:52

Created by Stuyk | Est. 2020