Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoomEndGameIntentEvent<RoomType>

Emitted when a game end intent critera is fulfilled, and the game is planned to end.

Useful for canceling typical end game scenarios. See RoomGameEndEvent to listen for an actual game end, and see Hostable.registerEndGameIntent to register your own end game intent.

Type parameters

  • RoomType: Hostable

Hierarchy

Index

Properties

Static eventName

eventName: "room.endgameintent" = ...

canceled

canceled: boolean

eventName

eventName: "room.endgameintent" = ...

Readonly intentName

intentName: string

Readonly metadata

metadata: any

Readonly reason

reason: GameOverReason

Readonly room

room: RoomType

Methods

cancel

  • cancel(): void

Constructors

constructor

  • new RoomEndGameIntentEvent<RoomType>(room: RoomType, intentName: string, reason: GameOverReason, metadata: any): RoomEndGameIntentEvent<RoomType>

Generated using TypeDoc