tsgammon-core/CubeState.d.ts

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

/**
 * キューブの所有者を表す
 */
export declare enum CubeOwner {
    WHITE = 1,
    RED = 2
}
/**
 * キューブの状態
 */
export declare type CubeState = {
    /**
     * キューブの現在の値
     */
    value: number;
    /**
     * キューブがどちらの側にあるか。未ダブルの場合はundefined
     */
    owner?: CubeOwner;
    /**
     * キューブの最大値
     * @param
     */
    max: number;
    /**
     * キューブの最大値に達した (これ以上ダブルできない)ならtrue
     */
    isMax: boolean;
    /**
     * ダブル後の状態のキューブを生成する
     * @param newOwner 新たなキューブの所有者、すなわちダブルをかけられた側
     */
    double(newOwner: CubeOwner): CubeState;
    /**
     * ダブル後のキューブの値を返す（すなわち、現在の値の2倍）
     */
    doubledValue: number;
    /**
     * 指定された側がダブルできるかどうか
     * @param side ダブルしようとしている側（赤か白）
     */
    mayDoubleFor(side: CubeOwner): boolean;
};
/**
 * 新たにCubeを生成する
 *
 * @param value キューブの値
 * @param owner キューブの所有者
 * @param max キューブの最大値
 * @returns
 */
export declare function cube(value: number, owner?: CubeOwner, max?: number): CubeState;
//# sourceMappingURL=CubeState.d.ts.map