Class Game

players

rawPlayers

Optionalself

Staticfps

_strategy

• get _strategy(): SpectatingStrategy
• Internal

  Returns SpectatingStrategy
• set _strategy(strategy): void
• Internal

  Parameters

  • strategy: SpectatingStrategy

  Returns void

opponents

• get opponents(): Classes.Player[]

• Returns Classes.Player[]

destroy

• destroy(): undefined
• Internal

  Kill the game. This is called automatically by the Room class when a game ends/is aborted, you don't need to use this.

  Returns undefined

spectate

• spectate(gameid): Promise<PromiseSettledResult<void>[]>

• Spectate one or more players by their game ID or user ID, or spectate all players in the game. The order of PromiseSettledResults is guaranteed to match the order of the players property of the Game.

  Parameters

  • gameid: number[]

    An array of game IDs to spectate.

  Returns Promise<PromiseSettledResult<void>[]>

  Example

  // Spectate a player by game ID
  client.game!.spectate([12344]);
  Copy

• spectate(targets): Promise<PromiseSettledResult<void>[]>

• Spectate one or more players by their game ID or user ID, or spectate all players in the game. The order of PromiseSettledResults is guaranteed to match the order of the input array.

  Parameters

  • targets: "all"

    The string "all" to spectate all players.

  Returns Promise<PromiseSettledResult<void>[]>

  Example

  // Spectate all players in the game
  client.game!.spectate("all");
  Copy

• spectate(userid): Promise<PromiseSettledResult<void>[]>

• Spectate one or more players by their game ID or user ID, or spectate all players in the game. The order of PromiseSettledResults is guaranteed to match the order of the input array.

  Parameters

  • userid: String[]

    An array of user IDs to spectate.

  Returns Promise<PromiseSettledResult<void>[]>

  Example

  // Spectate a player by user ID
  client.game!.spectate(["646f633d276f42a80ba44304"]);
  Copy

unspectate

• unspectate(gameid): boolean[]

• Stop spectating one or more players by their game ID or user ID, or stop spectating all players in the game.

  Parameters

  • gameid: number[]

    An array of game IDs to stop spectating.

  Returns boolean[]

  An array representing whether or not each unspectate was successful

  Example

  // Stop spectating a player by game ID
  client.game!.unspectate([12344]);
  Copy

• unspectate(userid): boolean[]

• Stop spectating one or more players by their game ID or user ID, or stop spectating all players in the game.

  Parameters

  • userid: "all"

    The string "all" to stop spectating all players.

  Returns boolean[]

  An array representing whether or not each unspectate was successful

  Example

  // Stop spectating all players in the game
  client.game!.unspectate("all");
  Copy

• unspectate(userid): boolean[]

• Stop spectating one or more players by their game ID or user ID, or stop spectating all players in the game.

  Parameters

  • userid: String[]

    An array of user IDs to stop spectating.

  Returns boolean[]

  An array representing whether or not each unspectate was successful

  Example

  // Stop spectating a player by user ID
  client.game!.unspectate(["646f633d276f42a80ba44304"]);
  Copy

StaticcreateEngine

• createEngine(options, gameid, players): Engine
• Internal

  Parameters

  • options: ReadyOptions
  • gameid: number
  • players: {
        alive: boolean;
        gameid: number;
        naturalorder: number;
        options: ReadyOptions;
        userid: string;
    }[]

  Returns Engine

Staticlog

• log(msg, __namedParameters?): void
• Internal

  For internal use only.

  Parameters

  • msg: string
  • __namedParameters: {
        level: "error" | "info" | "warning";
    } = ...

    • level: "error" | "info" | "warning"

  Returns void

StaticsnapshotFromState

• snapshotFromState(frame, config, state, undoRedoState?): EngineSnapshot
• Internal

  Parameters

  • frame: number
  • config: EngineInitializeParams
  • state: Types.Game.State
  • undoRedoState: boolean = false

  Returns EngineSnapshot