Reference · Boards, rules and challenges
newGamefunction
Creates a validated immutable position with the given target hole, if any.
Import it
import { newGame } from "@johnmorrisdotca/tobiishi";
Definition
function newGame(board: Board, pegs: readonly boolean[], target?: number | null): Game
Parameters
| Name | Type | Description |
|---|---|---|
board | Readonly<{ name: string; lattice: "square" | "triangle"; cells: readonly Cell[]; jumps: readonly Jump[]; }> | The validated native board and all its legal jump triples. |
pegs | readonly boolean[] | One boolean per native hole; at least one peg must be present. |
target (optional) | number | null | The required final hole index, or null to permit any final hole. |
Returns
Readonly<{ board: Board; start: readonly boolean[]; pegs: readonly boolean[]; target: number | null; history: readonly Jump[]; helped: boolean; }>
Creates a validated immutable position with the given target hole, if any. The game’s target is null when any final hole is permitted.
Examples
import { makeBoard, newGame, pegCount } from "@johnmorrisdotca/tobiishi";
const board = makeBoard("Three holes",[{x:0,y:0},{x:1,y:0},{x:2,y:0}]);
console.log(pegCount(newGame(board,[true,true,false],2)));2What it prints (run when this page was built)