tsgammon-core/records/GameRecord.d.ts

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

import { PlyStateRecord } from './PlyStateRecord';
import { Score } from '../Score';
import { PlyRecordEoG } from './PlyRecord';
import { MatchState } from '../MatchState';
/**
 * 1ゲーム分、すなわちオープニングロールからゲームが終局するまでの記録。
 *
 * ゲームが終局しているか進行中かを別々の型として区別するのが主な役割で、
 * 実質的には、各手番とその時点の局面とを表すPlyStateRecordの配列と、累計点を保持するに過ぎない。
 *
 * @template T 手番に紐づけて保持される、局面を表す任意のオブジェクトの型
 */
export declare type GameRecord<T> = GameRecordEoG<T> | GameRecordInPlay<T>;
/**
 * 終局したゲームの記録
 */
export declare type GameRecordEoG<T> = _GameRecord<T> & {
    eogRecord: PlyRecordEoG;
    isEoG: true;
    isEoM: boolean;
};
/**
 * 進行中のゲームの記録
 */
export declare type GameRecordInPlay<T> = _GameRecord<T> & {
    isEoG: false;
};
declare type _GameRecord<T> = {
    scoreBefore: Score;
    plyRecords: PlyStateRecord<T>[];
    isCrawford: boolean;
};
/**
 * 開始直後の状態のゲームの記録を生成する
 *
 * @param matchState 開始時点のマッチ状態
 * @returns 進行中のゲームの記録
 */
export declare function gameRecordInPlay<T>(matchState: MatchState): GameRecordInPlay<T>;
/**
 * 進行中のゲームの記録にゲームの結果の記録を追加して、終局後のゲームの記録を生成する
 *
 * @param curGameRecord 進行中のゲーム
 * @param eogRecord ゲームの結果の記録
 * @param isEoM このゲームでマッチが決着したならtrue
 * @returns 生成された終局後のゲームの記録
 */
export declare function gameRecordEoG<T>(curGameRecord: GameRecordInPlay<T>, eogRecord: PlyRecordEoG, isEoM: boolean): GameRecordEoG<T>;
export {};
//# sourceMappingURL=GameRecord.d.ts.map