Class RoomGameEndedEvent<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
- RoomGameEndedEvent

Implements

RoomEvent<RoomType>

Index

Constructors

Properties

eventName eventName reason room

Constructors

constructor

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

Properties

`Static`eventName

eventName: "room.gameended" = ...

eventName

eventName: "room.gameended" = ...

`Readonly`reason

reason: number

The reason for why the game ended. See GameOverReason

`Readonly`room

The room or client that the event came from.