Class Self

Constructors

constructor

Properties

botWrapper? canTarget enemies engine gameid keyQueue lastIGEFlush options serverTargets startTime tick? maxIGETimeout

Accessors

forcePauseIGEs igesPaused pauseIGEs target

Methods

destroy init

Constructors

constructor

  • new Self(client, players): Self

  • Parameters

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

    Returns Self

Properties

OptionalbotWrapper

botWrapper?: BotWrapper<CustomMessageData>

The BotWrapper in use. When a BotWrapper is set, tick will not be called.

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)

lastIGEFlush

lastIGEFlush: number = ...

The last time IGEs were flushed

options

options: ReadyOptions

The raw game config sent by TETR.IO

serverTargets

serverTargets: number[] = []

The targets set by the server

startTime

startTime: null | number = null

The performance.now() timestamp when the gameplay started

Optionaltick

tick?: Func

The tick function called every game tick

StaticmaxIGETimeout

maxIGETimeout: number = 30000

The maximum amount of time before all IGEs are force-flushed

Accessors

forcePauseIGEs

  • get forcePauseIGEs(): boolean

  • Force stops the processing of all IGEs (garbage, etc). If left true for too long (~30s), IGEs will be automatically flushed to avoid a forced disconnect. Use sparingly.

    Returns boolean

  • set forcePauseIGEs(value): void

  • Parameters

    • value: boolean

    Returns void

igesPaused

  • get igesPaused(): boolean

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

    Returns boolean

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

destroy

  • destroy(): void
  • Internal

    Stops the client's gameplay, when it dies. Does not destroy the game. You don't need to call this manually.

    Returns void

init

  • init(): void

  • Initialize the client's game. You don't need to call this manually.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods