Class JKFPlayer

Hierarchy

JKFPlayer

Constructors

constructor

new JKFPlayer(kifu: IJSONKifuFormat): JKFPlayer
Parameters
- kifu: IJSONKifuFormat
Returns JKFPlayer
- Defined in json-kifu-format/src/jkfplayer.ts:248

Properties

`Private` currentStream_

currentStream_: IMoveFormat[] = null

forkPointers

forkPointers: ForkPointer[] = []

`Private` forks_

forks_: any = null

kifu

kifu: IJSONKifuFormat

shogi

shogi: Shogi

tesuu

tesuu: number

`Static` debug

debug: boolean = false

`Static` logs

logs: any[] = []

Accessors

currentStream

get currentStream(): IMoveFormat[]
Returns IMoveFormat[]
- Defined in json-kifu-format/src/jkfplayer.ts:241

forks

get forks(): {
moves: IMoveFormat[];
te: number;
}[]
Returns {
moves: IMoveFormat[];
te: number;
}[]
- Defined in json-kifu-format/src/jkfplayer.ts:234

Methods

backward

backward(): boolean
Returns boolean
- Defined in json-kifu-format/src/jkfplayer.ts:290

`Private` doMove

doMove(move: IMoveMoveFormat): void
Parameters
- move: IMoveMoveFormat
Returns void
- Defined in json-kifu-format/src/jkfplayer.ts:556

forkAndForward

forkAndForward(num: string | number): boolean
Parameters
- num: string | number
Returns boolean
- Defined in json-kifu-format/src/jkfplayer.ts:371

forward

forward(): boolean
Returns boolean
- Defined in json-kifu-format/src/jkfplayer.ts:274

getBoard

getBoard(x: number, y: number): Piece
Parameters
- x: number
- y: number
Returns Piece
- Defined in json-kifu-format/src/jkfplayer.ts:475

getComments

getComments(tesuu?: number): string[]
Parameters
- tesuu: number = ...
Returns string[]
- Defined in json-kifu-format/src/jkfplayer.ts:479

getForkPointers

getForkPointers(tesuu?: number): ForkPointer[]
Parameters
- Optional tesuu: number
Returns ForkPointer[]
- Defined in json-kifu-format/src/jkfplayer.ts:398

getMaxTesuu

getMaxTesuu(): number
Returns number
- Defined in json-kifu-format/src/jkfplayer.ts:498

getMove

getMove(tesuu?: number): IMoveMoveFormat
Parameters
- tesuu: number = ...
Returns IMoveMoveFormat
- Defined in json-kifu-format/src/jkfplayer.ts:483

`Private` getMoveFormat

getMoveFormat(tesuu?: number): IMoveFormat
Parameters
- tesuu: number = ...
Returns IMoveFormat
- Defined in json-kifu-format/src/jkfplayer.ts:547

`Private` getNextFork

getNextFork(tesuu?: number): IMoveFormat[][]
Parameters
- tesuu: number = ...
Returns IMoveFormat[][]
- Defined in json-kifu-format/src/jkfplayer.ts:551

getReadableForkKifu

getReadableForkKifu(tesuu?: number): string[]
Parameters
- tesuu: number = ...
Returns string[]
- Defined in json-kifu-format/src/jkfplayer.ts:494

getReadableKifu

getReadableKifu(tesuu?: number): string
Parameters
- tesuu: number = ...
Returns string
- Defined in json-kifu-format/src/jkfplayer.ts:487

getReadableKifuState

getReadableKifuState(): {
    comments: string[];
    forks: string[];
    kifu: string;
    moveFormat: IMoveFormat;
}[]
Returns {
    comments: string[];
    forks: string[];
    kifu: string;
    moveFormat: IMoveFormat;
}[]
- Defined in json-kifu-format/src/jkfplayer.ts:511

getState

getState(): IStateFormat
Returns IStateFormat
- Defined in json-kifu-format/src/jkfplayer.ts:507

getTesuuPointer

getTesuuPointer(tesuu?: number): string
Return a tesuu pointer string which can be used to call goto()
Parameters
- Optional tesuu: number
Returns string
- Defined in json-kifu-format/src/jkfplayer.ts:391

go

go(tesuu: string | number): void
Parameters
- tesuu: string | number
Returns void
- Defined in json-kifu-format/src/jkfplayer.ts:360

goto

goto(tesuu: number, forkPointers?: ForkPointer[]): void
Parameters
- tesuu: number
- Optional forkPointers: ForkPointer[]
Returns void
- Defined in json-kifu-format/src/jkfplayer.ts:304
goto(tesuuPointer: string): void
Parameters
- tesuuPointer: string
Returns void
- Defined in json-kifu-format/src/jkfplayer.ts:305

initialize

initialize(kifu: IJSONKifuFormat): void
Parameters
- kifu: IJSONKifuFormat
Returns void
- Defined in json-kifu-format/src/jkfplayer.ts:253

inputMove

inputMove(move: IMoveMoveFormat): boolean
Parameters
- move: IMoveMoveFormat
Returns boolean
- Defined in json-kifu-format/src/jkfplayer.ts:411

toJKF

toJKF(): string
Returns string
- Defined in json-kifu-format/src/jkfplayer.ts:502

`Private` undoMove

undoMove(move: IMoveMoveFormat): void
Parameters
- move: IMoveMoveFormat
Returns void
- Defined in json-kifu-format/src/jkfplayer.ts:560

`Private` updateForksAndCurrentStream

updateForksAndCurrentStream(): void
Returns void
- Defined in json-kifu-format/src/jkfplayer.ts:530

`Static` doMove

doMove(shogi: Shogi, move: IMoveMoveFormat): void
Parameters
- shogi: Shogi
- move: IMoveMoveFormat
Returns void
- Defined in json-kifu-format/src/jkfplayer.ts:156

`Static` fromShogi

fromShogi(shogi: Shogi): JKFPlayer
Parameters
- shogi: Shogi
Returns JKFPlayer
- Defined in json-kifu-format/src/jkfplayer.ts:259

`Static` `Private` getBoardState

getBoardState(shogi: Shogi): any[]
Parameters
- shogi: Shogi
Returns any[]
- Defined in json-kifu-format/src/jkfplayer.ts:210

`Static` `Private` getHandsState

getHandsState(shogi: Shogi): [IHandFormat, IHandFormat]
Parameters
- shogi: Shogi
Returns [IHandFormat, IHandFormat]
- Defined in json-kifu-format/src/jkfplayer.ts:223

`Static` getState

getState(shogi: Shogi): IStateFormat
Parameters
- shogi: Shogi
Returns IStateFormat
- Defined in json-kifu-format/src/jkfplayer.ts:190

`Static` kindToKan

kindToKan(kind: "FU" | "KY" | "KE" | "GI" | "KI" | "KA" | "HI" | "OU" | "TO" | "NY" | "NK" | "NG" | "UM" | "RY"): string
Parameters
- kind: "FU" | "KY" | "KE" | "GI" | "KI" | "KA" | "HI" | "OU" | "TO" | "NY" | "NK" | "NG" | "UM" | "RY"
Returns string
- Defined in json-kifu-format/src/jkfplayer.ts:98

`Static` log

log(...lg: any[]): void
Parameters
- Rest ...lg: any[]
Returns void
- Defined in json-kifu-format/src/jkfplayer.ts:21

`Static` moveToReadableKifu

moveToReadableKifu(mv: IMoveFormat): string
Parameters
- mv: IMoveFormat
Returns string
- Defined in json-kifu-format/src/jkfplayer.ts:135

`Static` numToKan

numToKan(n: number): string
Parameters
- n: number
Returns string
- Defined in json-kifu-format/src/jkfplayer.ts:94

`Static` numToZen

numToZen(n: number): string
Parameters
- n: number
Returns string
- Defined in json-kifu-format/src/jkfplayer.ts:90

`Static` parse

parse(kifu: string, filename?: string): JKFPlayer
Parameters
- kifu: string
- Optional filename: string
Returns JKFPlayer
- Defined in json-kifu-format/src/jkfplayer.ts:29

`Static` parseCSA

parseCSA(kifu: string): JKFPlayer
Parameters
- kifu: string
Returns JKFPlayer
- Defined in json-kifu-format/src/jkfplayer.ts:85

`Static` parseJKF

parseJKF(kifu: string): JKFPlayer
Parameters
- kifu: string
Returns JKFPlayer
- Defined in json-kifu-format/src/jkfplayer.ts:70

`Static` parseKI2

parseKI2(kifu: string): JKFPlayer
Parameters
- kifu: string
Returns JKFPlayer
- Defined in json-kifu-format/src/jkfplayer.ts:80

`Static` parseKIF

parseKIF(kifu: string): JKFPlayer
Parameters
- kifu: string
Returns JKFPlayer
- Defined in json-kifu-format/src/jkfplayer.ts:75

`Static` relativeToKan

relativeToKan(relative: string): string
Parameters
- relative: string
Returns string
- Defined in json-kifu-format/src/jkfplayer.ts:102

`Static` sameMoveMinimal

sameMoveMinimal(move1: Partial<IMoveMoveFormat>, move2: Partial<IMoveMoveFormat>): boolean
Parameters
- move1: Partial<IMoveMoveFormat>
- move2: Partial<IMoveMoveFormat>
Returns boolean
- Defined in json-kifu-format/src/jkfplayer.ts:198

`Static` specialToKan

specialToKan(special: string): string
Parameters
- special: string
Returns string
- Defined in json-kifu-format/src/jkfplayer.ts:114

`Static` undoMove

undoMove(shogi: Shogi, move: IMoveMoveFormat): void
Parameters
- shogi: Shogi
- move: IMoveMoveFormat
Returns void
- Defined in json-kifu-format/src/jkfplayer.ts:172

Generated using TypeDoc