core/io.github.lunalobos.chess4kt/Move

Move

open class Move

Represents a single player's move on the board. It does not store information about the origin position, as its primary purpose is move representation. Its string representation is the full algebraic notation of the move as used in the UCI protocol (e.g., "e2e4", "a7a8q"). It is immutable.

This class leverages bitwise operations for efficient storage and manipulation.

Since

1.0.0-beta.1

Author

lunalobos

Properties

val origin: Int

The zero-based index (0-63) of the move's origin square.

val promotionPiece: Int

The ordinal value of the promotion piece, or -1 if no promotion occurs. The ordinal corresponds to the Piece enum.

val target: Int

The zero-based index (0-63) of the move's target square.

Functions

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

Generates a 16-bit hash code based on the move's origin, target, and promotion piece.

fun origin(): Square

Returns the origin square of the move as a Square enum constant.

fun promotionPiece(): Piece

Returns the promotion piece of the move as a Piece enum constant. Returns Piece.EMPTY if no promotion occurs.

fun target(): Square

Returns the target square of the move as a Square enum constant.

open override fun toString(): String

Returns the move in standard UCI notation (e.g., "e2e4", "a7a8q" for promotion).