Class BanPlayerDispatch

(eggforcer only) Bans a player from the game

Index

Constructors

Constructors

constructor

new BanPlayerDispatch(
    uniqueId: string,
    duration: BanDuration,
    reason?: string,
): BanPlayerDispatch
Creates a BanPlayerDispatch
Parameters
- uniqueId: string
  The unique ID of the player to ban
- duration: BanDuration
  The duration of the ban
- reason: string = ''
  The reason for the ban (optional)
Returns BanPlayerDispatch