Skip to main content
Version: v2.9.2

Player Events

These events are emitted when a Player emits its related events.

PlayerCreate

Emitted when a player is created.

Property Type Description Optional
playerPlayerPlayer this event applies to.

PlayerDestroy

Emitted when a player is destroyed.

Property Type Description Optional
playerPlayerPlayer this event applies to.

PlayerDisconnect

Emitted when a player disconnects from the bound channel.

Property Type Description Optional
playerPlayerPlayer this event applies to.
oldChannelstringOld channel this event applies to.

PlayerMove

Emitted when a player moves to a different channel.

Property Type Description Optional
playerPlayerPlayer this event applies to.
oldChannelstringOld channel this event applies to.
newChannelstringNew channel this event applies to.

PlayerRestored

Emitted when a player is restored from a previous session.

Property Type Description Optional
playerPlayerPlayer this event applies to.
nodeNodeNode this event applies to.

PlayerStateUpdate

Emitted when a player's state is updated.

Property Type Description Optional
oldPlayerPlayerThe old player state.
newPlayerPlayerThe new player state.
changeTypePlayerStateUpdateEventThe type of change that occurred.