core/io.github.lunalobos.chess4kt/Outcome

Outcome

Represents the final or current result of a tournament match. Each outcome defines the points awarded to both the white and black players, as well as a standard string representation used for display.

Since

1.0.0-beta.8

Author

lunalobos

Entries

White Wins: 1 point for White, 0 for Black.

Black Wins: 0 points for White, 1 for Black.

DRAW

Draw: 0.5 points for both players.

SUSPENDED

The match was suspended; no points are awarded.

IN_GAME

The match is ongoing; points remain at 0.0 until finished.

Properties

blackScore

val blackScore: Score

The Score assigned to the black player.

entries

val entries: EnumEntries<Outcome>

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

representation

val representation: String

The official notation for the result (e.g., "1-0").

whiteScore

val whiteScore: Score

The Score assigned to the white player.

Functions

toString

open override fun toString(): String

Returns the standard chess notation of the result.

valueOf

fun valueOf(value: String): Outcome

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

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