Reference · Shizen and Arashi environments

FaultPreviewtype

Import it

import type { FaultPreview } from "@johnmorrisdotca/houseki/nature";

Definition

interface FaultPreview {
    readonly path: readonly number[];
    readonly fracturedCells: readonly number[];
    readonly removedIds: readonly number[];
    readonly cells: readonly (NatureEntity | null)[];
    readonly activeCells: readonly boolean[];
    readonly randomStateAfter: number;
}

Members

Examples

import { createNatureState, previewFault } from "@johnmorrisdotca/houseki/nature";
import type { FaultPreview } from "@johnmorrisdotca/houseki/nature";

const state=createNatureState({width:4,height:4,seed:"docs"});
const value: FaultPreview = previewFault(state);
console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);

[
  'path',
  'fracturedCells',
  'removedIds',
  'cells',
  'activeCells',
  'randomStateAfter'
]

What it prints (run when this page was built)

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