Class default

Hierarchy

  • default

Constructors

constructor

Properties

animate blackPeiceBackground blackPeiceTextColor boardTextColor cancelAnimate checkerboardBackground choosePeiceBorderColor choosePiece ctx? currentSide drawMovePoint duration endX endY errorEvents gameSide gameState gridDiffX gridDiffY gridHeight gridPostionList gridWidth height lastMovePiece lastMovePoint livePieceList logEvents moveEvents moveFailEvents movePointColor overEvents radius redPeiceBackground redPeiceTextColor scaleRatio startX startY width winner

Accessors

currentGameSide currentLivePieceList currentRadius winnerSide

Methods

changeCurrentPlaySide changePlaySide changeSide checkDraw checkEnemySideHasMovePoints checkEnemySideInTroubleHasSolution checkGameState checkGeneralInTrouble checkGeneralsFaceToFaceInTrouble clearMoveChoosePeiece draw drawChessLine drawLastMovePoint gameOver gameStart generateLegalMoves generateMoves getCurrentPenCode getGridDiff getGridPosition getPiecesOfSide init initPiece isGameOver isLegalMove listenClick listenClickAsync moveStr moveStrAsync on removeEvent setGameWindow setGridDiff setGridList setLastMovePeiceStatus setLivePieceList setPenCodeList update updateAsync

Constructors

constructor

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: GamePieceGridDiffX

玩家 x轴 格子距离相差

Protected gridDiffY

gridDiffY: GamePieceGridDiffY

玩家 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

currentLivePieceList

currentRadius

  • get currentRadius(): number

  • 获取当前象棋绘制半径

    Returns number

winnerSide

Methods

changeCurrentPlaySide

changePlaySide

Protected changeSide

  • 更换当前运行玩家

    Returns void

checkDraw

  • 检查是否有画布 有会更新画布 否则不更新 报出错误

    Returns void

Protected checkEnemySideHasMovePoints

Protected checkEnemySideInTroubleHasSolution

checkGameState

checkGeneralInTrouble

Protected checkGeneralsFaceToFaceInTrouble

  • 检查棋子移动 双方将领在一条直线上 false 不危险 true 危险

    Returns

    是否危险

    Parameters

    Returns boolean

Protected clearMoveChoosePeiece

  • 清除移动完选中的棋子

    Returns void

draw

  • 根据当前棋子状态绘画 棋盘状态 游戏数据 画出布局

    Parameters

    • ctx: CanvasRenderingContext2D

      画布

    Returns void

Protected drawChessLine

  • 画棋盘

    Parameters

    • ctx: CanvasRenderingContext2D

    Returns void

drawLastMovePoint

  • 绘画上次移动点，可自行重写该函数

    Parameters

    • ctx: CanvasRenderingContext2D

      canvas 2d 渲染上下文

    Returns void

gameOver

gameStart

generateLegalMoves

  • 批量生成指定方所有存活棋子的合法走法列表（AI 搜索可直接使用）

    与 generateMoves 的区别在于：本接口对每个伪合法走法执行 送将检测（checkGeneralInTrouble），只返回走子后己方将帅 不会被攻击、也不会与敌方将帅对脸的走法。

    内部仅构建一次棋盘位表，全部棋子复用；送将检测同样复用该位表做 增量模拟（双槽位），无额外棋盘分配，适合搜索树热路径。

    Returns

    扁平化的合法走法列表，每个走法包含起止点与被吃子信息： { from: Point, to: Point, captured: ChessOfPeice | null }

    Parameters

    • side: PieceSide

      玩家方，"RED" 或 "BLACK"

    Returns Move[]

generateMoves

  • 批量生成指定方所有存活棋子的伪合法走法列表（AI 搜索入口）

    内部仅构建一次棋盘位表并交由本方全部棋子复用，比逐个调用 getMovePoints(pl)（每次调用都重建位表）在搜索类场景下更高效。

    注意：该接口返回的是伪合法走法，不包含送将过滤（允许走出 后己方将帅暴露在被吃/对脸的局面）。需要严格合法走法请使用 generateLegalMoves。

    Returns

    该方存活棋子按其在本方棋子序列中的顺序对应的走法列表数组； 第 i 个元素对应第 i 枚属于该方的棋子，可结合 currentLivePieceList.filter(p => p.side === side) 对齐棋子与走法

    Parameters

    • side: PieceSide

      玩家方，"RED" 或 "BLACK"

    Returns MovePointList[]

getCurrentPenCode

Protected getGridDiff

  • 根据玩家返回绘画坐标轴的差值

    Returns

    Parameters

    • side: PieceSide

      玩家

    • key: "y" | "x"

      坐标轴

    Returns 0 | 8 | 9

Protected getGridPosition

  • 根据点击点返回所在棋盘上x,y的位置

    Returns

    返回棋盘的x，y坐标轴

    Parameters

    • p: Point

      点击点的 x,y 坐标

    Returns undefined | Point

getPiecesOfSide

  • 获取指定方当前存活的棋子列表（内部仍做浅拷贝，避免外部修改内部状态）

    与 currentLivePieceList 相比省去了手动 filter，且可配合 generateMoves 直接对齐棋子与走法。

    Parameters

    • side: PieceSide

      玩家方，"RED" 或 "BLACK"

    Returns PieceList

Protected init

Protected initPiece

  • 初始化象棋个数

    Returns void

isGameOver

  • 游戏是否结束

    Returns boolean

isLegalMove

  • 判断指定方棋子从 from 走到 to 是否为合法走法（含送将过滤）

    要求 from 处存在属于 side 的棋子，且该走法在 getMovePoints 中可用（不越界、不占己方子、不蹩腿/塞象眼）， 且走子后己方将帅不被攻击、不与敌方将帅对脸。

    Returns

    是否合法走法

    Parameters

    • side: PieceSide

      玩家方，"RED" 或 "BLACK"

    • from: Point

      起始坐标

    • to: Point

      目标坐标

    Returns boolean

listenClick

  • 监听棋盘点击

    Parameters

    • e: MouseEvent

    Returns void

listenClickAsync

  • 监听棋盘点击

    Parameters

    • e: MouseEvent

    Returns void

moveStr

moveStrAsync

  • 根据移动方的描述文字来进行移动棋子

    Returns

    移动结果

    Parameters

    • str: string

      文字

    • side: PieceSide

      移动方

    • refreshCtx: boolean

      是否每次移动都更新画布

    Returns Promise<UpdateResult>

on

removeEvent

Protected setGameWindow

  • 设置游戏窗口 棋盘 棋子大小

    Parameters

    • w: number
    • h: number
    • p: number

    Returns void

Protected setGridDiff

Protected setGridList

  • 获取所有格子的坐标

    Returns void

Protected setLastMovePeiceStatus

  • 设置上次移动状态

    Parameters

    • status: boolean

    Returns void

setLivePieceList

setPenCodeList

update

  • 游戏根据坐标点 移动点来进行更新游戏运行数据。

    Returns

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

    如果 post 为 true，程序会自己更新游戏状态 只需要判断 是否更新成功即可！

    Parameters

    • pos: Point

      坐标点

    • mov: null | Point

      移动点

    • side: PieceSide

      当前下棋玩家

    • post: boolean

      是否由程序自己更新游戏状态

    Returns UpdateResult

updateAsync

  • 游戏根据坐标点 移动点来进行更新游戏运行数据。这是一个返回一个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>

Settings

Member Visibility

Theme

Generated using TypeDoc