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 · Shizen and Arashi environments

JumblePreviewtype

A pure eligible-patch shuffle and resulting occupants; reason explains when no patch exists.

Import it

import type { JumblePreview } from "@johnmorrisdotca/houseki/nature";

Definition

interface JumblePreview {
    readonly patchCells: readonly number[];
    readonly moves: readonly NatureMove[];
    readonly changed: boolean;
    readonly reason?: 'no-eligible-patch';
    readonly cells: readonly (NatureEntity | null)[];
    readonly randomStateAfter: number;
}

Members

NameTypeDescription
patchCellsreadonly number[]
movesreadonly NatureMove[]
changedboolean
reason (optional)"no-eligible-patch" | undefined
cellsreadonly (NatureEntity | null)[]
randomStateAfternumber

Examples

import { createNatureState, previewJumble } from "@johnmorrisdotca/houseki/nature";
import type { JumblePreview } from "@johnmorrisdotca/houseki/nature";

const state=createNatureState({width:4,height:4,seed:"docs"});
const value: JumblePreview = previewJumble(state);
console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
[
  'patchCells',
  'moves',
  'changed',
  'reason',
  'cells',
  'randomStateAfter'
]

What it prints (run when this page was built)

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