Class MoveDescriptor`Abstract`

Describe a legal chess move, with its characteristics.

Index

Methods

capturedColoredPiece capturedPiece color coloredPromotion enPassantSquare from isCapture isCastling isEnPassant isPromotion movingColoredPiece movingPiece promotion rookFrom rookTo to

Methods

`Abstract`capturedColoredPiece

capturedColoredPiece(): | "br"
| "bb"
| "bp"
| "bq"
| "bk"
| "bn"
| "wr"
| "wb"
| "wp"
| "wq"
| "wk"
| "wn"
Color and type of the captured piece.

Returns
    | "br"
    | "bb"
    | "bp"
    | "bq"
    | "bk"
    | "bn"
    | "wr"
    | "wb"
    | "wp"
    | "wq"
    | "wk"
    | "wn"
Throws
exception.IllegalArgument if the current move is not a capture, i.e. if isCapture returns false.

`Abstract`capturedPiece

capturedPiece(): Piece
Type of the captured piece.

Returns Piece
Throws
exception.IllegalArgument if the current move is not a capture, i.e. if isCapture returns false.

`Abstract`color

color(): Color
Color of the moving piece.

Returns Color

`Abstract`coloredPromotion

coloredPromotion(): | "br"
| "bb"
| "bp"
| "bq"
| "bk"
| "bn"
| "wr"
| "wb"
| "wp"
| "wq"
| "wk"
| "wn"
Color and type of the promoted piece, in case of a promotion.

Returns
    | "br"
    | "bb"
    | "bp"
    | "bq"
    | "bk"
    | "bn"
    | "wr"
    | "wb"
    | "wp"
    | "wq"
    | "wk"
    | "wn"
Throws
exception.IllegalArgument if the current move is not a promotion, i.e. if isPromotion returns false.

`Abstract`enPassantSquare

enPassantSquare(): | "h1"
| "h2"
| "h3"
| "h4"
| "h5"
| "h6"
| "d1"
| "d2"
| "d3"
| "d4"
| "d5"
| "d6"
| "d7"
| "d8"
| "a1"
| "a2"
| "a3"
| "a4"
| "a5"
| "a6"
| "a7"
| "a8"
| "b1"
| "b2"
| "b3"
| "b4"
| "b5"
| "b6"
| "b7"
| "b8"
| "g1"
| "g2"
| "g3"
| "g4"
| "g5"
| "g6"
| "g7"
| "g8"
| "c1"
| "c2"
| "c3"
| "c4"
| "c5"
| "c6"
| "c7"
| "c8"
| "e1"
| "e2"
| "e3"
| "e4"
| "e5"
| "e6"
| "e7"
| "e8"
| "f1"
| "f2"
| "f3"
| "f4"
| "f5"
| "f6"
| "f7"
| "f8"
| "h7"
| "h8"
Square containing the captured pawn, in case of a en-passant capture.

Returns
    | "h1"
    | "h2"
    | "h3"
    | "h4"
    | "h5"
    | "h6"
    | "d1"
    | "d2"
    | "d3"
    | "d4"
    | "d5"
    | "d6"
    | "d7"
    | "d8"
    | "a1"
    | "a2"
    | "a3"
    | "a4"
    | "a5"
    | "a6"
    | "a7"
    | "a8"
    | "b1"
    | "b2"
    | "b3"
    | "b4"
    | "b5"
    | "b6"
    | "b7"
    | "b8"
    | "g1"
    | "g2"
    | "g3"
    | "g4"
    | "g5"
    | "g6"
    | "g7"
    | "g8"
    | "c1"
    | "c2"
    | "c3"
    | "c4"
    | "c5"
    | "c6"
    | "c7"
    | "c8"
    | "e1"
    | "e2"
    | "e3"
    | "e4"
    | "e5"
    | "e6"
    | "e7"
    | "e8"
    | "f1"
    | "f2"
    | "f3"
    | "f4"
    | "f5"
    | "f6"
    | "f7"
    | "f8"
    | "h7"
    | "h8"
Throws
exception.IllegalArgument if the current move is not a en-passant capture, i.e. if isEnPassant returns false.

`Abstract`from

from(): | "h1"
| "h2"
| "h3"
| "h4"
| "h5"
| "h6"
| "d1"
| "d2"
| "d3"
| "d4"
| "d5"
| "d6"
| "d7"
| "d8"
| "a1"
| "a2"
| "a3"
| "a4"
| "a5"
| "a6"
| "a7"
| "a8"
| "b1"
| "b2"
| "b3"
| "b4"
| "b5"
| "b6"
| "b7"
| "b8"
| "g1"
| "g2"
| "g3"
| "g4"
| "g5"
| "g6"
| "g7"
| "g8"
| "c1"
| "c2"
| "c3"
| "c4"
| "c5"
| "c6"
| "c7"
| "c8"
| "e1"
| "e2"
| "e3"
| "e4"
| "e5"
| "e6"
| "e7"
| "e8"
| "f1"
| "f2"
| "f3"
| "f4"
| "f5"
| "f6"
| "f7"
| "f8"
| "h7"
| "h8"
Origin square of the moving piece. In case of castling, this is the origin square of the king.

Returns
    | "h1"
    | "h2"
    | "h3"
    | "h4"
    | "h5"
    | "h6"
    | "d1"
    | "d2"
    | "d3"
    | "d4"
    | "d5"
    | "d6"
    | "d7"
    | "d8"
    | "a1"
    | "a2"
    | "a3"
    | "a4"
    | "a5"
    | "a6"
    | "a7"
    | "a8"
    | "b1"
    | "b2"
    | "b3"
    | "b4"
    | "b5"
    | "b6"
    | "b7"
    | "b8"
    | "g1"
    | "g2"
    | "g3"
    | "g4"
    | "g5"
    | "g6"
    | "g7"
    | "g8"
    | "c1"
    | "c2"
    | "c3"
    | "c4"
    | "c5"
    | "c6"
    | "c7"
    | "c8"
    | "e1"
    | "e2"
    | "e3"
    | "e4"
    | "e5"
    | "e6"
    | "e7"
    | "e8"
    | "f1"
    | "f2"
    | "f3"
    | "f4"
    | "f5"
    | "f6"
    | "f7"
    | "f8"
    | "h7"
    | "h8"

`Abstract`isCapture

isCapture(): boolean
Whether the current move is a capture (either a regular capture or a en-passant capture) or not.

Returns boolean

`Abstract`isCastling

isCastling(): boolean
Whether the current move is a castling move or not.

Returns boolean

`Abstract`isEnPassant

isEnPassant(): boolean
Whether the current move is a en-passant capture or not.

Returns boolean

`Abstract`isPromotion

isPromotion(): boolean
Whether the current move is a promotion or not.

Returns boolean

`Abstract`movingColoredPiece

movingColoredPiece(): | "br"
| "bb"
| "bp"
| "bq"
| "bk"
| "bn"
| "wr"
| "wb"
| "wp"
| "wq"
| "wk"
| "wn"
Color and type of the moving piece. In case of castling, the moving piece is considered to be the king.

Returns
    | "br"
    | "bb"
    | "bp"
    | "bq"
    | "bk"
    | "bn"
    | "wr"
    | "wb"
    | "wp"
    | "wq"
    | "wk"
    | "wn"

`Abstract`movingPiece

movingPiece(): Piece
Type of the moving piece. In case of castling, the moving piece is considered to be the king.

Returns Piece

`Abstract`promotion

promotion(): Piece
Type of the promoted piece, in case of a promotion.

Returns Piece
Throws
exception.IllegalArgument if the current move is not a promotion, i.e. if isPromotion returns false.

`Abstract`rookFrom

rookFrom(): | "h1"
| "h2"
| "h3"
| "h4"
| "h5"
| "h6"
| "d1"
| "d2"
| "d3"
| "d4"
| "d5"
| "d6"
| "d7"
| "d8"
| "a1"
| "a2"
| "a3"
| "a4"
| "a5"
| "a6"
| "a7"
| "a8"
| "b1"
| "b2"
| "b3"
| "b4"
| "b5"
| "b6"
| "b7"
| "b8"
| "g1"
| "g2"
| "g3"
| "g4"
| "g5"
| "g6"
| "g7"
| "g8"
| "c1"
| "c2"
| "c3"
| "c4"
| "c5"
| "c6"
| "c7"
| "c8"
| "e1"
| "e2"
| "e3"
| "e4"
| "e5"
| "e6"
| "e7"
| "e8"
| "f1"
| "f2"
| "f3"
| "f4"
| "f5"
| "f6"
| "f7"
| "f8"
| "h7"
| "h8"
Origin square of the rook, in case of a castling move.

Returns
    | "h1"
    | "h2"
    | "h3"
    | "h4"
    | "h5"
    | "h6"
    | "d1"
    | "d2"
    | "d3"
    | "d4"
    | "d5"
    | "d6"
    | "d7"
    | "d8"
    | "a1"
    | "a2"
    | "a3"
    | "a4"
    | "a5"
    | "a6"
    | "a7"
    | "a8"
    | "b1"
    | "b2"
    | "b3"
    | "b4"
    | "b5"
    | "b6"
    | "b7"
    | "b8"
    | "g1"
    | "g2"
    | "g3"
    | "g4"
    | "g5"
    | "g6"
    | "g7"
    | "g8"
    | "c1"
    | "c2"
    | "c3"
    | "c4"
    | "c5"
    | "c6"
    | "c7"
    | "c8"
    | "e1"
    | "e2"
    | "e3"
    | "e4"
    | "e5"
    | "e6"
    | "e7"
    | "e8"
    | "f1"
    | "f2"
    | "f3"
    | "f4"
    | "f5"
    | "f6"
    | "f7"
    | "f8"
    | "h7"
    | "h8"
Throws
exception.IllegalArgument if the current move is not a castling move, i.e. if isCastling returns false.

`Abstract`rookTo

rookTo(): | "h1"
| "h2"
| "h3"
| "h4"
| "h5"
| "h6"
| "d1"
| "d2"
| "d3"
| "d4"
| "d5"
| "d6"
| "d7"
| "d8"
| "a1"
| "a2"
| "a3"
| "a4"
| "a5"
| "a6"
| "a7"
| "a8"
| "b1"
| "b2"
| "b3"
| "b4"
| "b5"
| "b6"
| "b7"
| "b8"
| "g1"
| "g2"
| "g3"
| "g4"
| "g5"
| "g6"
| "g7"
| "g8"
| "c1"
| "c2"
| "c3"
| "c4"
| "c5"
| "c6"
| "c7"
| "c8"
| "e1"
| "e2"
| "e3"
| "e4"
| "e5"
| "e6"
| "e7"
| "e8"
| "f1"
| "f2"
| "f3"
| "f4"
| "f5"
| "f6"
| "f7"
| "f8"
| "h7"
| "h8"
Destination square of the rook, in case of a castling move.

Returns
    | "h1"
    | "h2"
    | "h3"
    | "h4"
    | "h5"
    | "h6"
    | "d1"
    | "d2"
    | "d3"
    | "d4"
    | "d5"
    | "d6"
    | "d7"
    | "d8"
    | "a1"
    | "a2"
    | "a3"
    | "a4"
    | "a5"
    | "a6"
    | "a7"
    | "a8"
    | "b1"
    | "b2"
    | "b3"
    | "b4"
    | "b5"
    | "b6"
    | "b7"
    | "b8"
    | "g1"
    | "g2"
    | "g3"
    | "g4"
    | "g5"
    | "g6"
    | "g7"
    | "g8"
    | "c1"
    | "c2"
    | "c3"
    | "c4"
    | "c5"
    | "c6"
    | "c7"
    | "c8"
    | "e1"
    | "e2"
    | "e3"
    | "e4"
    | "e5"
    | "e6"
    | "e7"
    | "e8"
    | "f1"
    | "f2"
    | "f3"
    | "f4"
    | "f5"
    | "f6"
    | "f7"
    | "f8"
    | "h7"
    | "h8"
Throws
exception.IllegalArgument if the current move is not a castling move, i.e. if isCastling returns false.

`Abstract`to

to(): | "h1"
| "h2"
| "h3"
| "h4"
| "h5"
| "h6"
| "d1"
| "d2"
| "d3"
| "d4"
| "d5"
| "d6"
| "d7"
| "d8"
| "a1"
| "a2"
| "a3"
| "a4"
| "a5"
| "a6"
| "a7"
| "a8"
| "b1"
| "b2"
| "b3"
| "b4"
| "b5"
| "b6"
| "b7"
| "b8"
| "g1"
| "g2"
| "g3"
| "g4"
| "g5"
| "g6"
| "g7"
| "g8"
| "c1"
| "c2"
| "c3"
| "c4"
| "c5"
| "c6"
| "c7"
| "c8"
| "e1"
| "e2"
| "e3"
| "e4"
| "e5"
| "e6"
| "e7"
| "e8"
| "f1"
| "f2"
| "f3"
| "f4"
| "f5"
| "f6"
| "f7"
| "f8"
| "h7"
| "h8"
Destination square of the moving piece. In case of castling, this is the destination square of the king.

Returns
    | "h1"
    | "h2"
    | "h3"
    | "h4"
    | "h5"
    | "h6"
    | "d1"
    | "d2"
    | "d3"
    | "d4"
    | "d5"
    | "d6"
    | "d7"
    | "d8"
    | "a1"
    | "a2"
    | "a3"
    | "a4"
    | "a5"
    | "a6"
    | "a7"
    | "a8"
    | "b1"
    | "b2"
    | "b3"
    | "b4"
    | "b5"
    | "b6"
    | "b7"
    | "b8"
    | "g1"
    | "g2"
    | "g3"
    | "g4"
    | "g5"
    | "g6"
    | "g7"
    | "g8"
    | "c1"
    | "c2"
    | "c3"
    | "c4"
    | "c5"
    | "c6"
    | "c7"
    | "c8"
    | "e1"
    | "e2"
    | "e3"
    | "e4"
    | "e5"
    | "e6"
    | "e7"
    | "e8"
    | "f1"
    | "f2"
    | "f3"
    | "f4"
    | "f5"
    | "f6"
    | "f7"
    | "f8"
    | "h7"
    | "h8"

Class MoveDescriptor`Abstract`

Index

Methods

Methods

`Abstract`capturedColoredPiece

Returns
    | "br"
    | "bb"
    | "bp"
    | "bq"
    | "bk"
    | "bn"
    | "wr"
    | "wb"
    | "wp"
    | "wq"
    | "wk"
    | "wn"

Throws

`Abstract`capturedPiece

Returns Piece

Throws

`Abstract`color

Returns Color

`Abstract`coloredPromotion

Returns
    | "br"
    | "bb"
    | "bp"
    | "bq"
    | "bk"
    | "bn"
    | "wr"
    | "wb"
    | "wp"
    | "wq"
    | "wk"
    | "wn"

Throws

`Abstract`enPassantSquare

Throws

`Abstract`from

`Abstract`isCapture

Returns boolean

`Abstract`isCastling

Returns boolean

`Abstract`isEnPassant

Returns boolean

`Abstract`isPromotion

Returns boolean

`Abstract`movingColoredPiece

Returns
    | "br"
    | "bb"
    | "bp"
    | "bq"
    | "bk"
    | "bn"
    | "wr"
    | "wb"
    | "wp"
    | "wq"
    | "wk"
    | "wn"

`Abstract`movingPiece

Returns Piece

`Abstract`promotion

Returns Piece

Throws

`Abstract`rookFrom

Throws

`Abstract`rookTo

Throws

`Abstract`to

Settings

On This Page

Class MoveDescriptorAbstract

Index

Methods

Methods

AbstractcapturedColoredPiece

Returns | "br" | "bb" | "bp" | "bq" | "bk" | "bn" | "wr" | "wb" | "wp" | "wq" | "wk" | "wn"

Throws

AbstractcapturedPiece

Returns Piece

Throws

Abstractcolor

Returns Color

AbstractcoloredPromotion

Returns | "br" | "bb" | "bp" | "bq" | "bk" | "bn" | "wr" | "wb" | "wp" | "wq" | "wk" | "wn"

Throws

AbstractenPassantSquare

Throws

Abstractfrom

AbstractisCapture

Returns boolean

AbstractisCastling

Returns boolean

AbstractisEnPassant

Returns boolean

AbstractisPromotion

Returns boolean

AbstractmovingColoredPiece

Returns | "br" | "bb" | "bp" | "bq" | "bk" | "bn" | "wr" | "wb" | "wp" | "wq" | "wk" | "wn"

AbstractmovingPiece

Returns Piece

Abstractpromotion

Returns Piece

Throws

AbstractrookFrom

Throws

AbstractrookTo

Throws

Abstractto

Settings

On This Page

Class MoveDescriptor`Abstract`

`Abstract`capturedColoredPiece

Returns
| "br"
| "bb"
| "bp"
| "bq"
| "bk"
| "bn"
| "wr"
| "wb"
| "wp"
| "wq"
| "wk"
| "wn"

`Abstract`capturedPiece

`Abstract`color

`Abstract`coloredPromotion

Returns
| "br"
| "bb"
| "bp"
| "bq"
| "bk"
| "bn"
| "wr"
| "wb"
| "wp"
| "wq"
| "wk"
| "wn"

`Abstract`enPassantSquare

`Abstract`from

`Abstract`isCapture

`Abstract`isCastling

`Abstract`isEnPassant

`Abstract`isPromotion

`Abstract`movingColoredPiece

Returns
| "br"
| "bb"
| "bp"
| "bq"
| "bk"
| "bn"
| "wr"
| "wb"
| "wp"
| "wq"
| "wk"
| "wn"

`Abstract`movingPiece

`Abstract`promotion

`Abstract`rookFrom

`Abstract`rookTo

`Abstract`to