Class ban

constructor

• new ban(
      ban:
          | Globals.modules.bans.ban
          | {
              ban_format_version?: string;
              banDate: number;
              banId?: string;
              bannedById: string;
              bannedByName: string;
              format_version?: string;
              hasAdvancedReason?: boolean;
              originalPlayerId?: string;
              originalPlayerName?: string;
              playerId?: string;
              playerName?: string;
              reason?: string;
              removeAfterBanExpires?: boolean;
              type: "id"
              | "name";
              unbanDate: number;
          },
  ): Globals.modules.bans.ban

  Parameters

  • ban:
        | Globals.modules.bans.ban
        | {
            ban_format_version?: string;
            banDate: number;
            banId?: string;
            bannedById: string;
            bannedByName: string;
            format_version?: string;
            hasAdvancedReason?: boolean;
            originalPlayerId?: string;
            originalPlayerName?: string;
            playerId?: string;
            playerName?: string;
            reason?: string;
            removeAfterBanExpires?: boolean;
            type: "id"
            | "name";
            unbanDate: number;
        }

  Returns Globals.modules.bans.ban

ban_format_version

banDate

banId

bannedById

bannedByName

format_version

hasAdvancedReason

OptionaloriginalPlayerId

OptionaloriginalPlayerName

OptionalplayerId

OptionalplayerName

Optionalreason

removeAfterBanExpires

type

unbanDate

duration

• get duration(): {
      days: number;
      hours: number;
      milliseconds: number;
      minutes: number;
      seconds: number;
  }

  Returns {
      days: number;
      hours: number;
      milliseconds: number;
      minutes: number;
      seconds: number;
  }

durationString

• get durationString(): string

  Returns string

isExpired

• get isExpired(): boolean

  Returns boolean

isPermanent

• get isPermanent(): boolean

  Returns boolean

isTemporary

• get isTemporary(): boolean

  Returns boolean

isValid

• get isValid(): boolean

  Returns boolean

kickMessage

• get kickMessage(): undefined | string

  Returns undefined | string

timeRemaining

• get timeRemaining(): {
      days: number;
      hours: number;
      milliseconds: number;
      minutes: number;
      seconds: number;
  }

  Returns {
      days: number;
      hours: number;
      milliseconds: number;
      minutes: number;
      seconds: number;
  }

timeRemainingRaw

• get timeRemainingRaw(): number

  Returns number

timeRemainingString

• get timeRemainingString(): string

  Returns string

remove

• remove(): void

  Returns void

save

• save(): void

  Returns void

StaticexecuteOnBannedPlayers

• executeOnBannedPlayers(
      callbackfn: (player: Player, index: number, array: any[]) => unknown,
  ): any[]

  Parameters

  • callbackfn: (player: Player, index: number, array: any[]) => unknown

  Returns any[]

StaticgetBan

• getBan(banId: string): undefined | Globals.modules.bans.ban

  Parameters

  • banId: string

  Returns undefined | Globals.modules.bans.ban

StaticgetBanIds

• getBanIds(banType?: string): string[]

  Parameters

  • banType: string = "both"

  Returns string[]

StaticgetBans

• getBans(): {
      allBans: Globals.modules.bans.ban[];
      idBans: Globals.modules.bans.ban[];
      nameBans: Globals.modules.bans.ban[];
  }

  Returns {
      allBans: Globals.modules.bans.ban[];
      idBans: Globals.modules.bans.ban[];
      nameBans: Globals.modules.bans.ban[];
  }

StaticgetBansAutoRefresh

• getBansAutoRefresh(): {
      allBans: Globals.modules.bans.ban[];
      idBans: Globals.modules.bans.ban[];
      nameBans: Globals.modules.bans.ban[];
  }

  Returns {
      allBans: Globals.modules.bans.ban[];
      idBans: Globals.modules.bans.ban[];
      nameBans: Globals.modules.bans.ban[];
  }

StaticgetBansNoRefresh

• getBansNoRefresh(): {
      allBans: Globals.modules.bans.ban[];
      idBans: Globals.modules.bans.ban[];
      nameBans: Globals.modules.bans.ban[];
  }

  Returns {
      allBans: Globals.modules.bans.ban[];
      idBans: Globals.modules.bans.ban[];
      nameBans: Globals.modules.bans.ban[];
  }

StaticgetExpiredBanIds

• getExpiredBanIds(banType?: string): string[]

  Parameters

  • banType: string = "both"

  Returns string[]

StaticgetExpiredBans

• getExpiredBans(): {
      allBans: Globals.modules.bans.ban[];
      idBans: Globals.modules.bans.ban[];
      nameBans: Globals.modules.bans.ban[];
  }

  Returns {
      allBans: Globals.modules.bans.ban[];
      idBans: Globals.modules.bans.ban[];
      nameBans: Globals.modules.bans.ban[];
  }

StaticgetExpiredBansAutoRefresh

• getExpiredBansAutoRefresh(): {
      allBans: Globals.modules.bans.ban[];
      idBans: Globals.modules.bans.ban[];
      nameBans: Globals.modules.bans.ban[];
  }

  Returns {
      allBans: Globals.modules.bans.ban[];
      idBans: Globals.modules.bans.ban[];
      nameBans: Globals.modules.bans.ban[];
  }

StaticgetExpiredBansNoRefresh

• getExpiredBansNoRefresh(): {
      allBans: Globals.modules.bans.ban[];
      idBans: Globals.modules.bans.ban[];
      nameBans: Globals.modules.bans.ban[];
  }

  Returns {
      allBans: Globals.modules.bans.ban[];
      idBans: Globals.modules.bans.ban[];
      nameBans: Globals.modules.bans.ban[];
  }

StaticgetValidBanIds

• getValidBanIds(banType?: string): string[]

  Parameters

  • banType: string = "both"

  Returns string[]

StaticgetValidBans

• getValidBans(): {
      allBans: Globals.modules.bans.ban[];
      idBans: Globals.modules.bans.ban[];
      nameBans: Globals.modules.bans.ban[];
  }

  Returns {
      allBans: Globals.modules.bans.ban[];
      idBans: Globals.modules.bans.ban[];
      nameBans: Globals.modules.bans.ban[];
  }

StaticgetValidBansAutoRefresh

• getValidBansAutoRefresh(): {
      allBans: Globals.modules.bans.ban[];
      idBans: Globals.modules.bans.ban[];
      nameBans: Globals.modules.bans.ban[];
  }

  Returns {
      allBans: Globals.modules.bans.ban[];
      idBans: Globals.modules.bans.ban[];
      nameBans: Globals.modules.bans.ban[];
  }

StaticgetValidBansNoRefresh

• getValidBansNoRefresh(): {
      allBans: Globals.modules.bans.ban[];
      idBans: Globals.modules.bans.ban[];
      nameBans: Globals.modules.bans.ban[];
  }

  Returns {
      allBans: Globals.modules.bans.ban[];
      idBans: Globals.modules.bans.ban[];
      nameBans: Globals.modules.bans.ban[];
  }

StaticrefreshBans

• refreshBans(): void

  Returns void

StaticsaveBan

• saveBan(
      ban:
          | Globals.modules.bans.ban
          | {
              ban_format_version?: string
              | number;
              banDate: number | Date;
              banId?: string;
              bannedById: string | number;
              bannedByName: string;
              format_version?: string | number;
              originalPlayerId?: string | number;
              originalPlayerName?: string;
              playerId?: string | number;
              playerName?: string;
              reason: string;
              removeAfterBanExpires?: boolean;
              type: "id" | "name";
              unbanDate: number | Date;
          },
  ): void

  Parameters

  • ban:
        | Globals.modules.bans.ban
        | {
            ban_format_version?: string
            | number;
            banDate: number | Date;
            banId?: string;
            bannedById: string | number;
            bannedByName: string;
            format_version?: string | number;
            originalPlayerId?: string | number;
            originalPlayerName?: string;
            playerId?: string | number;
            playerName?: string;
            reason: string;
            removeAfterBanExpires?: boolean;
            type: "id" | "name";
            unbanDate: number | Date;
        }

  Returns void

StatictestForBannedPlayer

• testForBannedPlayer(
      player:
          | Globals.modules.playersave.savedPlayer
          | Player
          | savedPlayerData,
  ): boolean

  Parameters

  • player: Globals.modules.playersave.savedPlayer | Player | savedPlayerData

  Returns boolean

StatictestForIdBannedPlayer

• testForIdBannedPlayer(
      player:
          | Globals.modules.playersave.savedPlayer
          | Player
          | savedPlayerData,
  ): boolean

  Parameters

  • player: Globals.modules.playersave.savedPlayer | Player | savedPlayerData

  Returns boolean

StatictestForNameBannedPlayer

• testForNameBannedPlayer(
      player:
          | Globals.modules.playersave.savedPlayer
          | Player
          | savedPlayerData,
  ): boolean

  Parameters

  • player: Globals.modules.playersave.savedPlayer | Player | savedPlayerData

  Returns boolean