GameStatustype
Compact player status derived from the current state.
Import it
import type { GameStatus } from "@johnmorrisdotca/houseki/colour-chains";
Definition
interface GameStatus {
readonly mode: Mode;
readonly phase: Phase;
readonly score: number;
readonly maxChain: number;
readonly allClears: number;
readonly completedPairs: number;
readonly assisted: boolean;
readonly reason?: string;
}
Members
| Name | Type | Description |
|---|---|---|
mode | Mode | |
phase | Phase | |
score | number | |
maxChain | number | |
allClears | number | |
completedPairs | number | |
assisted | boolean | |
reason (optional) | string | undefined |
Examples
import { createGame, statusOf } from "@johnmorrisdotca/houseki/colour-chains";
import type { GameStatus } from "@johnmorrisdotca/houseki/colour-chains";
const state=createGame({seed:"docs"});
const value: GameStatus = statusOf(state);
console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);[ 'mode', 'phase', 'score', 'maxChain', 'allClears', 'completedPairs' ]What it prints (run when this page was built)