Class Game

Properties

canTarget enemies engine gameid keyQueue options players readyData serverTargets fps

Accessors

forcePauseIGEs frame igesPaused opponents pauseIGEs target

Methods

createEngine destroy pipe stop

Properties

canTarget

canTarget: boolean = true

Whether or not targeting is allowed (changed by server). Setting target while this is false will throw an error.

enemies

enemies: number[] = []

The gameids of the users targeting the client

engine

engine: Engine

The client's engine

gameid

gameid: number

The client's gameid set by the server

keyQueue

keyQueue: Types.Game.Tick.Keypress[] = []

The keys the client has queued to press (allows for pressing keys in the future)

options

options: ReadyOptions

The raw game config sent by TETR.IO

players

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

Data on all players in game, including the client

readyData

readyData: Ready

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

serverTargets

serverTargets: number[] = []

The targets set by the server

Staticfps

fps: number = 60

The Frames Per Second of the TETR.IO engine

Accessors

forcePauseIGEs

  • get forcePauseIGEs(): boolean

  • Force stops the processing of all IGEs (garbage, etc). If left true for too long, the client will be kicked. Use sparingly.

    Returns boolean

  • set forcePauseIGEs(value): void

  • Parameters

    • value: boolean

    Returns void

frame

  • get frame(): number

  • The game's current frame

    Returns number

  • set frame(newFrame): void

  • Parameters

    • newFrame: number

    Returns void

igesPaused

  • get igesPaused(): boolean

  • Whether or not the Game is currently allowed to process IGEs.

    Returns boolean

opponents

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

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

    Deprecated

    • use players

pauseIGEs

  • get pauseIGEs(): boolean

  • Pauses accepting IGEs (garbage events) when the keyQueue has items, when pauseIGEs is set to true.

    Returns boolean

  • set pauseIGEs(value): void

  • Parameters

    • value: boolean

    Returns void

target

  • get target(): Types.Game.Target

  • The current targeting strategy. Setting a targeting strategy throws error if targeting is not allowed.

    Returns Types.Game.Target

  • set target(t): void

  • Parameters

    Returns void

Methods

createEngine

  • createEngine(options, gameid): Engine

  • Parameters

    Returns Engine

destroy

  • destroy(): undefined

  • 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

pipe

  • pipe(...frames): void

  • Send raw frames to TETR.IO - Not recommended for normal use.

    Parameters

    Returns void

stop

  • stop(): void

  • Stops the client's gameplay, when it dies. Does not destroy the game.

    Returns void

Settings

Member Visibility

On This Page

Properties
Accessors
Methods