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
| Name | Type | Description |
|---|---|---|
patchCells | readonly number[] | |
moves | readonly NatureMove[] | |
changed | boolean | |
reason (optional) | "no-eligible-patch" | undefined | |
cells | readonly (NatureEntity | null)[] | |
randomStateAfter | number |
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)