Class AsyncPlayerJoinBeforeEvent

The data available before a player joins the world.

Constructors

constructor

Properties

name persistentId

Methods

disconnect isValid

Constructors

Privateconstructor

Properties

Readonlyname

name: string

Remarks

The player's name

ReadonlypersistentId

persistentId: string

Remarks

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

Note: persistentId refers to PlayFab ID in this context.

A PlayFab ID is a unique identifier assigned to each player in the PlayFab ecosystem. PlayFab is a backend platform for game developers, offering services like player authentication, data storage, leaderboards, and more. The PlayFab ID helps track and manage individual player data across games and platforms.

It is used in Minecraft to resolve scoreboard identity and identity of the player in the world.

Methods

disconnect

  • disconnect(reason?: string): void

    Parameters

    • Optionalreason: string

    Returns void

    Remarks

    Call this to disconnect a player. They will be allowed to try to join again.

    Throws

    This function can throw errors.

    DisconnectedError

isValid

  • isValid(): boolean

    Returns boolean

    Remarks

    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

Constructors
Properties
Methods