tsgammon-core/utils/formatAbsMove.d.ts

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

import { AbsoluteMove } from '../AbsoluteMove';
/**
 * 駒の移動の表記方法の指定
 */
export declare enum MoveFormatDirection {
    /**  Whiteは開始点を0とし、増加方向に駒を進める表記。Redは24から減少方向に進む */
    ABSOLUTE = 1,
    /** ABSOLUTEを反転させ、Redの開始点を0とする表記 */
    ABSOLUTE_INV = 2,
    /** WhiteもRedも開始点を0とし、増加方向に駒を進める表記 */
    RELATIVE_ASC = 3,
    /**  RELATIVE_ASCを反転させ、開始点を24とする表記 */
    RELATIVE_DEC = 4
}
/**
 * ムーブ1つを文字列表現に変換する。
 *
 * ※連続するムーブ（e.g. 1/3 3/4 を1/3/4または1/4とまとめる機能は未実装）
 *
 * @param move 対象ムーブ
 * @param direction 表記方法
 * @returns 変換後の文字列
 */
export declare function formatAbsMove(move: AbsoluteMove, direction?: MoveFormatDirection): string;
/**
 * ムーブの配列を文字列表現、またはムーブなしの表記の配列に変換する
 *
 * ※連続するムーブ（e.g. 1/3 3/4 を1/3/4または1/4とまとめる機能は未実装）
 *
 * @param move 対象ムーブ
 * @param direction 表記方法
 * @param labelNoMove ムーブがない（空配列が渡された場合）の表記
 * @returns 各ムーブを変換した文字列の配列
 */
export declare function formatAbsMoves(moves: AbsoluteMove[], direction?: MoveFormatDirection, labelNoMove?: string): string[];
//# sourceMappingURL=formatAbsMove.d.ts.map