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

applyMagneticPulsefunction

Apply one attraction pulse. Disabled nature rules preserve the exact state reference and consume no random state.

Import it

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

Definition

function applyMagneticPulse(state: NatureState): NatureTransition

Parameters

NameTypeDescription
stateNatureState

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

Returns

NatureTransition

Apply one attraction pulse. Disabled nature rules preserve the exact state reference and consume no random state.

Examples

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

const state=createNatureState({width:4,height:4,seed:"docs"});
console.log(applyMagneticPulse(state).accepted);
true

What it prints (run when this page was built)

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