tsgammon-core/Score.d.ts

A Backgammon library for Typescript, formerly developed as a part of tsgammon-ui

/**
 * ポイントマッチにおける、赤白両者の累計点、または１回のゲームでの得点を表す。
 *
 * 後者の場合、得点しなかった側は0点である想定だが、特に制約は設けていない。
 */
export declare type Score = {
    whiteScore: number;
    redScore: number;
    /**
     * 得点を加算した結果を返す
     * @param score 得点
     */
    add(score: Score): Score;
    /**
     * 両者の点数の合計を返す。
     * 得点として用いる場合（すなわちいずれかがvalue点でもう一方が0点）の、数値表現として使用する。
     */
    value: number;
};
/**
 * 赤の得点を生成する
 * @param n 赤の得点
 * @returns
 */
export declare function scoreAsRed(n: number): Score;
/**
 * 白の得点を生成する
 * @param n 白の点数
 * @returns
 */
export declare function scoreAsWhite(n: number): Score;
/**
 * 任意の内容の累計点を生成する
 * @param value 累計点
 * @returns
 */
export declare function score(value?: {
    redScore?: number;
    whiteScore?: number;
}): Score;
//# sourceMappingURL=Score.d.ts.map