Skip to the content

Houseki宝石

Run five native gem and stone engines, play measured challenges and lessons, and save deterministic games.

Houseki (宝石) is Japanese for a gem or precious stone. About the name

Contents

Reference · Falling Triplets

statusOffunction

Returns a plain status summary suitable for UI labels.

Import it

import { statusOf } from "@johnmorrisdotca/houseki/falling-triplets";

Definition

function statusOf(state: GameState): Readonly<{ phase: GameState["phase"]; score: number; maxChain: number; reason?: string; }>

Parameters

NameTypeDescription
stateGameState

The immutable native state to read or transition; the input is retained.

Returns

Readonly<{ phase: GameState["phase"]; score: number; maxChain: number; reason?: string; }>

Returns a plain status summary suitable for UI labels.

Examples

import { createGame, statusOf } from "@johnmorrisdotca/houseki/falling-triplets";

const state=createGame({seed:"docs"});
console.log(statusOf(state).phase);
falling

What it prints (run when this page was built)

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