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 registerEndGameIntent to register your own end game intent.

Type Parameters

Hierarchy

  • CancelableEvent
    • RoomEndGameIntentEvent

Properties

eventName: "room.endgameintent"
canceled: boolean
eventName: "room.endgameintent"
intentName: string
metadata: any
room: RoomType

Methods

  • Returns void

Constructors

  • Type Parameters

    • RoomType extends Hostable<any, RoomType>

    Parameters

    • room: RoomType
    • intentName: string
    • reason: GameOverReason
    • metadata: any

    Returns RoomEndGameIntentEvent<RoomType>

Generated using TypeDoc