Class Shogi

将棋盤を管理するクラス

Hierarchy

Shogi

Index

Constructors

constructor

new Shogi(setting?: ISettingType): Shogi
Parameters
- Optional setting: ISettingType
Returns Shogi
- Defined in shogi.ts:54

Properties

board

board: Piece[][]

盤面

flagEditMode

flagEditMode: boolean

編集モードかどうか

hands

hands: Piece[][]

持ち駒

turn

turn: Color

次の手番

Methods

`Private` capture

capture(x: number, y: number): void
(x, y)の駒を取って反対側の持ち駒に加える
Parameters
- x: number
- y: number
Returns void
- Defined in shogi.ts:406

captureByColor

captureByColor(x: number, y: number, color: Color): void
(x, y)の駒を取ってcolorの持ち駒に加える
Parameters
- x: number
- y: number
- color: Color
Returns void
- Defined in shogi.ts:348

`Private` checkTurn

checkTurn(color: Color): void
colorの手番で問題ないか確認する．編集モードならok．
Parameters
- color: Color
Returns void
- Defined in shogi.ts:460

drop

drop(tox: number, toy: number, kind: "FU" | "KY" | "KE" | "GI" | "KI" | "KA" | "HI" | "OU" | "TO" | "NY" | "NK" | "NG" | "UM" | "RY", color?: Color): void
(tox, toy)へcolorの持ち駒のkindを打つ．
Parameters
- tox: number
- toy: number
- kind: "FU" | "KY" | "KE" | "GI" | "KI" | "KA" | "HI" | "OU" | "TO" | "NY" | "NK" | "NG" | "UM" | "RY"
- color: Color = ...
Returns void
- Defined in shogi.ts:176

editMode

editMode(flag: boolean): void
編集モード切り替え
- 通常モード：移動時に手番と移動可能かどうかチェックし，移動可能範囲は手番側のみ返す．
- 編集モード：移動時に手番や移動可能かはチェックせず，移動可能範囲は両者とも返す．
Parameters
- flag: boolean
Returns void
- Defined in shogi.ts:97

flip

flip(x: number, y: number): boolean
(x, y)の駒をフリップする(先手→先手成→後手→後手成→) 成功したらtrueを返す
Parameters
- x: number
- y: number
Returns boolean
- Defined in shogi.ts:365

get

get(x: number, y: number): Piece
(x, y)の駒を得る
Parameters
- x: number
- y: number
Returns Piece
- Defined in shogi.ts:320

getDropsBy

getDropsBy(color: Color): IMove[]
colorが打てる動きを全て得る
Parameters
- color: Color
Returns IMove[]
- Defined in shogi.ts:259

getHandsSummary

getHandsSummary(color: Color): HandSummary
keyを種類，valueを枚数とするオブジェクトとして持ち駒の枚数一覧を返す．
Parameters
- color: Color
Returns HandSummary
- Defined in shogi.ts:327

getMovesFrom

getMovesFrom(x: number, y: number): IMove[]
(x, y)の駒の移動可能な動きをすべて得る盤外，自分の駒取りは除外．二歩，王手放置などはチェックせず．
Parameters
- x: number
- y: number
Returns IMove[]
- Defined in shogi.ts:211

getMovesTo

getMovesTo(x: number, y: number, kind: "FU" | "KY" | "KE" | "GI" | "KI" | "KA" | "HI" | "OU" | "TO" | "NY" | "NK" | "NG" | "UM" | "RY", color?: Color): IMove[]
(x, y)に行けるcolor側のkindの駒の動きを得る
Parameters
- x: number
- y: number
- kind: "FU" | "KY" | "KE" | "GI" | "KI" | "KA" | "HI" | "OU" | "TO" | "NY" | "NK" | "NG" | "UM" | "RY"
- color: Color = ...
Returns IMove[]
- Defined in shogi.ts:299

initialize

initialize(setting?: ISettingType): void
盤面を初期化する
Parameters
- setting: ISettingType = ...
  
  初期局面(なければ平手)
Returns void
- Defined in shogi.ts:62

initializeFromSFENString

initializeFromSFENString(sfen: string): void
SFENによる盤面表現の文字列で盤面を初期化する
Parameters
- sfen: string
Returns void
- Defined in shogi.ts:71

move

move(fromx: number, fromy: number, tox: number, toy: number, promote?: boolean): void
(fromx, fromy)から(tox, toy)へ移動し，promoteなら成り，駒を取っていれば持ち駒に加える．．
Parameters
- fromx: number
- fromy: number
- tox: number
- toy: number
- promote: boolean = false
Returns void
- Defined in shogi.ts:104

`Private` nextTurn

nextTurn(): void
次の手番に行く

Returns void
- Defined in shogi.ts:440

`Private` popFromHand

popFromHand(kind: "FU" | "KY" | "KE" | "GI" | "KI" | "KA" | "HI" | "OU" | "TO" | "NY" | "NK" | "NG" | "UM" | "RY", color: Color): Piece
color側のkindの駒を取って返す
Parameters
- kind: "FU" | "KY" | "KE" | "GI" | "KI" | "KA" | "HI" | "OU" | "TO" | "NY" | "NK" | "NG" | "UM" | "RY"
- color: Color
Returns Piece
- Defined in shogi.ts:424

`Private` prevTurn

prevTurn(): void
前の手番に行く

Returns void
- Defined in shogi.ts:450

`Private` pushToHand

pushToHand(piece: Piece): void
駒pieceを持ち駒に加える
Parameters
- piece: Piece
Returns void
- Defined in shogi.ts:417

`Private` set

set(x: number, y: number, piece: Piece): void
(x, y)に駒を置く
Parameters
- x: number
- y: number
- piece: Piece
Returns void
- Defined in shogi.ts:399

setTurn

setTurn(color: Color): void
手番を設定する
Parameters
- color: Color
Returns void
- Defined in shogi.ts:387

toCSAString

toCSAString(): string
CSAによる盤面表現の文字列を返す

Returns

Returns string
- Defined in shogi.ts:79

toSFENString

toSFENString(moveCount?: number): string
SFENによる盤面表現の文字列を返す

Returns
Parameters
- moveCount: number = 1
Returns string
- Defined in shogi.ts:88

undrop

undrop(tox: number, toy: number): void
dropの逆を行う，つまり(tox, toy)の駒を駒台に戻す．
Parameters
- tox: number
- toy: number
Returns void
- Defined in shogi.ts:196

unmove

unmove(fromx: number, fromy: number, tox: number, toy: number, promote?: boolean, capture?: "FU" | "KY" | "KE" | "GI" | "KI" | "KA" | "HI" | "OU" | "TO" | "NY" | "NK" | "NG" | "UM" | "RY"): void
moveの逆を行う．つまり(tox, toy)から(fromx, fromy)へ移動し，駒を取っていたら戻し，promoteなら成りを戻す．
Parameters
- fromx: number
- fromy: number
- tox: number
- toy: number
- promote: boolean = false
- Optional capture: "FU" | "KY" | "KE" | "GI" | "KI" | "KA" | "HI" | "OU" | "TO" | "NY" | "NK" | "NG" | "UM" | "RY"
Returns void
- Defined in shogi.ts:139

`Static` `Private` getIllegalUnpromotedRow

getIllegalUnpromotedRow(kind: "FU" | "KY" | "KE" | "GI" | "KI" | "KA" | "HI" | "OU" | "TO" | "NY" | "NK" | "NG" | "UM" | "RY"): 0 | 1 | 2
Parameters
- kind: "FU" | "KY" | "KE" | "GI" | "KI" | "KA" | "HI" | "OU" | "TO" | "NY" | "NK" | "NG" | "UM" | "RY"
Returns 0 | 1 | 2
- Defined in shogi.ts:19

`Static` `Private` getRowToOppositeEnd

getRowToOppositeEnd(y: number, color: Color): number
手番の相手側から数えた段数
Parameters
- y: number
- color: Color
Returns number
- Defined in shogi.ts:34

Class Shogi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional setting: ISettingType

Returns Shogi

Properties

board

flagEditMode

hands

turn

Methods

Private capture

Parameters

x: number

y: number

Returns void

captureByColor

Parameters

x: number

y: number

color: Color

Returns void

Private checkTurn

Parameters

color: Color

Returns void

drop

Parameters

tox: number

toy: number

kind: "FU" | "KY" | "KE" | "GI" | "KI" | "KA" | "HI" | "OU" | "TO" | "NY" | "NK" | "NG" | "UM" | "RY"

color: Color = ...

Returns void

editMode

Parameters

flag: boolean

Returns void

flip

Parameters

x: number

y: number

Returns boolean

get

Parameters

x: number

y: number

Returns Piece

getDropsBy

Parameters

color: Color

Returns IMove[]

getHandsSummary

Parameters

color: Color

Returns HandSummary

getMovesFrom

Parameters

x: number

y: number

Returns IMove[]

getMovesTo

Parameters

x: number

y: number

kind: "FU" | "KY" | "KE" | "GI" | "KI" | "KA" | "HI" | "OU" | "TO" | "NY" | "NK" | "NG" | "UM" | "RY"

color: Color = ...

Returns IMove[]

initialize

Parameters

setting: ISettingType = ...

Returns void

initializeFromSFENString

Parameters

sfen: string

`Optional` setting: ISettingType

`Private` capture

`Private` checkTurn

`Private` nextTurn

`Private` popFromHand

`Private` prevTurn

`Private` pushToHand

`Private` set

`Optional` capture: "FU" | "KY" | "KE" | "GI" | "KI" | "KA" | "HI" | "OU" | "TO" | "NY" | "NK" | "NG" | "UM" | "RY"

`Static` `Private` getIllegalUnpromotedRow

`Static` `Private` getRowToOppositeEnd