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 · Gem Swap

Settingstype

Validated settings fixed at native game creation.

Import it

import type { Settings } from "@johnmorrisdotca/houseki/gem-swap";

Definition

interface Settings {
    readonly width: number;
    readonly height: number;
    readonly colourCount: 4 | 5 | 6;
    readonly seed: string | number;
    readonly tools: boolean;
    readonly advancedTools: boolean;
    readonly shape?: BoardShape;
    readonly mask: readonly boolean[];
}

Members

NameTypeDescription
widthnumber
heightnumber
colourCount4 | 5 | 6
seedstring | number
toolsboolean
advancedToolsboolean
shape (optional)BoardShape | undefined
maskreadonly boolean[]

Examples

import { createGame } from "@johnmorrisdotca/houseki/gem-swap";
import type { Settings } from "@johnmorrisdotca/houseki/gem-swap";

const state=createGame({seed:"docs"});
const value: Settings = state.settings;
console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
[ 'width', 'height', 'colourCount', 'seed', 'tools', 'advancedTools' ]

What it prints (run when this page was built)

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