API Docs for:
Show:

Queen Class

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

A Queen class, represents a Knight piece

Constructor

Queen

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

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

Parameters:

  • color Object

    queen's color

  • type Object

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

  • 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/Queen.js:85

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/Queen.js:59

get relative path to the piece image

Returns:

String:

path to the piece image

getLegalMoves

() Array

Defined in js/classes/pieces/Queen.js:73

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/Queen.js:111

get notation symbol of the piece

Returns:

String:

notation symbol

move

(
  • x
  • y
)
Object

Defined in js/classes/pieces/Queen.js:99

moves piece to a new field

Parameters:

  • x Number

    x coordinate of destination

  • y Number

    y coordinate of destination

Returns:

Object:

object represents a summary of the move

Properties

color

String

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

Queen's color

ID

Number

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

Queen's ID

notationName

String

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

notation symbol

type

String

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

Queen's type

X

Number

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

x coordinate

Y

Number

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

y coordinate