core/io.github.lunalobos.chess4kt/Notation

Notation

This enum represents the types of move notation supported by this library. This enum is used as an argument in functions related to move validation and generation logic.

Since

1.0.0-beta.1

Author

lunalobos

Entries

UCI

The long algebraic notation used in the Universal Chess Interface (UCI) protocol (e.g., e2e4, a7a8q).

SAN

The Standard Algebraic Notation (SAN) used in books and PGN files (e.g., Nf3, O-O, cxd4).

Properties

entries

val entries: EnumEntries<Notation>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

valueOf

fun valueOf(value: String): Notation

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<Notation>

Returns an array containing the constants of this enum type, in the order they're declared.