JSPrismarine

API reference / @jsprismarine/prismarine / BanManager

Class: BanManager ​

Defined in: prismarine/src/ban/BanManager.ts:35

Ban manager.

Constructors ​

Constructor ​

new BanManager(server): BanManager

Defined in: prismarine/src/ban/BanManager.ts:39

Parameters ​

server ​

BanManagerServer

Returns ​

BanManager

Methods ​

isBanned() ​

isBanned(player): string | boolean

Defined in: prismarine/src/ban/BanManager.ts:113

Check if player is banned.

Parameters ​

player ​

BanSubject

Player to check.

Returns ​

string | boolean

Reason if banned, false if not banned.

setBanned() ​

setBanned(username, reason?): Promise<boolean>

Defined in: prismarine/src/ban/BanManager.ts:93

Parameters ​

username ​

string

reason? ​

string = ''

Returns ​

Promise<boolean>

setUnbanned() ​

setUnbanned(username): Promise<void>

Defined in: prismarine/src/ban/BanManager.ts:102

Parameters ​

username ​

string

Returns ​

Promise<void>

Lifecycle ​

disable() ​

disable(): Promise<void>

Defined in: prismarine/src/ban/BanManager.ts:55

On disable hook.

Returns ​

Promise<void>

enable() ​

enable(): Promise<void>

Defined in: prismarine/src/ban/BanManager.ts:47

On enable hook.

Returns ​

Promise<void>