Reference · Rules, games and records
Matchtype
A MATCH: games played one after another to a number of points, or without end in money play. It keeps the score and says which game is the Crawford game. Like everything here it is plain data, and never changed: each function gives back a new match.
Import it
import type { Match } from "@johnmorrisdotca/sugoroku";
Definition
type Match = {
readonly settings: Settings;
readonly score: readonly [
number,
number
];
readonly results: readonly GameResult[];
readonly crawfordNext: boolean;
readonly crawfordPlayed: boolean;
readonly over: boolean;
readonly winner: Side | null;
};
Members
| Name | Type | Description |
|---|---|---|
settings | Settings | |
score | readonly [number, number] | The score, |
results | readonly GameResult[] | Every game finished so far. |
crawfordNext | boolean | Whether the next game is the Crawford game. |
crawfordPlayed | boolean | Whether the Crawford game has been played: there is one in a match. |
over | boolean | Whether the match is decided: a side reached the match length, or a game was drawn. Never in money play. |
winner | Side | null | Who won the match; null while it goes on, or when it was drawn. |
Examples
import { newMatch, settingsFor } from "@johnmorrisdotca/sugoroku";
import type { Match } from "@johnmorrisdotca/sugoroku";
const settings = settingsFor("backgammon",{points:5,cube:true});
const match = newMatch(settings);
const value: Match = match;
console.log(value);{
settings: {
variant: {
checkers: 15,
dice: 2,
doubles: 'four',
direction: 'opposed',
opening: 'roll-off',
goal: 'first-off',
holdBelow: 0,
drawAfter: 0,
key: 'backgammon',
layout: [Array]
},
rules: {
points: 5,
cube: true,
crawford: true,
jacoby: false,
beaver: false,
gammons: false
}
},
score: [ 0, 0 ],
results: [],
crawfordNext: false,
crawfordPlayed: false,
over: false,
winner: null
}What it prints (run when this page was built)