Reference · Rules, games and records
agreeDrawfunction
The game drawn by agreement.
Import it
import { agreeDraw } from "@johnmorrisdotca/sugoroku";
Definition
function agreeDraw(game: GameState): GameState
Parameters
| Name | Type | Description |
|---|---|---|
game | GameState | The current immutable native game state. |
Returns
GameState
The game drawn by agreement.
Examples
import { agreeDraw, concede, newGame, rollOpening, settingsFor } from "@johnmorrisdotca/sugoroku";
const settings = settingsFor("backgammon",{points:5,cube:true});
const game = rollOpening(newGame(settings),[3,1]);
const result = concede(game,"black","single").result!;
console.log(agreeDraw(game).result);{
winner: null,
how: 'draw',
kind: 'single',
multiplier: 1,
cube: 1,
points: 0
}What it prints (run when this page was built)