Reference · Rules, games and records
legalMovesfunction
The moves the side on turn may make next. Empty when the turn is played out, or nothing can be played.
Import it
import { legalMoves } from "@johnmorrisdotca/sugoroku";
Definition
function legalMoves(game: GameState): Move[]
Parameters
| Name | Type | Description |
|---|---|---|
game | GameState | The current immutable native game state. |
Returns
Move[]
The moves the side on turn may make next. Empty when the turn is played out, or nothing can be played.
Examples
import { legalMoves, newGame, rollOpening, settingsFor } from "@johnmorrisdotca/sugoroku";
const settings = settingsFor("backgammon",{points:5,cube:true});
const game = rollOpening(newGame(settings),[3,1]);
console.log(legalMoves(game));[
{ from: 24, to: 21, die: 3, hit: false },
{ from: 13, to: 10, die: 3, hit: false },
{ from: 8, to: 5, die: 3, hit: false },
{ from: 6, to: 3, die: 3, hit: false },
{ from: 24, to: 23, die: 1, hit: false },
{ from: 8, to: 7, die: 1, hit: false },
{ from: 6, to: 5, die: 1, hit: false }
]What it prints (run when this page was built)