Class RoomGameEndEvent<RoomType>

Emitted when a game ends.

See RoomEndGameIntentEvent to cancel or listen for before a game is ended.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

BasicEvent
- RoomGameEndEvent

Implements

RoomEvent<RoomType>

Index

Constructors

Properties

eventName reason room eventName

Constructors

constructor

new RoomGameEndEvent<RoomType extends StatefulRoom<any>>(
room: RoomType,
reason: number,
): RoomGameEndEvent<RoomType>
Type Parameters
- RoomType extends StatefulRoom<any>
Parameters
- room: RoomType
- reason: number
  The reason for why the game ended. See GameOverReason
Returns RoomGameEndEvent<RoomType>
Overrides BasicEvent.constructor
- Defined in packages/core/lib/events/room/GameEnd.ts:15

Properties

eventName

eventName: "room.gameend" = ...

`Readonly`reason

reason: number

The reason for why the game ended. See GameOverReason

`Readonly`room

The room or client that the event came from.

`Static`eventName

eventName: "room.gameend" = ...