Reference · Rules, games and records
startPositionfunction
The position a variant starts from.
Import it
import { startPosition } from "@johnmorrisdotca/sugoroku";
Definition
function startPosition(spec: VariantSpec): Position
Parameters
| Name | Type | Description |
|---|---|---|
spec | VariantSpec | The native variant specification. |
Returns
Position
The position a variant starts from.
Examples
import { settingsFor, startPosition } from "@johnmorrisdotca/sugoroku";
const settings = settingsFor("backgammon",{points:5,cube:true});
const spec = settings.variant;
console.log(startPosition(spec).bar);[ 0, 0 ]What it prints (run when this page was built)