@minecraft/server-admin
    Preparing search index...

    Class AllowListBeta

    Controls the allow list for the server. Only available on dedicated server.

    Index

    Properties

    enabled: boolean

    This property can't be edited in restricted-execution mode.

    Methods

    • Beta

      Parameters

      • player: string | Player

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

      Returns void

      Adds a player to the server's allow list.

      This function can throw errors.

      AllowListModificationError

      minecraftserver.InvalidEntityError

    • Beta

      Parameters

      • player: string | Player

        Player or player name that should be checked for.

      Returns boolean

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

      This function can throw errors.

      minecraftserver.InvalidEntityError

    • Beta

      Returns void

      Reloads the server's allow list from disk.

      This function can throw errors.

      AllowListFileReloadError

    • Beta

      Parameters

      • player: string | Player

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

      Returns void

      Removes a player from the server's allow list.

      This function can throw errors.

      AllowListModificationError

      minecraftserver.InvalidEntityError