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

previewEarthquakefunction

Preview an earthquake, with Combined always fracturing before its one jumble attempt.

Import it

import { previewEarthquake } from "@johnmorrisdotca/houseki/nature";

Definition

function previewEarthquake(state: NatureState, options: EarthquakeOptions): EarthquakePreview

Parameters

NameTypeDescription
stateNatureState

The immutable native state to read or transition; the input is retained.

optionsEarthquakeOptions

Validated native creation, authored challenge, or environment options described by this signature.

Returns

EarthquakePreview

Preview an earthquake, with Combined always fracturing before its one jumble attempt.

Examples

import { createNatureState, previewEarthquake } from "@johnmorrisdotca/houseki/nature";

const state=createNatureState({width:4,height:4,seed:"docs"});
console.log(previewEarthquake(state,{kind:"fault"}).kind);
fault

What it prints (run when this page was built)

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