Reference · Rules, games and records
formatPositionfunction
A position as text, for any variant: each side's checkers as point:count
in that side's own numbering, highest point first, then the bar, those yet to
enter and those borne off, [white, black] each.
white=24:2,13:5,8:3,6:5 black=24:2,13:5,8:3,6:5 bar=0,0 reserve=0,0 off=0,0Import it
import { formatPosition } from "@johnmorrisdotca/sugoroku";
Definition
function formatPosition(position: Position): string
Parameters
| Name | Type | Description |
|---|---|---|
position | Position | The native checker counts, bar, reserve and borne-off counts. |
Returns
string
A position as text, for any variant: each side's checkers as point:count in that side's own numbering, highest point first, then the bar, those yet to enter and those borne off, [white, black] each.
Examples
import { formatPosition, settingsFor, startPosition } from "@johnmorrisdotca/sugoroku";
const settings = settingsFor("backgammon",{points:5,cube:true});
const spec = settings.variant;
const position = startPosition(spec);
console.log(formatPosition(position));white=24:2,13:5,8:3,6:5 black=24:2,13:5,8:3,6:5 bar=0,0 reserve=0,0 off=0,0What it prints (run when this page was built)