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

markMagneticStonesfunction

Deterministically assign magnetic markings to settled stones without changing their IDs or colours.

Import it

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

Definition

function markMagneticStones(state: NatureState, options: MarkingOptions): NatureTransition

Parameters

NameTypeDescription
stateNatureState

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

optionsMarkingOptions

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

Returns

NatureTransition

Deterministically assign magnetic markings to settled stones without changing their IDs or colours.

Examples

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

const state=createNatureState({width:4,height:4,seed:"docs"});
console.log(markMagneticStones(state,{probability:0.25,maximum:2}).accepted);
true

What it prints (run when this page was built)

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