Reference · Rules, games and records
legalPlaysfunction
Every different turn a side may make with a roll: one for each position that playing the roll as the rules require can leave, with one way of getting there. A side that cannot move has the one play of no moves.
Import it
import { legalPlays } from "@johnmorrisdotca/sugoroku";
Definition
function legalPlays(spec: VariantSpec, position: Position, side: Side, roll: readonly number[]): Play[]
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. |
Returns
Play[]
Every different turn a side may make with a roll: one for each position that playing the roll as the rules require can leave, with one way of getting there. A side that cannot move has the one play of no moves.
Examples
import { legalPlays, settingsFor, startPosition } from "@johnmorrisdotca/sugoroku";
const settings = settingsFor("backgammon",{points:5,cube:true});
const spec = settings.variant;
const position = startPosition(spec);
console.log(legalPlays(spec,position,"white",[3,1]).length);16What it prints (run when this page was built)