Methods

addNag(nag)

game.js, line 727

Add the given NAG to the current move.

Parameters:

Name	Type	Description
nag	number

addVariation(isLongVariation) → {Variation}

game.js, line 879

Create a new variation that can be played instead of the current move.

Parameters:

Name	Type	Description
isLongVariation	boolean

Returns:

Variation

comment() → nullable {string}

game.js, line 803

Get the text comment associated to the current move.

Returns:

string -

undefined if no comment is defined for the move.

comment(value, isLongCommentopt)

game.js, line 803

Set the text comment associated to the current move.

Parameters:

Name	Type	Attributes	Default	Description
value	string
isLongComment	boolean	<optional>	false

figurineNotation() → {string}

game.js, line 609

SAN-like representation of the move associated to the current node (or '--' for a null-move).

Returns:

string -

Chess pieces are represented with their respective unicode character, instead of the first letter of their English name.

fullMoveNumber() → {number}

game.js, line 641

Full-move number. It starts at 1, and is incremented after each black move.

Returns:

number

hasNag(nag) → {boolean}

game.js, line 714

Check whether the current move has the given NAG or not.

Parameters:

Name	Type	Description
nag	number

Returns:

boolean

id() → {string}

game.js, line 514

Identifier of the current node within its parent Game.

WARNING: the ID may change when variations are modified (added, removed, swapped, promoted...) among the parents the current node.

Returns:

string

isLongComment() → {boolean}

game.js, line 819

Whether the text comment associated to the current move is long or short.

Returns:

boolean -

Always false if no comment is defined.

isVariation() → {boolean}

game.js, line 524

Always false. Useful to discrimate between Node and Variation instances.

Returns:

boolean

moveColor() → {Color}

game.js, line 651

Color the side corresponding to the current move.

Returns:

Color

nags() → {Array.<number>}

game.js, line 699

Return the NAGs associated to the current move.

Returns:

Array.<number> -

Sorted array.

next() → nullable {Node}

game.js, line 661

Return the Node that comes after the current one in their parent variation.

Returns:

Node -

undefined if the current node is the last one of the variation.

notation() → {string}

game.js, line 599

SAN representation of the move associated to the current node (or '--' for a null-move).

Returns:

string

parentVariation() → {Variation}

game.js, line 546

Return the Variation that owns the current node.

Returns:

Variation

play(move) → {Node}

game.js, line 853

Play the given move, and return a new Node pointing at the resulting position.

Parameters:

Name	Type	Description
move	string	SAN notation (or '--' for a null-move).

Throws:

If the move notation cannot be parsed.

Type

module:exception.InvalidNotation

Returns:

Node -

A new node, pointing at the new position.

position() → {Position}

game.js, line 629

Chess position obtained after the current move.

Returns:

Position

positionBefore() → {Position}

game.js, line 619

Chess position before the current move.

Returns:

Position

previous() → nullable {Node}

game.js, line 557

Return the Node that comes before the current one in their parent variation.

Returns:

Node -

undefined if the current node is the first one of the variation.

promoteVariation(variationIndex)

game.js, line 924

Replace the move on the current node (and the following ones, if any) by the moves of the variation corresponding to the given index, and create a new variation with the move on the current node and its successors.

WARNING: the promoted variation must NOT be empty.

Parameters:

Name	Type	Description
variationIndex	number	Index of the variation to promote (must be such that 0 <= variationIndex < thisNode.variations().length). If the corresponding variation is empty, an exception is thrown.

removeFollowingMoves()

game.js, line 868

Erase all the moves after the one on the current Node: after that, Node#next returns undefined. If the current Node is already the last one in its variation (i.e. if Node#next returns undefined already), nothing happens.

removeNag(nag)

game.js, line 740

Remove the given NAG from the current move.

Parameters:

Name	Type	Description
nag	number

removeVariation(variationIndex)

game.js, line 890

Remove the variation corresponding to the given index.

Parameters:

Name	Type	Description
variationIndex	number	Index of the variation to promote (must be such that 0 <= variationIndex < thisNode.variations().length).

swapVariations(variationIndex1, variationIndex2)

game.js, line 904

Change the order of the variations by swapping the two variations corresponding to the given indexes.

Parameters:

Name	Type	Description
variationIndex1	number	Index of one variation to swap (must be such that 0 <= variationIndex1 < thisNode.variations().length).
variationIndex2	number	Index of the other variation to swap (must be such that 0 <= variationIndex2 < thisNode.variations().length).

tag(tagKey) → nullable {string}

game.js, line 775

Get the value associated to the given tag key on the current move.

Parameters:

Name	Type	Description
tagKey	string

Returns:

string -

undefined if no value is associated to this tag key on the current move.

tag(tagKey, valuenullable)

game.js, line 775

Set the value associated to the given tag key on the current move.

Parameters:

Name	Type	Attributes	Description
tagKey	string
value	string	<nullable>

tags() → {Array.<string>}

game.js, line 753

Return the keys of the tags associated to the current move.

Returns:

Array.<string> -

Sorted array.

variations() → {Array.<Variation>}

game.js, line 676

Return the variations that can be followed instead of the current move.

Returns:

Array.<Variation>