Class AllowList

World mutationenabled

add

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

  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.

  Throws

  This function can throw errors.

  AllowListModificationError

  InvalidArgumentError

  InvalidEntityError

clear

• clear(): void
  World mutation

  Returns void

  Remarks

  Clears the allow list, removing all entries.

reloadFile

• reloadFile(): void
  World mutation

  Returns void

  Remarks

  Reloads the server's allow list from disk.

  Throws

  This function can throw errors.

  AllowListFileReloadError

remove

• remove(playerDetails: Player | AllowListEntryNameInfo): void
  World mutation

  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.

  Throws

  This function can throw errors.

  AllowListModificationError

  InvalidArgumentError

  InvalidEntityError