Class Game

Properties

players rawPlayers self? fps

Accessors

opponents

Methods

destroy spectate unspectate createEngine log snapshotFromState

Properties

players

players: {
    engine: Engine;
    gameid: number;
    name: string;
    queue: Frame[];
    spectating: boolean;
    userid: string;
}[] = []

Data on all players in game, including the client. Note that the client's engine data is only the data acknowledged by the server, not the most recent gameplay information.

Type declaration

  • engine: Engine
  • gameid: number
  • name: string
  • queue: Frame[]

    Queue of unprocessed replay frames for this player. Do not modify.

  • spectating: boolean

    Whether the player is currently receiving replay frames (actively spectated)

  • userid: string

rawPlayers

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

The raw game config for all players, (possibly) including the client's own game config

Optionalself

self?: Self

The client's own game handler

Staticfps

fps: number = 60

The Frames Per Second of the TETR.IO engine

Accessors

opponents

  • get opponents(): {
        engine: Engine;
        gameid: number;
        name: string;
        queue: Frame[];
        spectating: boolean;
        userid: string;
    }[]

  • Returns {
        engine: Engine;
        gameid: number;
        name: string;
        queue: Frame[];
        spectating: boolean;
        userid: string;
    }[]

Methods

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): void

  • Spectate one or more players by their game ID or user ID, or spectate all players in the game.

    Parameters

    • gameid: number[]

      An array of game IDs to spectate.

    Returns void

    Example

    // Spectate a player by game ID
    client.game!.spectate([12344]);
  • spectate(targets): void

  • Spectate one or more players by their game ID or user ID, or spectate all players in the game.

    Parameters

    • targets: "all"

      The string "all" to spectate all players.

    Returns void

    Example

    // Spectate all players in the game
    client.game!.spectate("all");
  • spectate(userid): void

  • Spectate one or more players by their game ID or user ID, or spectate all players in the game.

    Parameters

    • userid: String[]

      An array of user IDs to spectate.

    Returns void

    Example

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

unspectate

  • unspectate(gameid): void

  • 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 void

    Example

    // Stop spectating a player by game ID
    client.game!.unspectate([12344]);
  • unspectate(userid): void

  • 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 void

    Example

    // Stop spectating all players in the game
    client.game!.unspectate("all");
  • unspectate(userid): void

  • 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 void

    Example

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

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

Settings

Member Visibility

On This Page

Properties
Accessors
Methods