Class AllowListBeta

Betaenabled

Readonly Betaentries

add

• add(
      playerDetails: Player | AllowListEntryNameInfo,
      ignorePlayerLimit?: boolean,
  ): void
  Beta

  Parameters

  • playerDetails: Player | AllowListEntryNameInfo

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

  • OptionalignorePlayerLimit: boolean

    If true, the player will be allowed onto the server even if the server is at its player limit. Defaults to: false

  Returns void

  Remarks

  Adds a player to the server's allow list.

  Privilege

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

  Throws

  This function can throw errors.

  AllowListModificationError

  minecraftcommon.InvalidArgumentError

  minecraftserver.InvalidEntityError

clear

• clear(): void
  Beta

  Returns void

  Remarks

  Clears the allow list, removing all entries.

  Privilege

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

contains

• contains(playerDetails: Player | AllowListEntryNameInfo): boolean
  Beta

  Parameters

  • playerDetails: Player | AllowListEntryNameInfo

    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.

  minecraftcommon.InvalidArgumentError

  minecraftserver.InvalidEntityError

reloadFile

• reloadFile(): void
  Beta

  Returns void

  Remarks

  Reloads the server's allow list from disk.

  Privilege

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

  Throws

  This function can throw errors.

  AllowListFileReloadError

remove

• remove(playerDetails: Player | AllowListEntryNameInfo): void
  Beta

  Parameters

  • playerDetails: Player | AllowListEntryNameInfo

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

  Returns void

  Remarks

  Removes a player from the server's allow list.

  Privilege

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

  Throws

  This function can throw errors.

  AllowListModificationError

  minecraftcommon.InvalidArgumentError

  minecraftserver.InvalidEntityError