Reference · Shizen and Arashi environments

NatureTransitiontype

Import it

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

Definition

interface NatureTransition {
    readonly state: NatureState;
    readonly accepted: boolean;
    readonly reason?: string;
    readonly events: readonly NatureEvent[];
    readonly preview?: MagneticPreview | PowerDropPreview;
}

Members

Examples

import { applyMagneticPulse, createNatureState } from "@johnmorrisdotca/houseki/nature";
import type { NatureTransition } from "@johnmorrisdotca/houseki/nature";

const state=createNatureState({width:4,height:4,seed:"docs"});
const value: NatureTransition = applyMagneticPulse(state);
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.