Reference · Rules, games and records
replayRecordfunction
Replay a record against the rules. Every move is checked to be legal when it
was made, every double to have been allowed, and each game's result and the
match's score are worked out, not read: a result line is only checked. Where
the record has a seed, the dice are checked to be the seed's. Gives the games
and the match, or the first line that goes wrong, and why.
Import it
import { replayRecord } from "@johnmorrisdotca/sugoroku";
Definition
function replayRecord(text: string): ReplayOk | ReplayError
Parameters
| Name | Type | Description |
|---|---|---|
text | string | Native move notation, position text or full record specified by the signature. |
Returns
ReplayOk | ReplayError
Replay a record against the rules. Every move is checked to be legal when it was made, every double to have been allowed, and each game's result and the match's score are worked out, not read: a result line is only checked. Where the record has a seed, the dice are checked to be the seed's. Gives the games and the match, or the first line that goes wrong, and why.
Examples
import { GameRecorder, legalPlaysOf, newGame, replayRecord, rollOpening, settingsFor, startGame } from "@johnmorrisdotca/sugoroku";
const settings = settingsFor("backgammon",{points:5,cube:true});
const game = rollOpening(newGame(settings),[3,1]);
const play = legalPlaysOf(game)[0];
const record = new GameRecorder(settings);
record.startGame();
record.opening([3,1]);
record.turn("white",[3,1],play.moves);
console.log(replayRecord(record.text()).ok);trueWhat it prints (run when this page was built)