Class Engine

Constructors

constructor

new Engine(options): Engine
Parameters
- options: EngineInitializeParams
Returns Engine
- Defined in src/engine/index.ts:193

Properties

b2b

b2b: B2BOptions

board

board: Board

connectedBoard

connectedBoard: ConnectedBoard

dynamic

dynamic: {
    garbageCap: IncreaseTracker;
    garbageMultiplier: IncreaseTracker;
    gravity: IncreaseTracker;
}

events

events: EventEmitter<Engine.Events> = ...

falling

falling: Tetromino

frame

frame: number

gameOptions

gameOptions: GameOptions

garbageQueue

garbageQueue: LegacyGarbageQueue | GarbageQueue

glock

glock: number

handling

handling: Handling

held

held: null | Engine.Mino

holdLocked

holdLocked: boolean

igeHandler

igeHandler: IGEHandler

initializer

initializer: EngineInitializeParams

input

input: {
    firstInputTime: number;
    keys: {
        hold: boolean;
        rotate180: boolean;
        rotateCCW: boolean;
        rotateCW: boolean;
        softDrop: boolean;
    };
    lastPieceTime: number;
    lastShift: number;
    lShift: {
        arr: number;
        das: number;
        dir: -1;
        held: boolean;
    };
    rShift: {
        arr: number;
        das: number;
        dir: 1;
        held: boolean;
    };
    time: {
        frameoffset: number;
        locked: boolean;
        prev: number;
        start: number;
        zero: boolean;
    };
}

lastSpin

lastSpin: null | SpinType

lastWasClear

lastWasClear: boolean

misc

misc: MiscellaneousOptions

`Optional`multiplayer

multiplayer?: {
    options: MultiplayerOptions;
    passthrough: {
        network: boolean;
        replay: boolean;
        travel: boolean;
    };
    targets: number[];
}

pc

pc: PCOptions

queue

queue: Queue

`Internal`resCache

resCache: {
    garbage: {
        received: OutgoingGarbage[];
        sent: number[];
    };
    keys: Key[];
    lastLock: number;
    pieces: number;
}

spike

spike: {
count: number;
timer: number;
}

state

state: number

stats

stats: {
    b2b: number;
    combo: number;
    garbage: {
        attack: number;
        cleared: number;
        receive: number;
        sent: number;
    };
    lines: number;
    pieces: number;
}

stock

stock: number

subframe

subframe: number

`Static`colorMap

colorMap: {
    bomb: ChalkInstance;
    gb: ChalkInstance;
    i: ChalkInstance;
    j: ChalkInstance;
    l: ChalkInstance;
    o: ChalkInstance;
    s: ChalkInstance;
    t: ChalkInstance;
    z: ChalkInstance;
} = ...

Accessors

currentSpike

get currentSpike(): number
Returns number
- Defined in src/engine/index.ts:1802

dynamicStats

get dynamicStats(): {
    apm: number;
    pps: number;
    surgePower: number;
    vs: number;
}
Returns {
    apm: number;
    pps: number;
    surgePower: number;
    vs: number;
}
- apm: number
- pps: number
- surgePower: number
- vs: number
- Defined in src/engine/index.ts:463

kickTable

get kickTable():
    | {
        additional_offsets: {};
        colorMap: {
            d: string;
            g: string;
            gb: string;
            gbd: string;
            i: string;
            i1: string;
            i2: string;
            i3: string;
            i5: string;
            j: string;
            l: string;
            l3: string;
            o: string;
            oo: string;
            s: string;
            t: string;
            z: string;
        };
        i_kicks: {
            01: number[][];
            02: never[];
            03: number[][];
            10: number[][];
            12: number[][];
            13: never[];
            20: never[];
            21: number[][];
            23: number[][];
            30: number[][];
            31: never[];
            32: number[][];
        };
        i2_kicks: {
            01: number[][];
            02: never[];
            03: number[][];
            10: number[][];
            12: number[][];
            13: never[];
            20: never[];
            21: number[][];
            23: number[][];
            30: number[][];
            31: never[];
            32: number[][];
        };
        i3_kicks: {
            01: number[][];
            02: never[];
            03: number[][];
            10: number[][];
            12: number[][];
            13: never[];
            20: never[];
            21: number[][];
            23: number[][];
            30: number[][];
            31: never[];
            32: number[][];
        };
        i5_kicks: {
            01: number[][];
            02: never[];
            03: number[][];
            10: number[][];
            12: number[][];
            13: never[];
            20: never[];
            21: number[][];
            23: number[][];
            30: number[][];
            31: never[];
            32: number[][];
        };
        kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        l3_kicks: {
            01: number[][];
            02: never[];
            03: number[][];
            10: number[][];
            12: number[][];
            13: never[];
            20: never[];
            21: number[][];
            23: number[][];
            30: number[][];
            31: never[];
            32: number[][];
        };
        oo_kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        preview_overrides: {};
        spawn_rotation: {};
    }
    | {
        additional_offsets: {};
        colorMap: {
            d: string;
            g: string;
            gb: string;
            gbd: string;
            i: string;
            i1: string;
            i2: string;
            i3: string;
            i5: string;
            j: string;
            l: string;
            l3: string;
            o: string;
            oo: string;
            s: string;
            t: string;
            z: string;
        };
        i_kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        i2_kicks: {
            01: number[][];
            02: never[];
            03: number[][];
            10: number[][];
            12: number[][];
            13: never[];
            20: never[];
            21: number[][];
            23: number[][];
            30: number[][];
            31: never[];
            32: number[][];
        };
        i3_kicks: {
            01: number[][];
            02: never[];
            03: number[][];
            10: number[][];
            12: number[][];
            13: never[];
            20: never[];
            21: number[][];
            23: number[][];
            30: number[][];
            31: never[];
            32: number[][];
        };
        i5_kicks: {
            01: number[][];
            02: never[];
            03: number[][];
            10: number[][];
            12: number[][];
            13: never[];
            20: never[];
            21: number[][];
            23: number[][];
            30: number[][];
            31: never[];
            32: number[][];
        };
        kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        l3_kicks: {
            01: number[][];
            02: never[];
            03: number[][];
            10: number[][];
            12: number[][];
            13: never[];
            20: never[];
            21: number[][];
            23: number[][];
            30: number[][];
            31: never[];
            32: number[][];
        };
        oo_kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        preview_overrides: {};
        spawn_rotation: {};
    }
    | {
        additional_offsets: {};
        colorMap: {
            d: string;
            g: string;
            gb: string;
            gbd: string;
            i: string;
            i1: string;
            i2: string;
            i3: string;
            i5: string;
            j: string;
            l: string;
            l3: string;
            o: string;
            oo: string;
            s: string;
            t: string;
            z: string;
        };
        i_kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        i2_kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        i3_kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        i5_kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        l3_kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        oo_kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        preview_overrides: {};
        spawn_rotation: {};
    }
    | {
        additional_offsets: {};
        colorMap: {
            d: string;
            g: string;
            gb: string;
            gbd: string;
            i: string;
            i1: string;
            i2: string;
            i3: string;
            i5: string;
            j: string;
            l: string;
            l3: string;
            o: string;
            oo: string;
            s: string;
            t: string;
            z: string;
        };
        i_kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        preview_overrides: {};
        spawn_rotation: {};
    }
    | {
        additional_offsets: {
            i: number[][];
            j: number[][];
            l: number[][];
            o: number[][];
            s: number[][];
            t: number[][];
            z: number[][];
        };
        colorMap: {
            d: string;
            g: string;
            gb: string;
            gbd: string;
            i: string;
            i1: string;
            i2: string;
            i3: string;
            i5: string;
            j: string;
            l: string;
            l3: string;
            o: string;
            oo: string;
            s: string;
            t: string;
            z: string;
        };
        kicks: {
            01: never[];
            02: never[];
            03: never[];
            10: never[];
            12: never[];
            13: never[];
            20: never[];
            21: never[];
            23: never[];
            30: never[];
            31: never[];
            32: never[];
        };
        preview_overrides: {
            j: number[][];
            l: number[][];
            t: number[][];
        };
        spawn_rotation: {
            i: number;
            j: number;
            l: number;
            o: number;
            s: number;
            t: number;
            z: number;
        };
    }
    | {
        additional_offsets: {
            i: number[][];
            i1: number[][];
            j: number[][];
            l: number[][];
            o: number[][];
            s: number[][];
            t: number[][];
            z: number[][];
        };
        center_column: number[][];
        colorMap: {
            d: string;
            g: string;
            gb: string;
            gbd: string;
            i: string;
            i1: string;
            i2: string;
            i3: string;
            i5: string;
            j: string;
            l: string;
            l3: string;
            o: string;
            s: string;
            t: string;
            z: string;
        };
        kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        preview_overrides: {
            j: number[][];
            l: number[][];
            t: number[][];
        };
        spawn_rotation: {
            i: number;
            j: number;
            l: number;
            o: number;
            s: number;
            t: number;
            z: number;
        };
    }
    | {
        additional_offsets: {
            i: number[][];
            i1: number[][];
            j: number[][];
            l: number[][];
            o: number[][];
            s: number[][];
            t: number[][];
            z: number[][];
        };
        allow_o_kick: boolean;
        colorMap: {
            d: string;
            g: string;
            gb: string;
            gbd: string;
            i: string;
            i1: string;
            i2: string;
            i3: string;
            i5: string;
            j: string;
            l: string;
            l3: string;
            o: string;
            oo: string;
            s: string;
            t: string;
            z: string;
        };
        i_kicks: {
            01: number[][];
            02: never[];
            03: number[][];
            10: number[][];
            12: number[][];
            13: never[];
            20: never[];
            21: number[][];
            23: number[][];
            30: number[][];
            31: never[];
            32: number[][];
        };
        kicks: {
            01: number[][];
            02: never[];
            03: number[][];
            10: number[][];
            12: number[][];
            13: never[];
            20: never[];
            21: number[][];
            23: number[][];
            30: number[][];
            31: never[];
            32: number[][];
        };
        preview_overrides: {};
        spawn_rotation: {};
    }
    | {
        additional_offsets: {};
        colorMap: {
            d: string;
            g: string;
            gb: string;
            gbd: string;
            i: string;
            i1: string;
            i2: string;
            i3: string;
            i5: string;
            j: string;
            l: string;
            l3: string;
            o: string;
            oo: string;
            s: string;
            t: string;
            z: string;
        };
        kicks: {
            01: never[];
            02: never[];
            03: never[];
            10: never[];
            12: never[];
            13: never[];
            20: never[];
            21: never[];
            23: never[];
            30: never[];
            31: never[];
            32: never[];
        };
        preview_overrides: {};
        spawn_rotation: {};
    }
Returns
    | {
        additional_offsets: {};
        colorMap: {
            d: string;
            g: string;
            gb: string;
            gbd: string;
            i: string;
            i1: string;
            i2: string;
            i3: string;
            i5: string;
            j: string;
            l: string;
            l3: string;
            o: string;
            oo: string;
            s: string;
            t: string;
            z: string;
        };
        i_kicks: {
            01: number[][];
            02: never[];
            03: number[][];
            10: number[][];
            12: number[][];
            13: never[];
            20: never[];
            21: number[][];
            23: number[][];
            30: number[][];
            31: never[];
            32: number[][];
        };
        i2_kicks: {
            01: number[][];
            02: never[];
            03: number[][];
            10: number[][];
            12: number[][];
            13: never[];
            20: never[];
            21: number[][];
            23: number[][];
            30: number[][];
            31: never[];
            32: number[][];
        };
        i3_kicks: {
            01: number[][];
            02: never[];
            03: number[][];
            10: number[][];
            12: number[][];
            13: never[];
            20: never[];
            21: number[][];
            23: number[][];
            30: number[][];
            31: never[];
            32: number[][];
        };
        i5_kicks: {
            01: number[][];
            02: never[];
            03: number[][];
            10: number[][];
            12: number[][];
            13: never[];
            20: never[];
            21: number[][];
            23: number[][];
            30: number[][];
            31: never[];
            32: number[][];
        };
        kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        l3_kicks: {
            01: number[][];
            02: never[];
            03: number[][];
            10: number[][];
            12: number[][];
            13: never[];
            20: never[];
            21: number[][];
            23: number[][];
            30: number[][];
            31: never[];
            32: number[][];
        };
        oo_kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        preview_overrides: {};
        spawn_rotation: {};
    }
    | {
        additional_offsets: {};
        colorMap: {
            d: string;
            g: string;
            gb: string;
            gbd: string;
            i: string;
            i1: string;
            i2: string;
            i3: string;
            i5: string;
            j: string;
            l: string;
            l3: string;
            o: string;
            oo: string;
            s: string;
            t: string;
            z: string;
        };
        i_kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        i2_kicks: {
            01: number[][];
            02: never[];
            03: number[][];
            10: number[][];
            12: number[][];
            13: never[];
            20: never[];
            21: number[][];
            23: number[][];
            30: number[][];
            31: never[];
            32: number[][];
        };
        i3_kicks: {
            01: number[][];
            02: never[];
            03: number[][];
            10: number[][];
            12: number[][];
            13: never[];
            20: never[];
            21: number[][];
            23: number[][];
            30: number[][];
            31: never[];
            32: number[][];
        };
        i5_kicks: {
            01: number[][];
            02: never[];
            03: number[][];
            10: number[][];
            12: number[][];
            13: never[];
            20: never[];
            21: number[][];
            23: number[][];
            30: number[][];
            31: never[];
            32: number[][];
        };
        kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        l3_kicks: {
            01: number[][];
            02: never[];
            03: number[][];
            10: number[][];
            12: number[][];
            13: never[];
            20: never[];
            21: number[][];
            23: number[][];
            30: number[][];
            31: never[];
            32: number[][];
        };
        oo_kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        preview_overrides: {};
        spawn_rotation: {};
    }
    | {
        additional_offsets: {};
        colorMap: {
            d: string;
            g: string;
            gb: string;
            gbd: string;
            i: string;
            i1: string;
            i2: string;
            i3: string;
            i5: string;
            j: string;
            l: string;
            l3: string;
            o: string;
            oo: string;
            s: string;
            t: string;
            z: string;
        };
        i_kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        i2_kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        i3_kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        i5_kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        l3_kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        oo_kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        preview_overrides: {};
        spawn_rotation: {};
    }
    | {
        additional_offsets: {};
        colorMap: {
            d: string;
            g: string;
            gb: string;
            gbd: string;
            i: string;
            i1: string;
            i2: string;
            i3: string;
            i5: string;
            j: string;
            l: string;
            l3: string;
            o: string;
            oo: string;
            s: string;
            t: string;
            z: string;
        };
        i_kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        preview_overrides: {};
        spawn_rotation: {};
    }
    | {
        additional_offsets: {
            i: number[][];
            j: number[][];
            l: number[][];
            o: number[][];
            s: number[][];
            t: number[][];
            z: number[][];
        };
        colorMap: {
            d: string;
            g: string;
            gb: string;
            gbd: string;
            i: string;
            i1: string;
            i2: string;
            i3: string;
            i5: string;
            j: string;
            l: string;
            l3: string;
            o: string;
            oo: string;
            s: string;
            t: string;
            z: string;
        };
        kicks: {
            01: never[];
            02: never[];
            03: never[];
            10: never[];
            12: never[];
            13: never[];
            20: never[];
            21: never[];
            23: never[];
            30: never[];
            31: never[];
            32: never[];
        };
        preview_overrides: {
            j: number[][];
            l: number[][];
            t: number[][];
        };
        spawn_rotation: {
            i: number;
            j: number;
            l: number;
            o: number;
            s: number;
            t: number;
            z: number;
        };
    }
    | {
        additional_offsets: {
            i: number[][];
            i1: number[][];
            j: number[][];
            l: number[][];
            o: number[][];
            s: number[][];
            t: number[][];
            z: number[][];
        };
        center_column: number[][];
        colorMap: {
            d: string;
            g: string;
            gb: string;
            gbd: string;
            i: string;
            i1: string;
            i2: string;
            i3: string;
            i5: string;
            j: string;
            l: string;
            l3: string;
            o: string;
            s: string;
            t: string;
            z: string;
        };
        kicks: {
            01: number[][];
            02: number[][];
            03: number[][];
            10: number[][];
            12: number[][];
            13: number[][];
            20: number[][];
            21: number[][];
            23: number[][];
            30: number[][];
            31: number[][];
            32: number[][];
        };
        preview_overrides: {
            j: number[][];
            l: number[][];
            t: number[][];
        };
        spawn_rotation: {
            i: number;
            j: number;
            l: number;
            o: number;
            s: number;
            t: number;
            z: number;
        };
    }
    | {
        additional_offsets: {
            i: number[][];
            i1: number[][];
            j: number[][];
            l: number[][];
            o: number[][];
            s: number[][];
            t: number[][];
            z: number[][];
        };
        allow_o_kick: boolean;
        colorMap: {
            d: string;
            g: string;
            gb: string;
            gbd: string;
            i: string;
            i1: string;
            i2: string;
            i3: string;
            i5: string;
            j: string;
            l: string;
            l3: string;
            o: string;
            oo: string;
            s: string;
            t: string;
            z: string;
        };
        i_kicks: {
            01: number[][];
            02: never[];
            03: number[][];
            10: number[][];
            12: number[][];
            13: never[];
            20: never[];
            21: number[][];
            23: number[][];
            30: number[][];
            31: never[];
            32: number[][];
        };
        kicks: {
            01: number[][];
            02: never[];
            03: number[][];
            10: number[][];
            12: number[][];
            13: never[];
            20: never[];
            21: number[][];
            23: number[][];
            30: number[][];
            31: never[];
            32: number[][];
        };
        preview_overrides: {};
        spawn_rotation: {};
    }
    | {
        additional_offsets: {};
        colorMap: {
            d: string;
            g: string;
            gb: string;
            gbd: string;
            i: string;
            i1: string;
            i2: string;
            i3: string;
            i5: string;
            j: string;
            l: string;
            l3: string;
            o: string;
            oo: string;
            s: string;
            t: string;
            z: string;
        };
        kicks: {
            01: never[];
            02: never[];
            03: never[];
            10: never[];
            12: never[];
            13: never[];
            20: never[];
            21: never[];
            23: never[];
            30: never[];
            31: never[];
            32: never[];
        };
        preview_overrides: {};
        spawn_rotation: {};
    }
- Defined in src/engine/index.ts:451
set kickTable(value): void
Parameters
- value:
      | "none"
      | "SRS"
      | "SRS+"
      | "SRS-X"
      | "TETRA-X"
      | "NRS"
      | "ARS"
      | "ASC"
Returns void
- Defined in src/engine/index.ts:459

kickTableName

get kickTableName():
    | "none"
    | "SRS"
    | "SRS+"
    | "SRS-X"
    | "TETRA-X"
    | "NRS"
    | "ARS"
    | "ASC"
Returns
    | "none"
    | "SRS"
    | "SRS+"
    | "SRS-X"
    | "TETRA-X"
    | "NRS"
    | "ARS"
    | "ASC"
- Defined in src/engine/index.ts:455

text

get text(): string
Returns string
- Defined in src/engine/index.ts:1818

toppedOut

get toppedOut(): boolean
Returns boolean
- Defined in src/engine/index.ts:981

Methods

bindAll

bindAll(): void
Returns void
- Defined in src/engine/index.ts:337

clone

clone(): Engine
Return an engine with the same config. Does not preserve state.

Returns Engine
- Defined in src/engine/index.ts:1848

connect

connect(blocks): (readonly [number, number, number])[]
Parameters
- blocks: [x: number, y: number][]
Returns (readonly [number, number, number])[]
- Defined in src/engine/index.ts:1759

dasLeft

dasLeft(): boolean
Returns boolean
- Defined in src/engine/index.ts:1045

dasRight

dasRight(): boolean
Returns boolean
- Defined in src/engine/index.ts:1039

fromSnapshot

fromSnapshot(snapshot): void
Parameters
- snapshot: EngineSnapshot
Returns void
- Defined in src/engine/index.ts:382

getConnectedPreview

getConnectedPreview(piece): {
    data: (readonly [number, number, number])[];
    h: number;
    w: number;
}
Parameters
- piece: Engine.Mino
Returns {
    data: (readonly [number, number, number])[];
    h: number;
    w: number;
}
- data: (readonly [number, number, number])[]
- h: number
- w: number
- Defined in src/engine/index.ts:1786

getPreview

getPreview(piece): {
    data: [number, number, number][];
    h: number;
    w: number;
}
Parameters
- piece: Engine.Mino
Returns {
    data: [number, number, number][];
    h: number;
    w: number;
}
- data: [number, number, number][]
- h: number
- w: number
- Defined in src/engine/index.ts:1755

hardDrop

hardDrop(): LockRes
Returns LockRes
- Defined in src/engine/index.ts:1176

hold

hold(_ihs?, ignoreBlockout?): boolean
Parameters
- _ihs: boolean = false
- ignoreBlockout: boolean = false
Returns boolean
- Defined in src/engine/index.ts:954

init

init(): void
Returns void
- Defined in src/engine/index.ts:201

initiatePiece

initiatePiece(piece, ignoreBlockout?, isHold?): void
Parameters
- piece: Engine.Mino
- ignoreBlockout: boolean = false
- isHold: boolean = false
Returns void
- Defined in src/engine/index.ts:846

moveLeft

moveLeft(): boolean
Returns boolean
- Defined in src/engine/index.ts:1033

moveRight

moveRight(): boolean
Returns boolean
- Defined in src/engine/index.ts:1027

nextPiece

nextPiece(ignoreBlockout?, isHold?): void
Parameters
- ignoreBlockout: boolean = false
- isHold: boolean = false
Returns void
- Defined in src/engine/index.ts:828

onQueuePieces

onQueuePieces(_listener): void
Parameters
- _listener: ((pieces: Engine.Mino[]) => void)
  - - (pieces): void
    - Parameters
      pieces: Engine.Mino[]
      Returns void
Returns void
Deprecated
Engine.onQueuePieces is deprecated and no longer functional. Switch to Engine.events.on("queue.add", (pieces) => {}) instead.
- Defined in src/engine/index.ts:1796

press

press<T>(key): boolean | LockRes
Type Parameters
- T extends Key | "dasLeft" | "dasRight"
Parameters
- key: T
Returns boolean | LockRes
- Defined in src/engine/index.ts:1435

receiveGarbage

receiveGarbage(...garbage): void
Parameters
- Rest...garbage: IncomingGarbage[]
Returns void
- Defined in src/engine/index.ts:1751

reset

reset(): void
Returns void
- Defined in src/engine/index.ts:333

rotate180

rotate180(): boolean
Returns boolean
- Defined in src/engine/index.ts:1023

rotateCCW

rotateCCW(): boolean
Returns boolean
- Defined in src/engine/index.ts:1019

rotateCW

rotateCW(): boolean
Returns boolean
- Defined in src/engine/index.ts:1015

snapshot

snapshot(): EngineSnapshot
Returns EngineSnapshot
- Defined in src/engine/index.ts:357

softDrop

softDrop(): boolean
Returns boolean
- Defined in src/engine/index.ts:1051

tick

tick(frames): {
    garbage: {
        received: OutgoingGarbage[];
        sent: number[];
    };
    keys: Key[];
    lastLock: number;
    pieces: number;
}
Parameters
- frames: Frame[]
Returns {
    garbage: {
        received: OutgoingGarbage[];
        sent: number[];
    };
    keys: Key[];
    lastLock: number;
    pieces: number;
}
- garbage: {
  received: OutgoingGarbage[];
  sent: number[];
  }
  - received: OutgoingGarbage[]
  - sent: number[]
- keys: Key[]
- lastLock: number
- pieces: number
- Defined in src/engine/index.ts:1731

Class Engine

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Engine

Properties

b2b

board

connectedBoard

dynamic

events

falling

frame

gameOptions

garbageQueue

glock

handling

held

holdLocked

igeHandler

initializer

input

lastSpin

lastWasClear

misc

Optionalmultiplayer

pc

queue

InternalresCache

spike

state

stats

stock

subframe

StaticcolorMap

Accessors

currentSpike

Returns number

dynamicStats

Returns { apm: number; pps: number; surgePower: number; vs: number; }

apm: number

pps: number

surgePower: number

vs: number

kickTable

Parameters

Returns void

kickTableName

Returns | "none" | "SRS" | "SRS+" | "SRS-X" | "TETRA-X" | "NRS" | "ARS" | "ASC"

text

Returns string

toppedOut

Returns boolean

Methods

bindAll

Returns void

clone

Returns Engine

connect

Parameters

Returns (readonly [number, number, number])[]

dasLeft

Returns boolean

dasRight

Returns boolean

fromSnapshot

Parameters

Returns void

getConnectedPreview

Parameters

Returns { data: (readonly [number, number, number])[]; h: number; w: number; }

data: (readonly [number, number, number])[]

h: number

w: number

getPreview

`Optional`multiplayer

`Internal`resCache

`Static`colorMap

Returns {
apm: number;
pps: number;
surgePower: number;
vs: number;
}

Returns
| "none"
| "SRS"
| "SRS+"
| "SRS-X"
| "TETRA-X"
| "NRS"
| "ARS"
| "ASC"

Returns {
data: (readonly [number, number, number])[];
h: number;
w: number;
}

Returns {
data: [number, number, number][];
h: number;
w: number;
}

Returns {
garbage: {
received: OutgoingGarbage[];
sent: number[];
};
keys: Key[];
lastLock: number;
pieces: number;
}

garbage: {
received: OutgoingGarbage[];
sent: number[];
}