Script API - v26.50.25
    Preparing search index...

    Class AllowList

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

    export class AllowList {
        private constructor();
        enabled: boolean;
        readonly entries: AllowListEntry[];
        add(playerDetails: AllowListEntryNameInfo | minecraftserver.Player, ignorePlayerLimit?: boolean): void;
        clear(): void;
        contains(playerDetails: AllowListEntryNameInfo | minecraftserver.Player): boolean;
        reloadFile(): void;
        remove(playerDetails: AllowListEntryNameInfo | minecraftserver.Player): void;
    }
    Index

    Constructors

    constructor

    Properties

    enabled entries

    Methods

    add clear contains reloadFile remove

    Constructors

    Properties

    enabled: boolean

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

    This property can't be read in early-execution mode.

    entries: AllowListEntry[]

    The list of entries in the allow list.

    This property can't be read in early-execution mode.

    Methods

    • Returns void

      Clears the allow list, removing all entries.

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

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

    • Returns void

      Reloads the server's allow list from disk.

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

      This function can throw errors.

      AllowListFileReloadError

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods