Reference · Shizen and Arashi environments
previewMagneticPulsefunction
Preview one bounded deterministic attraction pulse without mutating the state.
Import it
import { previewMagneticPulse } from "@johnmorrisdotca/houseki/nature";
Definition
function previewMagneticPulse(state: NatureState): MagneticPreview
Parameters
| Name | Type | Description |
|---|---|---|
state | NatureState | The immutable native state to read or transition; the input is retained. |
Returns
MagneticPreview
Preview one bounded deterministic attraction pulse without mutating the state.
Examples
import { createNatureState, previewMagneticPulse } from "@johnmorrisdotca/houseki/nature";
const state=createNatureState({width:4,height:4,seed:"docs"});
console.log(previewMagneticPulse(state).moves.length);0What it prints (run when this page was built)