Reference · Colour Chains

GameStatetype

Import it

import type { GameState } from "@johnmorrisdotca/houseki/colour-chains";

Definition

interface GameState {
    readonly game: 'colour-chains';
    readonly rules: 'chains-1';
    readonly settings: Settings;
    readonly board: readonly (Gem | null)[];
    readonly phase: Phase;
    readonly pausedPhase?: Exclude<Phase, 'paused'>;
    readonly active: Pair | null;
    readonly next: readonly (readonly [
        Colour,
        Colour
    ])[];
    readonly bag: readonly Colour[];
    readonly randomState: number;
    readonly nextMagnetic?: readonly (readonly [
        boolean,
        boolean
    ])[];
    readonly lastHorizontalDirection?: 'left' | 'right';
    readonly naturePulsePending?: boolean;
    readonly weatherResolvedPairs?: number;
    readonly nextId: number;
    readonly score: number;
    readonly maxChain: number;
    readonly allClears: number;
    readonly completedPairs: number;
    readonly resolutionTick: number;
    readonly resolutionLevel?: number;
    readonly waves: readonly Wave[];
    readonly clearCells: readonly number[];
    readonly gravityBoard: readonly (Gem | null)[] | null;
    readonly resolutionHadClear: boolean;
    readonly elapsedTicks: number;
    readonly assisted: boolean;
    readonly witnessIndex: number;
    readonly recording: readonly RecordedAction[];
    readonly reason?: string;
}

Members

Examples

import { createGame } from "@johnmorrisdotca/houseki/colour-chains";
import type { GameState } from "@johnmorrisdotca/houseki/colour-chains";

const state=createGame({seed:"docs"});
const value: GameState = state;
console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);

[ 'game', 'rules', 'settings', 'board', 'phase', 'active' ]

What it prints (run when this page was built)

View sourceEdit on GitHubMade from the source of @johnmorrisdotca/houseki 0.4.2.