Class TMoveContext

A partial move context

Hierarchy

TMoveContext

Index

Constructors

Properties

board changes design from hand loc marks mode move parent part piece succeed

Methods

back canGoTo capture copy endMove getPiece inZone isEmpty isEnemy isFriend isLastFrom isPiece mark opposite pop promote put setPiece take

Constructors

constructor

new TMoveContext(design: TDesign, board: TBoard, loc: number, piece: TPiece): TMoveContext
Parameters
- design: TDesign
  
  a gane design object
- board: TBoard
  
  a game state object
- loc: number
  
  origin square (the last square that the moving piece passed through)
- piece: TPiece
  
  a piece that moves on this turn
Returns TMoveContext
- Defined in move_context.ts:51

Properties

board

board: TBoard

changes

changes: {
loc: number;
piece: TPiece;
}[]

design

design: TDesign

from

from: number

hand

hand: {
piece: TPiece;
start: number;
}

Type declaration

piece: TPiece
start: number

loc

loc: number

marks

marks: number[]

mode

mode: number

move

move: TMove

parent

parent: TMoveContext

part

part: number

piece

piece: TPiece

succeed

succeed: boolean

Methods

back

back(): void
Returns void
- Defined in move_context.ts:133

canGoTo

canGoTo(params: number[], ix: number): boolean
Check whether the target square is not occupied (i.e. whether the piece can move toward the given direction from the current location)
Parameters
- params: number[]
  
  direction that the piece can move toward
- ix: number
  
  params array index of the direction that the piece will move toward
Returns boolean
- Defined in move_context.ts:175

capture

capture(): void
capture a piece on the passing square

Returns void
- Defined in move_context.ts:322

copy

copy(): TMoveContext
Clone itself

Returns
copied instance

Returns TMoveContext
- Defined in move_context.ts:94

endMove

endMove(params?: number, ix?: number): void
Finish the context of the current move
Parameters
- Optional params: number
- Optional ix: number
Returns void
- Defined in move_context.ts:335

getPiece

getPiece(loc: number): TPiece
Returns
Parameters
- loc: number
Returns TPiece
- Defined in move_context.ts:117

inZone

inZone(params: number, ix?: number): boolean
Check if the piece is in the specified zone
Parameters
- params: number
- Optional ix: number
Returns boolean
- Defined in move_context.ts:289

isEmpty

isEmpty(): boolean
Check whether the target square of the piece is empty or not

Returns boolean
- Defined in move_context.ts:228

isEnemy

isEnemy(): boolean
Check whether an enemy piece is on the given square or not

Returns boolean
- Defined in move_context.ts:246

isFriend

isFriend(): boolean
Check whether a piece is mine

Returns

Returns boolean
- Defined in move_context.ts:258

isLastFrom

isLastFrom(params?: number, ix?: number): boolean
Returns
Parameters
- Optional params: number
- Optional ix: number
Returns boolean
- Defined in move_context.ts:212

isPiece

isPiece(params: number, ix?: number): boolean
Returns
Parameters
- params: number
- Optional ix: number
Returns boolean
- Defined in move_context.ts:272

mark

mark(): void
Returns void
- Defined in move_context.ts:129

opposite

opposite(params: number, ix: number): number
Returns
Parameters
- params: number
- ix: number
Returns number
- Defined in move_context.ts:198

pop

pop(): void
Returns void
- Defined in move_context.ts:139

promote

promote(params: number, ix?: number): boolean
Make the current piece promote to another piece of the given type

Returns
whether the current piece can promote to the given piece type or not
Parameters
- params: number
- Optional ix: number
Returns boolean
- Defined in move_context.ts:307

put

put(): void
Returns void
- Defined in move_context.ts:155

setPiece

setPiece(loc: number, piece: TPiece): void
Parameters
- loc: number
- piece: TPiece
Returns void
- Defined in move_context.ts:108

take

take(): void
Record the moving piece and its origin square

Returns void
- Defined in move_context.ts:148

Generated using TypeDoc