Class default

Hierarchy

default

Index

Constructors

constructor

Accessors

currentGameSide currentLivePieceList currentRadius winnerSide

Constructors

constructor

new default(inputCfg?: GameInfo): default
Parameters
- Optional inputCfg: GameInfo
Returns default
- Defined in src/index.ts:260

Properties

`Protected` animate

animate: ((cb: FrameRequestCallback) => number)

Type declaration

- (cb: FrameRequestCallback): number
- 动画方法
  Parameters
  - cb: FrameRequestCallback
  Returns number

`Protected` blackPeiceBackground

blackPeiceBackground: string

黑色棋子背景颜色

`Protected` blackPeiceTextColor

blackPeiceTextColor: string

黑棋子字体颜色

Default Value

#000

`Protected` boardTextColor

boardTextColor: string

棋盘线条颜色

Default Value

#000

`Protected` cancelAnimate

cancelAnimate: ((hander: number) => void)

Type declaration

- (hander: number): void
- 清除动画方法
  Parameters
  - hander: number
  Returns void

`Protected` checkerboardBackground

checkerboardBackground: string

棋盘背景颜色

`Protected` choosePeiceBorderColor

choosePeiceBorderColor: string

选中的棋子边框颜色

`Protected` choosePiece

choosePiece: null | ChessOfPeice

当前选中的棋子

`Protected` `Optional` ctx

ctx?: CanvasRenderingContext2D

背景和线条二维操作上下文

`Protected` currentSide

currentSide: PieceSide

当前走棋方

`Protected` drawMovePoint

drawMovePoint: boolean

duration

duration: number

棋子运动速度时长毫秒单位

`Protected` endX

endX: number

棋盘绘制末尾 x 值

`Protected` endY

endY: number

棋盘绘制末尾 y 值

`Protected` errorEvents

errorEvents: GameErrorCallback[]

游戏运行报错事件列表

`Protected` gameSide

gameSide: null | PieceSide = null

当前游戏方

`Protected` gameState

gameState: GameState

游戏进行状态

`Protected` gridDiffX

gridDiffX: GamePeiceGridDiffX

玩家 x轴格子距离相差

`Protected` gridDiffY

gridDiffY: GamePeiceGridDiffY

玩家 y轴格子距离相差

`Protected` gridHeight

gridHeight: number

象棋格子高度

`Protected` gridPostionList

gridPostionList: Point[]

存放棋盘格子的所有坐标

`Protected` gridWidth

gridWidth: number

象棋格子宽度

`Protected` height

height: number

游戏窗口高度

`Protected` lastMovePiece

lastMovePiece: undefined | ChessOfPeice

上次移动象棋：棋盘上的上一次移动棋子

`Protected` lastMovePoint

lastMovePoint: undefined | Point

上次移动点：棋盘上移动棋子移动前的位置坐标点

`Protected` livePieceList

livePieceList: PieceList

当前棋盘上存活的棋子

`Protected` logEvents

logEvents: GameLogCallback[]

游戏日志监听事件列表

`Protected` moveEvents

moveEvents: MoveCallback[]

游戏移动监听事件列表

`Protected` moveFailEvents

moveFailEvents: MoveFailCallback[]

游戏移动失败监听事件列表

`Protected` movePointColor

movePointColor: string

`Protected` overEvents

overEvents: GameOverCallback[]

游戏结束监听事件列表

`Protected` radius

radius: number

象棋半径

`Protected` redPeiceBackground

redPeiceBackground: string

红色棋子背景颜色

`Protected` redPeiceTextColor

redPeiceTextColor: string

红棋子字体颜色

Default Value

#c1190c

`Protected` scaleRatio

scaleRatio: number

画布缩放大小

Default Value

1

`Protected` startX

startX: number

棋盘绘制起始 x 值

`Protected` startY

startY: number

棋盘绘制起始 y 值

`Protected` width

width: number

游戏窗口高度

`Protected` winner

winner: null | PieceSide = null

赢方

Accessors

currentGameSide

get currentGameSide(): null | PieceSide
获取游戏方

Returns null | PieceSide
- Defined in src/index.ts:1077
set currentGameSide(val: any): void
Parameters
- val: any
Returns void
- Defined in src/index.ts:1080

currentLivePieceList

get currentLivePieceList(): PieceList
获取当前存活的棋子列表

Returns PieceList
- Defined in src/index.ts:1086

currentRadius

get currentRadius(): number
获取当前象棋绘制半径

Returns number
- Defined in src/index.ts:1094

winnerSide

get winnerSide(): null | PieceSide
获取赢棋方

Returns null | PieceSide
- Defined in src/index.ts:1071

Methods

changeCurrentPlaySide

changeCurrentPlaySide(side: PieceSide): void
更改当前走棋方
Parameters
- side: PieceSide
  
  走棋方
Returns void
- Defined in src/index.ts:856

changePlaySide

changePlaySide(side: PieceSide): void
更换玩家视角
Parameters
- side: PieceSide
  
  玩家
Returns void
- Defined in src/index.ts:847

`Protected` changeSide

changeSide(): void
更换当前运行玩家

Returns void
- Defined in src/index.ts:840

checkDraw

checkDraw(): void
检查是否有画布有会更新画布否则不更新报出错误

Returns void
- Defined in src/index.ts:1007

`Protected` checkEnemySideHasMovePoints

checkEnemySideHasMovePoints(enemySide: PieceSide, pl: PieceList): boolean
判断敌方是否还有下一步走法无走法就是绝杀

Returns
Parameters
- enemySide: PieceSide
  
  敌方
- pl: PieceList
Returns boolean
- Defined in src/index.ts:953

`Protected` checkEnemySideInTroubleHasSolution

checkEnemySideInTroubleHasSolution(enemySide: PieceSide, pl: PieceList): boolean
判断敌方被将军时，是否有解

Returns
返回是否有解
Parameters
- enemySide: PieceSide
  
  敌方
- pl: PieceList
  
  当前棋盘列表
Returns boolean
- Defined in src/index.ts:931

checkGameState

checkGameState(): MoveResult
棋子运动前检查游戏状态是否可以运动

Returns
是否可以运动

Returns MoveResult
- Defined in src/index.ts:981

`Protected` checkGeneralInTrouble

checkGeneralInTrouble(side: PieceSide, pos: ChessOfPeice, cp: CheckPoint, pl: PieceList): boolean
根据某方移动棋子判断自己将领是否安全

Returns
是否安全
Parameters
- side: PieceSide
  
  移动方
- pos: ChessOfPeice
  
  移动棋子
- cp: CheckPoint
  
  是去吃棋子还是移动棋子
- pl: PieceList
  
  当前棋盘列表
Returns boolean
- Defined in src/index.ts:873

`Protected` checkGeneralsFaceToFaceInTrouble

checkGeneralsFaceToFaceInTrouble(pl: PieceList): boolean
检查棋子移动双方将领在一条直线上 false 不危险 true 危险

Returns
是否危险
Parameters
- pl: PieceList
  
  假设移动后的棋子列表
Returns boolean
- Defined in src/index.ts:910

`Protected` clearMoveChoosePeiece

clearMoveChoosePeiece(): void
清除移动完选中的棋子

Returns void
- Defined in src/index.ts:830

draw

draw(ctx: CanvasRenderingContext2D): void
根据当前棋子状态绘画棋盘状态游戏数据画出布局
Parameters
- ctx: CanvasRenderingContext2D
  
  画布
Returns void
- Defined in src/index.ts:602

`Protected` drawChessLine

drawChessLine(ctx: CanvasRenderingContext2D): void
画棋盘
Parameters
- ctx: CanvasRenderingContext2D
Returns void
- Defined in src/index.ts:634

drawLastMovePoint

drawLastMovePoint(ctx: CanvasRenderingContext2D): void
绘画上次移动点，可自行重写该函数
Parameters
- ctx: CanvasRenderingContext2D
  
  canvas 2d 渲染上下文
Returns void
- Defined in src/index.ts:1182

gameOver

gameOver(): boolean
游戏是否结束

Returns boolean
- Defined in src/index.ts:862

gameStart

gameStart(side: PieceSide): void
初始化选择玩家方
Parameters
- side: PieceSide
  
  玩家方
Returns void
- Defined in src/index.ts:817

getCurrentPenCode

getCurrentPenCode(side: PieceSide): string
Parameters
- side: PieceSide
Returns string
- Defined in src/index.ts:1097

`Protected` getGridDiff

getGridDiff(side: PieceSide, key: "y" | "x"): 0 | 8 | 9
根据玩家返回绘画坐标轴的差值

Returns
Parameters
- side: PieceSide
  
  玩家
- key: "y" | "x"
  
  坐标轴
Returns 0 | 8 | 9
- Defined in src/index.ts:346

`Protected` getGridPosition

getGridPosition(p: Point): undefined | Point
根据点击点返回所在棋盘上x,y的位置

Returns
返回棋盘的x，y坐标轴
Parameters
- p: Point
  
  点击点的 x,y 坐标
Returns undefined | Point
- Defined in src/index.ts:380

`Protected` init

init(): void
初始化象棋盘

Returns void
- Defined in src/index.ts:391

`Protected` initPiece

initPiece(): void
初始化象棋个数

Returns void
- Defined in src/index.ts:400

listenClick

listenClick(e: MouseEvent): void
监听棋盘点击
Parameters
- e: MouseEvent
Returns void
- Defined in src/index.ts:1022

listenClickAsync

listenClickAsync(e: MouseEvent): void
监听棋盘点击
Parameters
- e: MouseEvent
Returns void
- Defined in src/index.ts:1044

moveStr

moveStr(str: string, side: PieceSide): UpdateResult
根据移动方的描述文字来进行移动棋子

Returns
移动结果
Parameters
- str: string
  
  文字
- side: PieceSide
  
  移动方
Returns UpdateResult
- Defined in src/index.ts:759

moveStrAsync

moveStrAsync(str: string, side: PieceSide, refreshCtx: boolean): Promise<UpdateResult>
根据移动方的描述文字来进行移动棋子

Returns
移动结果
Parameters
- str: string
  
  文字
- side: PieceSide
  
  移动方
- refreshCtx: boolean
  
  是否每次移动都更新画布
Returns Promise<UpdateResult>
- Defined in src/index.ts:792

on

on(e: "move", fn: MoveCallback): void
象棋事件监听
Parameters
- e: "move"
  
  监听事件
- fn: MoveCallback
  
  监听函数
Returns void
- Defined in src/index.ts:1101
on(e: "moveFail", fn: MoveFailCallback): void
象棋事件监听
Parameters
- e: "moveFail"
  
  监听事件
- fn: MoveFailCallback
  
  监听函数
Returns void
- Defined in src/index.ts:1102
on(e: "log", fn: GameLogCallback): void
象棋事件监听
Parameters
- e: "log"
  
  监听事件
- fn: GameLogCallback
  
  监听函数
Returns void
- Defined in src/index.ts:1103
on(e: "over", fn: GameOverCallback): void
象棋事件监听
Parameters
- e: "over"
  
  监听事件
- fn: GameOverCallback
  
  监听函数
Returns void
- Defined in src/index.ts:1104
on(e: "error", fn: GameErrorCallback): void
象棋事件监听
Parameters
- e: "error"
  
  监听事件
- fn: GameErrorCallback
  
  监听函数
Returns void
- Defined in src/index.ts:1105

removeEvent

removeEvent(e: "move", fn: MoveCallback): void
移除象棋事件监听
Parameters
- e: "move"
  
  监听事件
- fn: MoveCallback
  
  监听函数
Returns void
- Defined in src/index.ts:1128
removeEvent(e: "moveFail", fn: MoveFailCallback): void
移除象棋事件监听
Parameters
- e: "moveFail"
  
  监听事件
- fn: MoveFailCallback
  
  监听函数
Returns void
- Defined in src/index.ts:1129
removeEvent(e: "log", fn: GameLogCallback): void
移除象棋事件监听
Parameters
- e: "log"
  
  监听事件
- fn: GameLogCallback
  
  监听函数
Returns void
- Defined in src/index.ts:1130
removeEvent(e: "over", fn: GameOverCallback): void
移除象棋事件监听
Parameters
- e: "over"
  
  监听事件
- fn: GameOverCallback
  
  监听函数
Returns void
- Defined in src/index.ts:1131
removeEvent(e: "error", fn: GameErrorCallback): void
移除象棋事件监听
Parameters
- e: "error"
  
  监听事件
- fn: GameErrorCallback
  
  监听函数
Returns void
- Defined in src/index.ts:1132

`Protected` setGameWindow

setGameWindow(w: number, h: number, p: number): void
设置游戏窗口棋盘棋子大小
Parameters
- w: number
- h: number
- p: number
Returns void
- Defined in src/index.ts:324

`Protected` setGridDiff

setGridDiff(side: PieceSide): void
根据玩家方设置 x，y轴差值
Parameters
- side: PieceSide
  
  玩家方
Returns void
- Defined in src/index.ts:359

`Protected` setGridList

setGridList(): void
获取所有格子的坐标

Returns void
- Defined in src/index.ts:367

`Protected` setLastMovePeiceStatus

setLastMovePeiceStatus(status: boolean): void
设置上次移动状态
Parameters
- status: boolean
Returns void
- Defined in src/index.ts:1199

setLivePieceList

setLivePieceList(pl: PieceList): void
设置当前存活棋子列表
Parameters
- pl: PieceList
  
  当前存活棋子列表
Returns void
- Defined in src/index.ts:1159

setPenCodeList

setPenCodeList(penCode: string): void
根据pen代码格式来设置当前棋盘
Parameters
- penCode: string
  建议参考文章博客
  1. https://www.xqbase.com/protocol/cchess_fen.htm
Returns void
- Defined in src/index.ts:1169

update

update(pos: Point, mov: null | Point, side: PieceSide, post: boolean): UpdateResult
游戏根据坐标点移动点来进行更新游戏运行数据。

Returns
如果 post 为 false，请检查返回的结果 move 是否为 true ，为true表示有返回回调函数cb，只有调用 cb() 游戏状态才会更新

如果 post 为 true，程序会自己更新游戏状态只需要判断是否更新成功即可！
Parameters
- pos: Point
  
  坐标点
- mov: null | Point
  
  移动点
- side: PieceSide
  
  当前下棋玩家
- post: boolean
  
  是否由程序自己更新游戏状态
Returns UpdateResult
- Defined in src/index.ts:481

updateAsync

updateAsync(pos: Point, mov: null | Point, side: PieceSide, refreshCtx: boolean, moveCallback?: UpdateMoveCallback): Promise<UpdateResult>
游戏根据坐标点移动点来进行更新游戏运行数据。这是一个返回一个promise结果，也表示这个方法是异步的。

Example
```
const game = new ZhChess({...any})
game.updateAsync(pos , mov, side, ()=> game.draw(ctx)) // 每次运动都去绘画一次
```
Parameters
- pos: Point
  
  坐标点
- mov: null | Point
  
  移动点
- side: PieceSide
  
  当前下棋玩家
- refreshCtx: boolean
  
  是否每次运动后更新画布
- Optional moveCallback: UpdateMoveCallback
  
  每次棋子数据更新后调用
Returns Promise<UpdateResult>
- Defined in src/index.ts:418

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional inputCfg: GameInfo

Returns default

Properties

Protected animate

Type declaration

Parameters

cb: FrameRequestCallback

Returns number

Protected blackPeiceBackground

Protected blackPeiceTextColor

Default Value

Protected boardTextColor

Default Value

Protected cancelAnimate

Type declaration

Parameters

hander: number

Returns void

Protected checkerboardBackground

Protected choosePeiceBorderColor

Protected choosePiece

Protected Optional ctx

Protected currentSide

Protected drawMovePoint

duration

Protected endX

Protected endY

Protected errorEvents

Protected gameSide

Protected gameState

Protected gridDiffX

Protected gridDiffY

Protected gridHeight

Protected gridPostionList

Protected gridWidth

Protected height

Protected lastMovePiece

Protected lastMovePoint

Protected livePieceList

Protected logEvents

Protected moveEvents

Protected moveFailEvents

Protected movePointColor

Protected overEvents

Protected radius

Protected redPeiceBackground

Protected redPeiceTextColor

Default Value

Protected scaleRatio

Default Value

Protected startX

Protected startY

Protected width

Protected winner

Accessors

currentGameSide

Returns null | PieceSide

Parameters

val: any

Returns void

currentLivePieceList

Returns PieceList

currentRadius

Returns number

winnerSide

Returns null | PieceSide

Methods

changeCurrentPlaySide

Parameters

side: PieceSide

`Optional` inputCfg: GameInfo

`Protected` animate

`Protected` blackPeiceBackground

`Protected` blackPeiceTextColor

`Protected` boardTextColor

`Protected` cancelAnimate

`Protected` checkerboardBackground

`Protected` choosePeiceBorderColor

`Protected` choosePiece

`Protected` `Optional` ctx

`Protected` currentSide

`Protected` drawMovePoint

`Protected` endX

`Protected` endY

`Protected` errorEvents

`Protected` gameSide

`Protected` gameState

`Protected` gridDiffX

`Protected` gridDiffY

`Protected` gridHeight

`Protected` gridPostionList

`Protected` gridWidth

`Protected` height

`Protected` lastMovePiece

`Protected` lastMovePoint

`Protected` livePieceList

`Protected` logEvents

`Protected` moveEvents

`Protected` moveFailEvents

`Protected` movePointColor

`Protected` overEvents

`Protected` radius

`Protected` redPeiceBackground

`Protected` redPeiceTextColor

`Protected` scaleRatio

`Protected` startX

`Protected` startY

`Protected` width

`Protected` winner

`Protected` changeSide

`Protected` checkEnemySideHasMovePoints

`Protected` checkEnemySideInTroubleHasSolution

`Protected` checkGeneralInTrouble

`Protected` checkGeneralsFaceToFaceInTrouble

`Protected` clearMoveChoosePeiece

`Protected` drawChessLine

`Protected` getGridDiff

`Protected` getGridPosition