Class Board

Piece positions on a board.

Properties are sets of squares, like board.occupied for all occupied squares, board[color] for all pieces of that color, and board[role] for all pieces of that role. When modifying the properties directly, take care to keep them consistent.

Implements

Index

Properties

bishop black king knight occupied pawn promoted queen rook white

Methods

[iterator] bishopsAndQueens clear clone get getColor getRole has kingOf pieces reset rooksAndQueens set take default empty

Properties

occupied

occupied: SquareSet

All occupied squares.

pawn

pawn: SquareSet

promoted

promoted: SquareSet

All squares occupied by pieces known to be promoted. This information is relevant in chess variants like Crazyhouse.

queen

queen: SquareSet

rook

rook: SquareSet

white

white: SquareSet

Methods

[iterator]

"[iterator]"(): Iterator<[number, Piece]>
Returns Iterator<[number, Piece]>
Implementation of Iterable.[iterator]
- Defined in src/board.ts:131

bishopsAndQueens

bishopsAndQueens(): SquareSet
Returns SquareSet
- Defined in src/board.ts:145

clear

clear(): void
Returns void
- Defined in src/board.ts:63

clone

clone(): Board
Returns Board
- Defined in src/board.ts:70

get

get(square: number): undefined | Piece
Parameters
- square: number
Returns undefined | Piece
- Defined in src/board.ts:92

getColor

getColor(square: number): undefined | "black" | "white"
Parameters
- square: number
Returns undefined | "black" | "white"
- Defined in src/board.ts:79

getRole

getRole(
square: number,
): undefined | "pawn" | "knight" | "bishop" | "rook" | "queen" | "king"
Parameters
- square: number
Returns undefined | "pawn" | "knight" | "bishop" | "rook" | "queen" | "king"
- Defined in src/board.ts:85

has

has(square: number): boolean
Parameters
- square: number
Returns boolean
- Defined in src/board.ts:127

kingOf

kingOf(color: "black" | "white"): undefined | number
Finds the unique king of the given color, if any.
Parameters
- color: "black" | "white"
Returns undefined | number
- Defined in src/board.ts:152

pieces

pieces(
color: "black" | "white",
role: "pawn" | "knight" | "bishop" | "rook" | "queen" | "king",
): SquareSet
Parameters
- color: "black" | "white"
- role: "pawn" | "knight" | "bishop" | "rook" | "queen" | "king"
Returns SquareSet
- Defined in src/board.ts:137

reset

reset(): void
Resets all pieces to the default starting position for standard chess.

Returns void
- Defined in src/board.ts:44

rooksAndQueens

rooksAndQueens(): SquareSet
Returns SquareSet
- Defined in src/board.ts:141

set

set(square: number, piece: Piece): undefined | Piece
Put piece onto square, potentially replacing an existing piece. Returns the existing piece, if any.
Parameters
- square: number
- piece: Piece
Returns undefined | Piece
- Defined in src/board.ts:118

take

take(square: number): undefined | Piece
Removes and returns the piece from the given square, if any.
Parameters
- square: number
Returns undefined | Piece
- Defined in src/board.ts:103

`Static`default

default(): Board
Returns Board
- Defined in src/board.ts:35

`Static`empty

empty(): Board
Returns Board
- Defined in src/board.ts:57

Class Board

Implements

Index

Properties

Methods

Properties

bishop

black

king

knight

occupied

pawn

promoted

queen

rook

white

Methods

[iterator]

Returns Iterator<[number, Piece]>

bishopsAndQueens

Returns SquareSet

clear

Returns void

clone

Returns Board

get

Parameters

Returns undefined | Piece

getColor

Parameters

Returns undefined | "black" | "white"

getRole

Parameters

Returns undefined | "pawn" | "knight" | "bishop" | "rook" | "queen" | "king"

has

Parameters

Returns boolean

kingOf

Parameters

Returns undefined | number

pieces

Parameters

Returns SquareSet

reset

Returns void

rooksAndQueens

Returns SquareSet

set

Parameters

Returns undefined | Piece

take

Parameters

Returns undefined | Piece

Staticdefault

Returns Board

Staticempty

Returns Board

Settings

On This Page

`Static`default

`Static`empty