Reference · Rules, games and records
rollDicefunction
Roll the dice for the side on turn, which must not be waiting on an answer to a double.
Import it
import { rollDice } from "@johnmorrisdotca/sugoroku";
Definition
function rollDice(game: GameState, dice: readonly number[]): GameState
Parameters
| Name | Type | Description |
|---|---|---|
game | GameState | The current immutable native game state. |
dice | readonly number[] | Dice values as thrown, or a reproducible source specified by the signature. |
Returns
GameState
Roll the dice for the side on turn, which must not be waiting on an answer to a double.
Examples
import { endTurn, legalPlaysOf, newGame, playTurn, rollDice, 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 beforeRoll = playTurn(game,play.moves);
console.log(rollDice(beforeRoll,[6,2]).dice);[ 6, 2 ]What it prints (run when this page was built)