Class PlayerSceneChangeEvent<RoomType>

Emitted when a player changes their scene, i.e. when they first join and before they spawn into the game.

A player does not necessarily have to change their scene, and they will simply not spawn while recieving all game packets and events.

Type Parameters

Hierarchy

  • CancelableEvent
    • PlayerSceneChangeEvent

Implements

Properties

eventName: string
eventNamee: "player.scenechange"
canceled: boolean
eventName: "player.scenechange"

The message that this event originated from.

player: PlayerData<RoomType>

The player that this event is for.

room: RoomType

The room or client that the event came from.

Methods

  • Returns void

Constructors

Generated using TypeDoc