Class AllowList

enabled

add

• add(player: string | Player): void

  Parameters

  • player: string | Player

    Player or player name that should be added to the allow list.

  Returns void

  Remarks

  Adds a player to the server's allow list.

  Throws

  This function can throw errors.

  AllowListModificationError

  minecraftserver.InvalidEntityError

  World Ready

  This function can't be called in early-execution mode.

contains

• contains(player: string | Player): boolean

  Parameters

  • player: string | Player

    Player or player name that should be checked for.

  Returns boolean

  Remarks

  Returns if the player is in the server's allow list.

  Throws

  This function can throw errors.

  minecraftserver.InvalidEntityError

  World Ready

  This function can't be called in early-execution mode.

reloadFile

• reloadFile(): void

  Returns void

  Remarks

  Reloads the server's allow list from disk.

  Throws

  This function can throw errors.

  AllowListFileReloadError

  World Ready

  This function can't be called in early-execution mode.

remove

• remove(player: string | Player): void

  Parameters

  • player: string | Player

    Player or player name that should be removed from the allow list.

  Returns void

  Remarks

  Removes a player from the server's allow list.

  Throws

  This function can throw errors.

  AllowListModificationError

  minecraftserver.InvalidEntityError

  World Ready

  This function can't be called in early-execution mode.