Reference · Shizen and Arashi environments
previewLightningfunction
Preview seeded or explicitly selected columns; a mask gap or obstacle blocks the strike below it.
Import it
import { previewLightning } from "@johnmorrisdotca/houseki/nature";Definition
function previewLightning(state: NatureState, options?: LightningOptions): LightningPreviewParameters
| Name | Type | Description |
|---|---|---|
state | NatureState | 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
LightningPreview
Preview seeded or explicitly selected columns; a mask gap or obstacle blocks the strike below it.
Examples
import { createNatureState, previewLightning } from "@johnmorrisdotca/houseki/nature";
const state=createNatureState({width:4,height:4,seed:"docs"});
console.log(previewLightning(state,{columns:[0]}).columns);[ 0 ]What it prints (run when this page was built)