Reference · Rules, games and records
legalPlaysOffunction
Every different way the side on turn may play out the rest of its turn: for the dice it has yet to play, from where the position stands now.
Import it
import { legalPlaysOf } from "@johnmorrisdotca/sugoroku";
Definition
function legalPlaysOf(game: GameState): Play[]
Parameters
| Name | Type | Description |
|---|---|---|
game | GameState | The current immutable native game state. |
Returns
Play[]
Every different way the side on turn may play out the rest of its turn: for the dice it has yet to play, from where the position stands now.
Examples
import { legalPlaysOf, newGame, rollOpening, settingsFor } from "@johnmorrisdotca/sugoroku";
const settings = settingsFor("backgammon",{points:5,cube:true});
const game = rollOpening(newGame(settings),[3,1]);
console.log(legalPlaysOf(game).length);16What it prints (run when this page was built)