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

    Module @minecraft/server-admin - v1.0.0-betaBeta

    Contains types related to administering a Bedrock Dedicated Server. These types allow for the configuration of variables and secrets in JSON files in the Bedrock Dedicated Server folder. These types cannot be used on Minecraft clients or within Minecraft Realms.

    Manifest Details

    {
      "module_name": "@minecraft/server-admin",
      "version": "1.0.0-beta"
    }

    @minecraft/common (Optional in Manifest Details)

    • Requires v1.0.0 or above
    {
      "module_name": "@minecraft/common",
      "version": "1.0.0"
    }

    @minecraft/server (Required one of the following in Manifest Details)

    • Requires v1.17.0 up to, but not including, v2.0.0
    {
      "module_name": "@minecraft/server",
      "version": "1.17.0"
    }
    • Requires v2.0.0 up to, but not including, v3.0.0
    {
      "module_name": "@minecraft/server",
      "version": "2.0.0"
    }

    Install type definition for @minecraft/server-admin module using npm:

    npm i @minecraft/server-admin@1.0.0-beta.1.21.90-preview.25

    Classes

    AdminBeforeEvents
    AsyncPlayerJoinBeforeEvent

    The data available before a player joins the world.

    AsyncPlayerJoinBeforeEventSignal
    DisconnectedError

    An error that is thrown when trying to interact with a join event and the player is disconnected.

    SecretString

    This represents a placeholder object that represents a secret string. The contents of that string are not available to script; this object is just a placeholder.

    ServerSecrets

    A collection of server secrets defined in dedicated server configuration.

    ServerVariables

    A collection of server variables defined in dedicated server configuration.

    Variables

    beforeEvents
    secrets
    variables

    Functions

    transferPlayer

    Settings

    Member Visibility

    On This Page

    DependenciesInstallation
    Classes
    Variables
    Functions