Class Game

Get the name of the annotator.

Set the name of the annotator.

Return a human-readable string representing the game. This string is multi-line, and is intended to be displayed in a fixed-width font (similarly to an ASCII-art picture).

Clear all the headers (player names, elos, titles, event name, date, etc...).

The result header is reseted to its default value. The initial position and moves are not modified.

Get the date of the game.

Set the date of the game.

Set the date of the game.

If the month and/or the day of month are missing, the date of the game will be partially defined (see DateValue for more details regarding partially defined dates).

Get the date of the game as a standard JavaScript Date object.

If the day of month is undefined for the current game, the returned Date object points at the first day of the corresponding month. If neither the day of month nor the month are undefined for the current game, the returned Date object points at the first day of the corresponding year.

Get the date of the game as a human-readable string (e.g. 'November 1955', 'September 4, 2021').

Get the ECO code.

Set the ECO code.

Get the event.

Set the event.

Chess position at the end of the game.

Return the node or variation corresponding to the given ID (see Node.id and Variation.id to retrieve the ID of a node or variation).

Returns

undefined if the given ID does not correspond to an existing Node and Variation.

Get the round, sub-round and sub-sub-round as a human-readable string, the 3 components being separated by dot characters.

Full-move number at which the game starts.

Get the initial position of the game.

Set the initial position of the game.

The main variation of the game.

Return the nodes corresponding to the moves of the main variation.

Get the name of the opening.

Set the name of the opening.

Get the name of the opening sub-variation.

Set the name of the opening sub-variation.

Get the name of the opening variation.

Set the name of the opening variation.

Get the elo of the player corresponding to the given color.

If defined, the returned value is guaranteed to be an integer >= 0.

Set the elo of the player corresponding to the given color.

Get the name of the player corresponding to the given color.

Set the name of the player corresponding to the given color.

Get the title of the player corresponding to the given color.

Set the title of the player corresponding to the given color.

Number of half-moves in the main variation.

For instance, after 1.e4 e5 2.Nf3, the number of half-moves if 3 (2 white moves + 1 black move).

Return the POJO representation of the current Game. To be used for JSON serialization, deep cloning, etc...

Get the result of the game.

Set the result of the game.

Get the round.

Set the round.

Get where the game takes place.

Set where the game takes place.

Get the sub-round.

Set the sub-round.

Get the sub-sub-round.

Set the sub-sub-round.

Get the reason of the conclusion of the game. Examples of possible values:

• 'normal': game terminated in a normal fashion,
• 'time forfeit': loss due to losing player's failure to meet time control requirements,
• 'adjudication': result due to third party adjudication process,
• 'death': losing player called to greater things, one hopes,
• 'emergency': game concluded due to unforeseen circumstances,
• etc...

This list is not exhaustive and any string is valid value for this field.

Set the name of the opening sub-variation.

Get the chess game variant of the game.

Decode the POJO passed in argument, assuming it follows the schema defined by GamePOJO.

Throws

InvalidPOJO if the given object cannot be decoded, either because it does not follow the schema defined by GamePOJO, or because it would result in an inconsistent game (e.g. if it contains some invalid moves).