Grampus


Move Module

Namespace: Grampus

Assembly: GrampusLib.dll

Holds the functions related to a Move.

Functions and values

Function or value Description

From mv

Full Usage: From mv

Parameters:
    mv : Move - The move as a Move type.

Returns: Square The source square.

Get the source Square for an encoded Move.

mv : Move

The move as a Move type.

Returns: Square

The source square.

FromSan bd san

Full Usage: FromSan bd san

Parameters:
    bd : Brd - The Board as a Brd type.
    san : string - The SAN string, such as Nf3.

Returns: Move The move as a Move type.

Get an encoded move from a SAN string such as Nf3 for this Board.

bd : Brd

The Board as a Brd type.

san : string

The SAN string, such as Nf3.

Returns: Move

The move as a Move type.

FromUci bd uci

Full Usage: FromUci bd uci

Parameters:
    bd : Brd - The Board as a Brd type.
    uci : string - The SAN string, such as g1f3.

Returns: Move The move as a Move type.

Get an encoded move from a UCI string such as g1f3 for this Board.

bd : Brd

The Board as a Brd type.

uci : string

The SAN string, such as g1f3.

Returns: Move

The move as a Move type.

FromUcis bd ucis

Full Usage: FromUcis bd ucis

Parameters:
    bd : Brd - The Board as a Brd type.
    ucis : string - The string of UCI strings, such as g1f3 g8f6.

Returns: string The string of multiple SAN strings, such as Nf3 Nf6.

Get a string of multiple SAN strings from a string of UCIs for this Board.

bd : Brd

The Board as a Brd type.

ucis : string

The string of UCI strings, such as g1f3 g8f6.

Returns: string

The string of multiple SAN strings, such as Nf3 Nf6.

PromPcTp mv

Full Usage: PromPcTp mv

Parameters:
    mv : Move - The move as a Move type.

Returns: PieceType The promoted piece type as a PieceType type.

Get the promoted PieceType for an encoded Move.

mv : Move

The move as a Move type.

Returns: PieceType

The promoted piece type as a PieceType type.

To mv

Full Usage: To mv

Parameters:
    mv : Move - The move as a Move type.

Returns: Square The target square.

Get the target Square for an encoded Move.

mv : Move

The move as a Move type.

Returns: Square

The target square.

ToSan bd mv

Full Usage: ToSan bd mv

Parameters:
    bd : Brd - The Board as a Brd type.
    mv : Move - The move as a Move type.

Returns: string The SAN string, such as Nf3.

Get the SAN string such as Nf3 for a move for this board.

bd : Brd

The Board as a Brd type.

mv : Move

The move as a Move type.

Returns: string

The SAN string, such as Nf3.

ToUci mv

Full Usage: ToUci mv

Parameters:
    mv : Move - The move as a Move type.

Returns: string The UCI string, such as g1f3.

Get the UCI string such as g1f3 for a move.

mv : Move

The move as a Move type.

Returns: string

The UCI string, such as g1f3.