getBanStatus

Gets the player's ban status.

Syntax

player.getBanStatus();

Returns

• Promise<PlayerBanStatus> - The PlayerBanStatus object.

Example

const banStatus = await player.getBanStatus();

if (banStatus.banned) {
  console.log(
    `Player is banned for reason: ${banStatus.reason} and will be unbanned at ${banStatus.expiration}`,
  );
} else {
  console.log('Player is not banned');
}

Available on: Client Server