Class MoveDescriptor`Abstract`

Describe a legal chess move, with its characteristics.

Hierarchy

MoveDescriptor

Index

Methods

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

Methods

`Abstract` capturedColoredPiece

capturedColoredPiece(): ColoredPiece
Color and type of the captured piece.

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

Returns ColoredPiece

`Abstract` capturedPiece

capturedPiece(): Piece
Type of the captured piece.

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

Returns Piece

`Abstract` color

color(): Color
Color of the moving piece.

Returns Color

`Abstract` coloredPromotion

coloredPromotion(): ColoredPiece
Color and type of the promoted piece, in case of a promotion.

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

Returns ColoredPiece

`Abstract` enPassantSquare

enPassantSquare(): Square
Square containing the captured pawn, in case of a en-passant capture.

Throws
IllegalArgument if the current move is not a en-passant capture, i.e. if isEnPassant returns false.

Returns Square

`Abstract` from

from(): Square
Origin square of the moving piece. In case of castling, this is the origin square of the king.

Returns Square

`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(): ColoredPiece
Color and type of the moving piece. In case of castling, the moving piece is considered to be the king.

Returns ColoredPiece

`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.

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

Returns Piece

`Abstract` rookFrom

rookFrom(): Square
Origin square of the rook, in case of a castling move.

Throws
IllegalArgument if the current move is not a castling move, i.e. if isCastling returns false.

Returns Square

`Abstract` rookTo

rookTo(): Square
Destination square of the rook, in case of a castling move.

Throws
IllegalArgument if the current move is not a castling move, i.e. if isCastling returns false.

Returns Square

`Abstract` to

to(): Square
Destination square of the moving piece. In case of castling, this is the destination square of the king.

Returns Square

Generated using TypeDoc