Class AsyncPlayerJoinBeforeEvent

The data available before a player joins the world.

Index

Constructors

Properties

name persistentId

Methods

disconnect isValid

Constructors

`Private`constructor

new AsyncPlayerJoinBeforeEvent(): AsyncPlayerJoinBeforeEvent
Returns AsyncPlayerJoinBeforeEvent

Properties

`Readonly`name

name: string

Remarks

The player's name

`Readonly`persistentId

persistentId: string

Remarks

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

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.