Class PlayerReadyEvent<RoomType>

Emitted when a player readies up to start the game.

If a player fails to ready up within a specified time, they are kicked from the game.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

BasicEvent
- PlayerReadyEvent

Implements

PlayerEvent<RoomType>

Index

Constructors

Properties

eventName player room eventName

Constructors

constructor

new PlayerReadyEvent<RoomType extends StatefulRoom<any>>(
room: RoomType,
player: Player<RoomType>,
): PlayerReadyEvent<RoomType>
Type Parameters
- RoomType extends StatefulRoom<any>
Parameters
- room: RoomType
- player: Player<RoomType>
Returns PlayerReadyEvent<RoomType>
Overrides BasicEvent.constructor
- Defined in packages/core/lib/events/player/Ready.ts:17

Properties

eventName

eventName: "player.ready" = ...

`Readonly`player

player: Player<RoomType>

The player that this event is for.

`Readonly`room

The room or client that the event came from.

`Static`eventName

eventName: "player.ready" = ...