Settingstype
Run settings fixed at game creation.
Import it
import type { Settings } from "@johnmorrisdotca/houseki/colour-chains";Definition
interface Settings {
readonly mode: Mode;
readonly width: number;
readonly height: number;
readonly colourCount: 4 | 5 | 6;
readonly seed: string;
readonly date?: string;
readonly pairLimit?: number;
readonly nature?: true;
readonly weather?: WeatherSchedule;
readonly challengeId?: string;
readonly goal?: ChallengeGoal;
readonly initialBoard?: readonly (ChallengeGem | null)[];
readonly queue?: readonly (readonly [
Colour,
Colour
])[];
readonly magneticQueue?: readonly (readonly [
boolean,
boolean
])[];
readonly witness?: readonly WitnessStep[];
}Members
| Name | Type | Description |
|---|---|---|
mode | Mode | |
width | number | |
height | number | |
colourCount | 4 | 5 | 6 | |
seed | string | |
date (optional) | string | undefined | |
pairLimit (optional) | number | undefined | |
nature (optional) | true | undefined | |
weather (optional) | WeatherSchedule | undefined | |
challengeId (optional) | string | undefined | |
goal (optional) | ChallengeGoal | undefined | |
initialBoard (optional) | readonly (Gem | null)[] | undefined | |
queue (optional) | readonly (readonly [Colour, Colour])[] | undefined | |
magneticQueue (optional) | readonly (readonly [boolean, boolean])[] | undefined | |
witness (optional) | readonly WitnessStep[] | undefined |
Examples
import { createGame } from "@johnmorrisdotca/houseki/colour-chains";
import type { Settings } from "@johnmorrisdotca/houseki/colour-chains";
const state=createGame({seed:"docs"});
const value: Settings = state.settings;
console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);[ 'mode', 'width', 'height', 'colourCount', 'seed' ]What it prints (run when this page was built)