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

applyLightningfunction

Commit one lightning strike. It removes exposed stones only and consumes no scores or tools.

Import it

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

Definition

function applyLightning(state: NatureState, options?: LightningOptions): EnvironmentTransition

Parameters

NameTypeDescription
stateNatureState

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

options (optional)LightningOptions

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

Returns

EnvironmentTransition

Commit one lightning strike. It removes exposed stones only and consumes no scores or tools.

Examples

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

const state=createNatureState({width:4,height:4,seed:"docs"});
console.log(applyLightning(state,{columns:[0]}).accepted);
true

What it prints (run when this page was built)

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