API Docs for:
Show:

Pawn Class

Defined in: js/classes/pieces/Pawn.js:6
Module: Pieces

A Pawn class, represents a Knight piece

Constructor

Pawn

(
  • color
  • type
  • X
  • Y
  • id
)

Defined in js/classes/pieces/Pawn.js:6

Parameters:

  • color Object

    pawn's color

  • type Object

    type of the piece, e.g. "Pawn"

  • X Object

    x coordinate on the board (0-7), 0 represents 'a' file, 7 represents 'h' file

  • Y Object

    y coordinate on the board (0-7), 0 represents 8-th rank, 7 represnts 1-st rank

  • id Object

    id of the piece

Methods

getCoveredFields

() Array

Defined in js/classes/pieces/Pawn.js:208

get piece covered fields

Returns:

Array:

an array of (x,y) coordinates represents a set of fields, covered by a piece

getImageSource

() String

Defined in js/classes/pieces/Pawn.js:66

get relative path to the piece image

Returns:

String:

path to the piece image

getLegalMoves

() Array

Defined in js/classes/pieces/Pawn.js:80

get piece legal moves

Returns:

Array:

an array of (x,y) coordinates represents a legal moves for a piece

getNotationSymbol

() String

Defined in js/classes/pieces/Pawn.js:412

get notation symbol of the piece

Returns:

String:

notation symbol

isPromotionMove

(
  • chessCoor
)
Boolean

Defined in js/classes/pieces/Pawn.js:379

moves piece to a new field

Parameters:

  • chessCoor Object

    an object represents the coordinates of the field where pawn promotes

Returns:

Boolean:

true in case the move is promotion of a pawn, false otherwise

move

(
  • x
  • y
  • pc
)
Object

Defined in js/classes/pieces/Pawn.js:236

moves piece to a new field

Parameters:

  • x Number

    x coordinate of destination

  • y Number

    y coordinate of destination

  • pc String

    represents a promotion choice in case of pawn promotion. Valid values are 'Q' for Queen,'R' for Rook,'N' for Knight,'B' for Bishop or null in case pawn does not promote on that move.

Returns:

Object:

object represents a summary of the move

Properties

canBeTakenEnPassant

Boolean

Defined in js/classes/pieces/Pawn.js:59

Boolean flag if piece can be taken en passant

color

String

Defined in js/classes/pieces/Pawn.js:17

Pawn's color

ID

Number

Defined in js/classes/pieces/Pawn.js:45

Pawn's ID

notationName

String

Defined in js/classes/pieces/Pawn.js:52

notation symbol

type

String

Defined in js/classes/pieces/Pawn.js:24

Pawn's type

X

Number

Defined in js/classes/pieces/Pawn.js:31

x coordinate

Y

Number

Defined in js/classes/pieces/Pawn.js:38

y coordinate