Methods

annotator() → nullable {string}

game.js, line 260

Get the name of the annotator.

Returns:

string

annotator(valuenullable)

game.js, line 260

Set the name of the annotator.

Parameters:

Name	Type	Attributes	Description
value	*	<nullable>	If null or undefined, the existing value (if any) is erased.

ascii() → {string}

game.js, line 436

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).

Returns:

string

date() → {Date|Object|Object|undefined}

game.js, line 177

Get the date of the game.

Returns:

Date | Object | Object | undefined -

Depending on what is defined, the method returns the whole date, or just the year and the month, or just the year, or undefined.

date(value)

game.js, line 177

Set the date of the game.

Parameters:

Name	Type	Description
value	Date | Object | Object | undefined

dateAsString(localesnullable) → nullable {string}

game.js, line 215

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

Parameters:

Name	Type	Attributes	Description
locales	*	<nullable>	Locales to use to generate the result. If undefined, the default locale of the execution environment is used. See Intl documentation for more details.

Returns:

string

event() → nullable {string}

game.js, line 142

Get the event.

Returns:

string

event(valuenullable)

game.js, line 142

Set the event.

Parameters:

Name	Type	Attributes	Description
value	*	<nullable>	If null or undefined, the existing value (if any) is erased.

findById() → nullable {Node|Variation}

game.js, line 352

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:

Node | Variation -

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

initialPosition() → {Position}

game.js, line 315

Get the initial position of the game.

Returns:

Position

initialPosition(initialPosition, fullMoveNumberopt)

game.js, line 315

Set the initial position of the game.

WARNING: this resets the main variation.

Parameters:

Name	Type	Attributes	Default	Description
initialPosition	Position
fullMoveNumber	number	<optional>	1

mainVariation() → {Variation}

game.js, line 341

The main variation of the game.

Returns:

Variation

nodes(withSubVariationsopt) → {Array.<Node>}

game.js, line 409

Return the Node-s corresponding to the moves of the main variation.

Parameters:

Name	Type	Attributes	Default	Description
withSubVariations	boolean	<optional>	false	If true, the nodes of the sub-variations are also included in the result.

Returns:

Array.<Node> -

An empty array is returned if the main variation is empty.

playerElo(color) → nullable {string}

game.js, line 102

Get the player elo.

Parameters:

Name	Type	Description
color	Color

Returns:

string

playerElo(color, valuenullable)

game.js, line 102

Set the player elo.

Parameters:

Name	Type	Attributes	Description
color	Color
value	*	<nullable>	If null or undefined, the existing value (if any) is erased.

playerName(color) → nullable {string}

game.js, line 81

Get the player name.

Parameters:

Name	Type	Description
color	Color

Returns:

string

playerName(color, valuenullable)

game.js, line 81

Set the player name.

Parameters:

Name	Type	Attributes	Description
color	Color
value	*	<nullable>	If null or undefined, the existing value (if any) is erased.

playerTitle(color) → nullable {string}

game.js, line 123

Get the player title.

Parameters:

Name	Type	Description
color	Color

Returns:

string

playerTitle(color, valuenullable)

game.js, line 123

Set the player title.

Parameters:

Name	Type	Attributes	Description
color	Color
value	*	<nullable>	If null or undefined, the existing value (if any) is erased.

result() → {GameResult}

game.js, line 277

Get the result of the game.

Returns:

GameResult

result(value)

game.js, line 277

Set the result of the game.

Parameters:

Name	Type	Description
value	GameResult

round() → nullable {string}

game.js, line 159

Get the round.

Returns:

string

round(valuenullable)

game.js, line 159

Set the round.

Parameters:

Name	Type	Attributes	Description
value	*	<nullable>	If null or undefined, the existing value (if any) is erased.

site() → nullable {string}

game.js, line 243

Get where the game takes place.

Returns:

string

site(valuenullable)

game.js, line 243

Set where the game takes place.

Parameters:

Name	Type	Attributes	Description
value	*	<nullable>	If null or undefined, the existing value (if any) is erased.

variant() → {GameVariant}

game.js, line 296

Get the GameVariant of the game.

Returns:

GameVariant