Reference · Rules, games and records
multiplierOffunction
What a win of kind is worth, after the rules: a single win when gammons do not count, or when the Jacoby rule holds them back because the cube was never turned.
Import it
import { multiplierOf } from "@johnmorrisdotca/sugoroku";
Definition
function multiplierOf(game: GameState, kind: WinKind): number
Parameters
| Name | Type | Description |
|---|---|---|
game | GameState | The current immutable native game state. |
kind | WinKind | The native single, gammon or backgammon result. |
Returns
number
What a win of kind is worth, after the rules: a single win when gammons do not count, or when the Jacoby rule holds them back because the cube was never turned.
Examples
import { multiplierOf, newGame, rollOpening, settingsFor } from "@johnmorrisdotca/sugoroku";
const settings = settingsFor("backgammon",{points:5,cube:true});
const game = rollOpening(newGame(settings),[3,1]);
console.log(multiplierOf(game,"gammon"));1What it prints (run when this page was built)