Skip to the content

Sugoroku双六

Play backgammon and its relatives with native rules, cube and match scoring, seeded dice and replayable records.

Sugoroku is the Japanese name 双六 for games of tables. About the name

Contents

Reference · Rules, games and records

winKindfunction

The kind of win a game that winner has won by bearing off is: single, gammon or backgammon, before the rules say what they count for.

Import it

import { winKind } from "@johnmorrisdotca/sugoroku";

Definition

function winKind(game: GameState, winner: Side): WinKind

Parameters

NameTypeDescription
gameGameState

The current immutable native game state.

winnerSide

The side whose win kind is evaluated.

Returns

WinKind

The kind of win a game that winner has won by bearing off is: single, gammon or backgammon, before the rules say what they count for.

Examples

import { newGame, rollOpening, settingsFor, winKind } from "@johnmorrisdotca/sugoroku";

const settings = settingsFor("backgammon",{points:5,cube:true});
const game = rollOpening(newGame(settings),[3,1]);
console.log(winKind(game,"white"));
backgammon

What it prints (run when this page was built)

View sourceEdit on GitHubMade from the source of @johnmorrisdotca/sugoroku 1.1.1.