core/io.github.lunalobos.chess4kt.js/Tournament

Tournament

class Tournament

Instances of this class can manage tournament logic.

This is a facade created to enable exporting the code to JS, though it can also be used directly within the JS modules of any KMP project.

Properties

val activeMatches: JsReadonlyArray<Match>

Current matches being played.

var completed: Boolean

Whether the tournament has reached its conclusion.

finishedMatches

val finishedMatches: JsReadonlyArray<Match>

All concluded matches in the tournament history.

val id: Any?

The unique identifier for this tournament.

val idGenerator: () -> Any?

Unique ID generator for assigning identifiers to match objects.

var impactFactor: Double

The K-factor that determines how much a single match affects the rating. A higher value leads to faster rating changes. Default is 32.0.

val leaderboard: JsReadonlyArray<Player>

Current player standings, ordered by score and tie-breakers.

var logisticBase: Double

The base of the exponent in the logistic function. Default is 10.

val name: String?

The display name of the tournament.

var rangeFactor: Double

The scale factor used to determine win probability. Default is 400.0.

var tiebreakers: JsArray<String>

Tournament's tiebreakers.

val timeControl: String?

The specific time settings for the matches (e.g., "3+2", "10|0"). Returns null if no specific time control has been defined.

val type: String?

The category of the tournament based on the time control (e.g., "blitz", "bullet", "rapid").

Functions

fun addMatch(white: String, black: String?, outcome: String, id: Any?, round: Int?): Boolean

Adds a match to the tournament for the specified round. This method is ideal for cases where external logic is being used or an instance is being reconstructed.

fun addPlayer(player: Player)

Adds a player to the tournament. Player's name most be unique.

fun nextRound(): JsReadonlyArray<Match>

Generates a list of new pairings.

fun removePlayer(player: Player)

Removes a player from the tournament