core/io.github.lunalobos.chess4kt/Square

Square

This enum represents the squares on the chessboard. The order is set such that when calling ordinal, the integer 0 corresponds to A1, 1 corresponds to B1, and so on, following the file-major order (A1, B1, C1... H1, A2, B2... H8), with 63 corresponding to H8.

Since

1.0.0-beta.1

Author

lunalobos

Entries

Types

Companion

object Companion

Properties

entries

val entries: EnumEntries<Square>

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

getCol

fun getCol(): Int

Returns the zero-based index of the column (file) for this square. The index starts at 0 for the A-file and ends at 7 for the H-file.

getRow

fun getRow(): Int

Returns the zero-based index of the row (rank) for this square. The index starts at 0 for the 1st rank and ends at 7 for the 8th rank.

valueOf

fun valueOf(value: String): Square

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<Square>

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