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

EnvironmentTransitiontype

The committed environment state, event list and pure preview.

Import it

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

Definition

interface EnvironmentTransition {
    readonly state: NatureState;
    readonly accepted: true;
    readonly events: readonly EnvironmentEvent[];
    readonly preview: EnvironmentPreview;
}

Members

NameTypeDescription
stateNatureState
acceptedtrue
eventsreadonly EnvironmentEvent[]
previewEnvironmentPreview

Examples

import { applyLightning, createNatureState } from "@johnmorrisdotca/houseki/nature";
import type { EnvironmentTransition } from "@johnmorrisdotca/houseki/nature";

const state=createNatureState({width:4,height:4,seed:"docs"});
const value: EnvironmentTransition = applyLightning(state,{columns:[0]});
console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
[ 'state', 'accepted', 'events', 'preview' ]

What it prints (run when this page was built)

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