Reference · Rules, games and records
formatMovefunction
One move as text: 24/18, bar/22*, 6/off.
Import it
import { formatMove } from "@johnmorrisdotca/sugoroku";
Definition
function formatMove(move: Move): string
Parameters
| Name | Type | Description |
|---|---|---|
move | Move | A native legal move, including die and hit status. |
Returns
string
One move as text: 24/18, bar/22*, 6/off.
Examples
import { formatMove, legalPlaysOf, newGame, rollOpening, settingsFor } from "@johnmorrisdotca/sugoroku";
const settings = settingsFor("backgammon",{points:5,cube:true});
const game = rollOpening(newGame(settings),[3,1]);
const play = legalPlaysOf(game)[0];
const move = play.moves[0];
console.log(formatMove(move));24/21What it prints (run when this page was built)