Class RoomGameStartEvent<RoomType>

Emitted when a game is started.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

BasicEvent
- RoomGameStartEvent

Implements

RoomEvent<RoomType>

Index

Constructors

Properties

eventName room eventName

Constructors

constructor

new RoomGameStartEvent<RoomType extends StatefulRoom<any>>(
room: RoomType,
): RoomGameStartEvent<RoomType>
Type Parameters
- RoomType extends StatefulRoom<any>
Parameters
- room: RoomType
Returns RoomGameStartEvent<RoomType>
Overrides BasicEvent.constructor
- Defined in packages/core/lib/events/room/GameStart.ts:12

Properties

eventName

eventName: "room.gamestart" = ...

`Readonly`room

The room or client that the event came from.

`Static`eventName

eventName: "room.gamestart" = ...