Reference · Rules, games and records
parsePlayfunction
The moves a written play makes with a roll, or null if it is not a legal
play of that roll. Checks every rule: it is found by making each named move
in some order, each one legal when it is made, until the roll is played as
the rules require. A checker that plays both dice may be written as one move,
24/14 for a 6 and a 4, as well as through the point it passes.
Import it
import { parsePlay } from "@johnmorrisdotca/sugoroku";
Definition
function parsePlay(spec: VariantSpec, position: Position, side: Side, roll: readonly number[], text: string): Move[] | null
Parameters
| Name | Type | Description |
|---|---|---|
spec | VariantSpec | The native variant specification. |
position | Position | The native checker counts, bar, reserve and borne-off counts. |
side | Side | The side being examined: white or black. |
roll | readonly number[] | The valid dice as thrown, in throw order. |
text | string | Native move notation, position text or full record specified by the signature. |
Returns
Move[] | null
The moves a written play makes with a roll, or null if it is not a legal play of that roll. Checks every rule: it is found by making each named move in some order, each one legal when it is made, until the roll is played as the rules require. A checker that plays both dice may be written as one move, 24/14 for a 6 and a 4, as well as through the point it passes.
Examples
import { formatPlay, legalPlaysOf, newGame, parsePlay, rollOpening, settingsFor, startPosition } from "@johnmorrisdotca/sugoroku";
const settings = settingsFor("backgammon",{points:5,cube:true});
const spec = settings.variant;
const position = startPosition(spec);
const game = rollOpening(newGame(settings),[3,1]);
const play = legalPlaysOf(game)[0];
console.log(parsePlay(spec,position,"white",[3,1],formatPlay(play.moves)));[
{ from: 24, to: 21, die: 3, hit: false },
{ from: 24, to: 23, die: 1, hit: false }
]What it prints (run when this page was built)