Reference · Rules, games and records
GameResulttype
The decided winner, ending, win kind, cube multiplier and points.
Import it
import type { GameResult } from "@johnmorrisdotca/sugoroku";
Definition
type GameResult = {
readonly winner: Side | null;
readonly how: HowItEnded;
readonly kind: WinKind;
readonly multiplier: number;
readonly cube: number;
readonly points: number;
};
Members
| Name | Type | Description |
|---|---|---|
winner | Side | null | The side that won, or null for a draw. |
how | HowItEnded | |
kind | WinKind | |
multiplier | number | 1 for a single win, 2 for a gammon, 3 for a backgammon, after the Jacoby rule and the choice of rules. |
cube | number | The cube's value when it ended. |
points | number | What the winner scores: the multiplier times the cube. 0 for a draw. |
Examples
import { concede, newGame, rollOpening, settingsFor } from "@johnmorrisdotca/sugoroku";
import type { GameResult } 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!;
const value: GameResult = result;
console.log(value);{
winner: 'white',
how: 'concede',
kind: 'single',
multiplier: 1,
cube: 1,
points: 1
}What it prints (run when this page was built)