Interface IGame

Base interface for a custom game. You'll want to extend instead.

Hierarchy

  • IGame

Implemented by

Accessors

Methods

Accessors

  • get replayData(): IReplayData
  • Describes all of the actions taken so far, so that the game can be resumed later.

    Returns IReplayData

Methods

  • Called by a host when a player responds to a prompt.

    Parameters

    • playerIndex: number
    • promptIndex: number
    • Optional payload: any

    Returns void

  • Called exactly once by a host to run a game.

    Parameters

    • config: IRunConfig

      Configuration containing info like player count and names

    Returns Promise<IGameResult>

Generated using TypeDoc