Class AsyncPlayerJoinBeforeEvent

Index

Constructors

Properties

name persistentId

Methods

allowJoin disallowJoin disconnect isValid

Constructors

`Private`constructor

new AsyncPlayerJoinBeforeEvent(): AsyncPlayerJoinBeforeEvent
Returns AsyncPlayerJoinBeforeEvent

Properties

`Readonly`name

name: string

`Readonly`persistentId

persistentId: string

Methods

allowJoin

allowJoin(): void
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

DisconnectedError

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

disallowJoin

disallowJoin(reason?: string): void
Parameters
- Optionalreason: string
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

DisconnectedError

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

disconnect

disconnect(reason?: string): void
Parameters
- Optionalreason: string
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

DisconnectedError

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

isValid

isValid(): boolean
Returns boolean
Remarks
Write Privilege
This function can't be called in read-only mode.

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