Class RoomGameStartedEvent<RoomType>

Emitted when a game is started.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

BasicEvent
- RoomGameStartedEvent

Implements

RoomEvent<RoomType>

Index

Constructors

Properties

eventName eventName room

Constructors

constructor

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

Properties

`Static`eventName

eventName: "room.gamestarted" = ...

eventName

eventName: "room.gamestarted" = ...

`Readonly`room

The room or client that the event came from.