Script API - v1.26.40.20
    Preparing search index...

    Class DedicatedServerUtils

    Contains apis that are only available when in Bedrock Dedicated Server.

    export class DedicatedServerUtils {
        private constructor();
        readonly allowList: AllowList;
        readonly levelStorage: LevelStorage;
        reloadCDNConfig(): void;
        reloadPermissions(): void;
        reloadScriptingConfig(): void;
        stopServer(): void;
    }
    Index

    Constructors

    constructor

    Properties

    allowList levelStorage

    Methods

    reloadCDNConfig reloadPermissions reloadScriptingConfig stopServer

    Constructors

    Properties

    allowList: AllowList

    Returns an object that manages the server's allow list.

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

    levelStorage: LevelStorage

    Returns an object that manages the level's storage.

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

    Methods

    • Returns void

      Reloads the cdn configuration from disk.

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

      This function can throw errors.

      minecraftcommon.EngineError

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

    • Returns void

      Reloads the permissions for the server from disk.

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

      This function can throw errors.

      minecraftcommon.EngineError

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

    • Returns void

      Reloads the script configuration for the server from disk.

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

      This function can throw errors.

      minecraftcommon.EngineError

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

    • Returns void

      Shuts down the dedicated server.

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

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods