API Docs for:
Show:

Board Class

Defined in: js/classes/Board.js:1
Module: Pieces

A Board class, represents a state of the game

Constructor

Board

()

Defined in js/classes/Board.js:1

Methods

changeSideToMove

()

Defined in js/classes/Board.js:221

chnages current side to move

clearSelection

()

Defined in js/classes/Board.js:198

clears highlight of the selected piece

drawBoard

()

Defined in js/classes/Board.js:110

draws chess board with out pieces

drawCastling

(
  • origin
  • destination
  • piece
)

Defined in js/classes/Board.js:286

renders the castling

Parameters:

  • origin Object

    coordinates of origin

  • destination Object

    coordinates of destination

  • piece Object

    piece to castle

drawEnpassant

(
  • origin
  • destination
  • piece
)

Defined in js/classes/Board.js:386

renders the en passant capture

Parameters:

  • origin Object

    coordinates of origin

  • destination Object

    coordinates of destination

  • piece Object

    piece to take en passant

drawLegalMoves

()

Defined in js/classes/Board.js:164

draws highlight of legal moves

drawMove

(
  • origin
  • destination
  • piece
)

Defined in js/classes/Board.js:252

renders the move of a piece

Parameters:

  • origin Object

    coordinates of origin

  • destination Object

    coordinates of destination

  • piece Object

    piece to move

drawPieces

()

Defined in js/classes/Board.js:131

draws chess pieces

getBoardWidth

()

Defined in js/classes/Board.js:244

gets length of the side of the field

getBoardWidth

()

Defined in js/classes/Board.js:236

gets width of the board

getFEN

() String

Defined in js/classes/Board.js:442

generates Forsyth–Edwards notation of the current state of the chess game

Returns:

String:

string represnts a Forsyth–Edwards notation of the current state of the chess game

highlightSelectedPiece

(
  • piece
)

Defined in js/classes/Board.js:185

draws highlight of selected piece

Parameters:

  • piece Object

    selected piece

setBoard

(
  • data
)

Defined in js/classes/Board.js:583

sets a chess board according to a given data

Parameters:

  • data Object

    data represents the state of the game

setBoardSide

(
  • wp_id
)
private

Defined in js/classes/Board.js:549

sets a board side of a player according to a given white player id

Parameters:

  • wp_id Number

    white player id

setEnPassant

(
  • coor
)
private

Defined in js/classes/Board.js:563

sets a boolean flag to pawn which can be taken en passant

Parameters:

  • coor Object

    the coordinates of the pawn to be set

setPieces

(
  • fen
)
private

Defined in js/classes/Board.js:482

sets a pieces property according to a given Forsyth–Edwards notation value

Parameters:

  • fen String

    string represnts a Forsyth–Edwards notation

Properties

blackField

String private

Defined in js/classes/Board.js:36

The color of the black fields

boardContext

Object private

Defined in js/classes/Board.js:60

canvas context to draw board

drawMoves

Number

Defined in js/classes/Board.js:68

Counter of moves to achieve a draw by 50 moves rule

lmovesContext

Object private

Defined in js/classes/Board.js:52

canvas context to draw legal moves highlight

pieces

Array

Defined in js/classes/Board.js:103

An array of pieces on the board

piecesContext

Object private

Defined in js/classes/Board.js:44

canvas context to draw pieces

side

String

Defined in js/classes/Board.js:14

Board side, either 'black' or 'white'

sideToMove

String

Defined in js/classes/Board.js:21

Current side to move, either 'black' or 'white'

that

Object

Defined in js/classes/Board.js:8

self reference

whiteCanCastleLong

String

Defined in js/classes/Board.js:75

A flag, represents if white side has right to castle long, valid falues are 'true' and 'false'

whiteCanCastleLong

String

Defined in js/classes/Board.js:82

A flag, represents if white side has right to castle short, valid falues are 'true' and 'false'

whiteCanCastleLong

String

Defined in js/classes/Board.js:89

A flag, represents if black side has right to castle long, valid falues are 'true' and 'false'

whiteCanCastleLong

String

Defined in js/classes/Board.js:96

A flag, represents if black side has right to castle short, valid falues are 'true' and 'false'

whiteField

String private

Defined in js/classes/Board.js:28

The color of the white fields