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

    Class AsyncPlayerJoinBeforeEventBeta

    The data available before a player joins the world.

    Index

    Properties

    name persistentId splitScreenSlot?

    Methods

    allowJoin disallowJoin disconnect isValid

    Properties

    name: string

    The player's name

    persistentId: string

    An identifier that can be used to identify a player across sessions.

    splitScreenSlot?: PlayerSplitScreenSlot

    The split screen slot of the joining player or undefined if the player is not in a split screen session.

    Methods

    • Beta

      Returns void

      Call this to explicitly allow the player to join the server. This is useful when player joining is disabled (allow-player-joining is set to false when playing on dedicated server).

      This function can throw errors.

      DisconnectedError

    • Beta

      Parameters

      • Optionalreason: string

      Returns void

      Call this to disallow the player from joining the server. This is useful for preventing unauthorized access to the server.

      This function can throw errors.

      DisconnectedError

    • Beta

      Parameters

      • Optionalreason: string

      Returns void

      Deprecated - use disallowJoin instead.Call this to disconnect a player. They will be allowed to try to join again. They will be allowed to try to join again after being disconnected.

      This function can throw errors.

      DisconnectedError

    • Beta

      Returns boolean

      Will return true if the player is still waiting to join the world. If they disconnect then it will return false.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods