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

Game

class Game

Class for manipulating games. It allows starting a game from a configurable initial position and with various configuration options, such as the game type (match or analysis), and how to apply the three-fold repetition and 50-move rules.

This class implements Iterable, allowing easy traversal over the nodes of the main line. The toString function returns the game in PGN format.

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

ecoInfo

var ecoInfo: EcoInfo?

Stores the current ECO (Encyclopedia of Chess Openings) information for the main line. Setting this property will be ignored if the game is immutable (i.e., MATCH and result is set).

fiftyMoves

var fiftyMoves: Boolean

Indicates whether the 50-move half-move limit has been reached (non-terminal).

fiftyMovesRuleMode

val fiftyMovesRuleMode: String

Determines how the fifty-move rule is enforced for this game instance. Setting this property will be ignored if the game is immutable.

finalComment

var finalComment: String?

An optional comment placed immediately after the game's result tag in PGN. This comment is enclosed in braces {}. Setting this property will be ignored if the game is immutable.

finalEndLineComment

var finalEndLineComment: String?

An optional end-of-line comment placed immediately after the game's result tag in PGN. This comment follows a semicolon ; and extends until the end of the line. Setting this property will be ignored if the game is immutable.

fiveRepetitions

var fiveRepetitions: Boolean

Indicates whether a position has been repeated five times, leading to an automatic draw according to FIDE rules (terminal).

val id: Any?

A developer-provided unique identifier for serialization or tracking purposes (e.g., UUID or String).

result

var result: String?

The final result of the game. Setting this property will update the "Result" tag in tags and set the game as immutable if MATCH is used.

root

val root: Node

The root node of the game tree. The setter is protected if the game is immutable.

seventyFiveMoves

var seventyFiveMoves: Boolean

Indicates whether the 75-move half-move limit has been reached, leading to an automatic draw (terminal).

Functions

deleteBefore

fun Game.deleteBefore(node: Node): Node

Deletes all moves that preceded the provided node in the main line. The node (and its position) becomes the new effective start of the game, creating a new RootNode.

deleteFromExclusive

fun deleteFromExclusive(node: Node): Node

Deletes all moves (the main line continuation and any variations) that follow the provided node. The node provided remains in the game.

deleteFromInclusive

fun deleteFromInclusive(node: Node): Node

Deletes all moves (the main line continuation and any variations) that follow the provided node. The move represented by the node is effectively removed from the game.

getTag

fun getTag(name: String): String?

Retrieves the tag's value

setTag

fun setTag(name: String, value: String)

Sets a tag pair (name and value)

toAnalysis

fun toAnalysis(idSupplier: () -> Any? = { null }): Game

Creates a deep copy of this game, converting its mode to ANALYSIS and setting both repetition rules to AWARE. This makes the new instance fully mutable for analysis.

toString

open override fun toString(): String