Class BanManager

Ban manager.

Index

Constructors

Methods

isBanned setBanned setUnbanned

Lifecycle

Constructors

constructor

new BanManager(server: Server): BanManager
Parameters
- server: Server
Returns BanManager
- Defined in packages/prismarine/src/ban/BanManager.ts:22

Methods

isBanned

isBanned(player: Player): string | boolean
Check if player is banned.
Parameters
- player: Player
  Player to check.
Returns string | boolean
Reason if banned, false if not banned.
- Defined in packages/prismarine/src/ban/BanManager.ts:99

setBanned

setBanned(username: string, reason?: string): Promise<boolean>
Parameters
- username: string
- reason: string = ''
Returns Promise<boolean>
- Defined in packages/prismarine/src/ban/BanManager.ts:57

setUnbanned

setUnbanned(username: string): Promise<void>
Parameters
- username: string
Returns Promise<void>
- Defined in packages/prismarine/src/ban/BanManager.ts:77

Lifecycle

disable

disable(): Promise<void>
On disable hook.

Returns Promise<void>
- Defined in packages/prismarine/src/ban/BanManager.ts:38

enable

enable(): Promise<void>
On enable hook.

Returns Promise<void>
- Defined in packages/prismarine/src/ban/BanManager.ts:30