API Docs for: 0.0.2
Show:

chess.model.Game Class

Defined in: ../api/src/model/game.js:1
Module: Model

Chess game model

Methods

activate

()

Defined in ../api/src/model/game.js:126

Activate model. This will fire newGame and setPosition events

addAction

(
  • action
)

Defined in ../api/src/model/game.js:1282

Add action as a move. Actions are not fully implemented. When implemented, it will add supports for interactive chess games, example: start and stop autoplay. Display comments, videos or audio etc.

Parameters:

appendMove

(
  • move
)
Boolean

Defined in ../api/src/model/game.js:562

Append move to the model

Parameters:

Returns:

Boolean: success

Example:

var model = new chess.model.Game();
model.appendMove({ 'from': 'e2', 'to' : 'e4' }); // Using objects
model.appendMove('e7'); // Using notation
alert(model.getCurrentPosition());

back

(
  • numberOfMoves
)
Boolean

Defined in ../api/src/model/game.js:957

Back up x number of moves

Parameters:

Returns:

Boolean:

canClaimDraw

() Boolean

Defined in ../api/src/model/game.js:488

Returns true if user can claim draw in current position

Returns:

Boolean: can claim draw

clearCurrentMove

() private

Defined in ../api/src/model/game.js:934

Delete current move reference. This method is called when creating a new game and when first move in the game is deleted

clearMovesInBranch

(
  • branch
  • fromIndex
)
private

Defined in ../api/src/model/game.js:911

Delete moves from branch, i.e. main line or variation

Parameters:

deleteMove

(
  • moveToDelete
)

Defined in ../api/src/model/game.js:803

Delete a move. This method will fire the deleteMove and endOfBranch events. If deleted move is in main line, the endOfGame event will also be fired. The event "noMoves" will be fired if the deleted move is the first move in the game. "deleteVariation" will be fired if the deleted move is the first move in a variation.

Parameters:

findMove

(
  • moveToFind
)
chess.model.Move

Defined in ../api/src/model/game.js:925

Parameters:

Returns:

chess.model.Move:

fire

(
  • eventName
  • param
)
private

Defined in ../api/src/model/game.js:1463

Parameters:

getAllFens

() Array

Defined in ../api/src/model/game.js:497

Returns array of all FEN's in main line(Not variations)

Returns:

Array:

getAllNextMoves

(
  • nextOf
)
Array

Defined in ../api/src/model/game.js:536

Returns array of remaining moves

Parameters:

Returns:

Array:

getBranch

(
  • move
)
Array private

Defined in ../api/src/model/game.js:289

Return branch/line of current move, i.e. main line or variation

Parameters:

Returns:

Array:

getColorToMove

() String

Defined in ../api/src/model/game.js:1041

Return color to move, "white" or "black"

Returns:

String:

getCommentAfter

(
  • move
)
String

Defined in ../api/src/model/game.js:1386

Get comment of current move

Parameters:

Returns:

String: comment

getCommentBefore

(
  • move
)
String

Defined in ../api/src/model/game.js:1370

Return comment before move, i.e. get comment of previous move

Parameters:

Returns:

String: comment

getCurrentBranch

() Array

Defined in ../api/src/model/game.js:1061

Return branch, i.e. main line or variation of current move

Returns:

Array:

getCurrentMove

() chess.model.Move

Defined in ../api/src/model/game.js:1052

Returns current move, i.e. last played move

Returns:

chess.model.Move:

getCurrentPosition

() String

Defined in ../api/src/model/game.js:774

Returns fen of current move or start of game fen

Returns:

String:

getDatabaseId

() Number

Defined in ../api/src/model/game.js:1521

Return database id of game

Returns:

Number:

getDuplicateVariationMove

(
  • move
)
chess.model.Move | Undefined

Defined in ../api/src/model/game.js:742

Returns true if current move already has a variation starting with given move

Parameters:

Returns:

chess.model.Move | Undefined:

getFirstMoveInGame

() chess.model.Move

Defined in ../api/src/model/game.js:1156

Return first move in game

Returns:

chess.model.Move:

getId

() String

Defined in ../api/src/model/game.js:68

Returns game id

Returns:

String:

getLastMoveInGame

() chess.model.Move | Undefined

Defined in ../api/src/model/game.js:511

Return last move in game

Returns:

chess.model.Move | Undefined: move

getLastPositionInGame

() String

Defined in ../api/src/model/game.js:523

Return last position in game

Returns:

String: fen

getMetadata

() Object

Defined in ../api/src/model/game.js:353

Return all game metadata info

Returns:

Object:

Example:

    var m = model.getMetadata();
 returns an object like

    { "white": "Magnus Carlsen", "black": "Levon Aronian", "Result" : "1-0" }

getMetadataValue

(
  • key
)
String

Defined in ../api/src/model/game.js:366

Return a specific metadata key

Parameters:

Returns:

String: value

Example:

var whitePlayer = model.getMetadataValue('white');

getModel

() Object private

Defined in ../api/src/model/game.js:210

Return game data

Returns:

Object:

getMoves

() Array

Defined in ../api/src/model/game.js:378

Return array of moves in game

Returns:

Array:

getNextMove

(
  • nextOf
)
chess.model.Move | Undefined

Defined in ../api/src/model/game.js:1252

Get next move of

Parameters:

Returns:

chess.model.Move | Undefined: next move

getParentMove

(
  • move
)
chess.model.Move | Undefined

Defined in ../api/src/model/game.js:1171

Return parent move of given move, i.e. parent move of a move in a variation.

Parameters:

Returns:

chess.model.Move | Undefined:

getPreviousMove

(
  • move
  • includeComments
)
chess.model.Move | Undefined

Defined in ../api/src/model/game.js:1210

Returns previous move in same branch or parent branch

Parameters:

Returns:

chess.model.Move | Undefined:

getPreviousMoveInBranch

(
  • move
)
chess.model.Move | Undefined private

Defined in ../api/src/model/game.js:1185

Returns previous move in same branch/line or undefined

Parameters:

Returns:

chess.model.Move | Undefined:

getPreviousPosition

() String

Defined in ../api/src/model/game.js:786

Returns fen of previous move or start of game fen

Returns:

String:

getResult

() Number

Defined in ../api/src/model/game.js:457

Return result of game, either from metadata("result") or by trying to calculate final position. Return value will be 1 for white win, -1 for black win. 0.5 for draw and 0 for undecided.

Returns:

Number:

getStartPosition

() String

Defined in ../api/src/model/game.js:387

Return start position of game

Returns:

String: position

getValidMetadata

()

Defined in ../api/src/model/game.js:192

Move metadata into metadata object

getValidMove

(
  • move
  • pos
)
chess.model.Move private

Defined in ../api/src/model/game.js:675

Returns valid chess.model.Move object for a move

Parameters:

Returns:

chess.model.Move:

goToMove

(
  • move
)

Defined in ../api/src/model/game.js:946

Go to a specific move.

Parameters:

gradeMove

(
  • move
  • grade
)

Defined in ../api/src/model/game.js:1300

Grade a move

Parameters:

Example:

    model.gradeMove(model.getCurrentMove(), '!');
    ...
    ...
    model.gradeMove(model.getCurrentMove(), '??');

hasCurrentMove

() Boolean

Defined in ../api/src/model/game.js:1147

Returns rue if current move is set

Returns:

Boolean:

hasMovesInBranch

(
  • branch
)
Boolean private

Defined in ../api/src/model/game.js:892

Returns true if there are moves left in branch

Parameters:

Returns:

Boolean:

insertSpacerInBranch

(
  • branch
  • atIndex
)

Defined in ../api/src/model/game.js:1353

Insert space for new move in a branch at index

Parameters:

isAtEndOfGame

() Boolean

Defined in ../api/src/model/game.js:880

true if move displayed on board, i.e. current model move is last move in game.

Returns:

Boolean:

isChessMove

(
  • move
)
Boolean private

Defined in ../api/src/model/game.js:1452

Returns true if passed move is a valid chess move

Parameters:

Returns:

Boolean:

isCorrectGuess

(
  • guess
  • nextMove
)
Boolean private

Defined in ../api/src/model/game.js:433

Returns true if passed guess matches next move

Parameters:

Returns:

Boolean:

isDirty

() Boolean

Defined in ../api/src/model/game.js:1559

Return dirty flag. dirty flag is set to true when game has been changed, but not saved.

Returns:

Boolean:

isDuplicateVariationMove

(
  • move
)
Boolean

Defined in ../api/src/model/game.js:732

Returns true when trying to create variation and passed move is next move in line

Parameters:

Returns:

Boolean:

isInAutoPlayMode

() Boolean

Defined in ../api/src/model/game.js:1512

Returns true if in auto play mode

Returns:

Boolean:

isLastMoveInVariation

(
  • move
)
Boolean

Defined in ../api/src/model/game.js:864

true if given move is last move in current variation, i.e. the variation active on the board

Parameters:

Returns:

Boolean:

isModelFor

(
  • game
)

Defined in ../api/src/model/game.js:108

Returns true if this model is model for given game object

Parameters:

loadGame

(
  • gameId
)

Defined in ../api/src/model/game.js:77

Load a game from server

Parameters:

loadRandomGame

(
  • databaseId
)

Defined in ../api/src/model/game.js:89

Load a random game from selected database

Parameters:

newGame

()

Defined in ../api/src/model/game.js:119

Empty model and reset to standard position

newVariation

(
  • move
)

Defined in ../api/src/model/game.js:690

Add a new move as a variation. If current move is already first move in variation it will go to this move and not create a new variation. This method will fire the events "newVariation", "newMove" and "endOfBranch" on success. "invalidMove" will be fired on invalid move.

Parameters:

Returns:

undefined

newVariationBranch

() private

Defined in ../api/src/model/game.js:762

Create new variation branch

nextAutoPlayMove

() private

Defined in ../api/src/model/game.js:1496

Auto play next move

nextMove

()

Defined in ../api/src/model/game.js:1084

Go to next move

overwriteMove

(
  • oldMove
  • newMove
)

Defined in ../api/src/model/game.js:659

Overwrite a move with a different move. oldMove has to be a move in the game. When found, this move and all following move will be deleted and the new move will be appended.

Parameters:

populate

(
  • gameData
)
private

Defined in ../api/src/model/game.js:166

Populate game model by JSON game object. This method will create a new game.

Parameters:

previousMove

()

Defined in ../api/src/model/game.js:1070

Go to previous move

registerBranchMap

(
  • move
  • branch
)
private

Defined in ../api/src/model/game.js:278

Store internal link between move and a branch of moves(Main line or variation)

Parameters:

registerMove

(
  • move
  • atIndex
)
private

Defined in ../api/src/model/game.js:1325

Internally index a move

Parameters:

registerMoves

(
  • moves
  • pos
  • parent
)
private

Defined in ../api/src/model/game.js:220

Parse and index moves received from the server, i.e. the populate method

Parameters:

registerParentMap

(
  • move
  • parent
)
private

Defined in ../api/src/model/game.js:267

Store internal reference to parent move

Parameters:

registerPreviousMap

(
  • move
  • previous
)
private

Defined in ../api/src/model/game.js:257

Store internal reference to previous move

Parameters:

resetPosition

()

Defined in ../api/src/model/game.js:1001

Call goToMove for current move and trigger the events. This method is called when overwrite of move is cancelled from game editor and when you're guessing the wrong move in a tactic puzzle

save

()

Defined in ../api/src/model/game.js:1568

Save model to server

setClean

() private

Defined in ../api/src/model/game.js:1544

Set dirty flag to false, i.e. game has been changed and saved

setComment

(
  • move
  • comment
)

Defined in ../api/src/model/game.js:1441

Set comment property of a move

Parameters:

setCommentAfter

(
  • comment
  • move
)

Defined in ../api/src/model/game.js:1428

Set comment after a move

Parameters:

setCommentBefore

(
  • comment
  • move
)

Defined in ../api/src/model/game.js:1400

Set comment before a move, i.e. set comment of previous move, or in case of first move in game, set "commment" attribute of game metadata.

Parameters:

setCurrentMove

(
  • newCurrentMove
)
Boolean private

Defined in ../api/src/model/game.js:1014

Parameters:

Returns:

Boolean: success

setDefaultModel

()

Defined in ../api/src/model/game.js:300

Reset model data to default, blank game

setDirty

() private

Defined in ../api/src/model/game.js:1530

Set dirty flag to true, i.e. game has been changed but not saved.

setMetadata

(
  • metadata
)

Defined in ../api/src/model/game.js:318

Update game information

Parameters:

Example:

model.setMetadata({white:'John','black:'Jane'});

setMetadataValue

(
  • key
  • value
)

Defined in ../api/src/model/game.js:332

Update particular info about the game

Parameters:

Example:

model.setMetadataValue('white','John');

setPosition

(
  • fen
)

Defined in ../api/src/model/game.js:147

Create new game from given fen position

Parameters:

startAutoPlay

()

Defined in ../api/src/model/game.js:1478

Start auto play of moves

startAutoPlay

()

Defined in ../api/src/model/game.js:1487

Stop auto play of moves

toEnd

()

Defined in ../api/src/model/game.js:1118

Go to last move in game

toEndOfCurrentBranch

()

Defined in ../api/src/model/game.js:1131

Go to last move in current branch, i.e. main line or variation

toStart

()

Defined in ../api/src/model/game.js:1101

Go to start of game

toValidServerModel

(
  • gameData
)
Object private

Defined in ../api/src/model/game.js:1576

Convert to valid server model, i.e. reserved metadata moved from metadata object

Parameters:

Returns:

Object:

tryNextMove

(
  • move
)
Boolean

Defined in ../api/src/model/game.js:396

Try to guess next move in a game

Parameters:

Returns:

Boolean: correctMove

Example:

    var correctMove = model.tryNextMove({
        from:'e7',
        to:'e8',
        promoteTo:'queen'
    });

updateGameFromServer

(
  • data
)
private

Defined in ../api/src/model/game.js:1596

Receive game update from server

Parameters:

Attributes

id

Number optional

Defined in ..\api\src\model\game.js:34

id of initial game to load from server.

Default: undefined

moveParser

chess.parser.FenParser0x88

Defined in ..\api\src\model\game.js:12

Fires event moveParserChange

Fires when the value for the configuration attribute moveParser is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

Events

deleteAction

Defined in ..\api\src\model\game.js:818

Special event not yet implemented. Supporting for adding info to games such as video links, automatic start and stop of auto play for lecture purpose will be added as actions later.

Event Payload:

deleteMove

Defined in ..\api\src\model\game.js:828

Fired when a move is deleted. It will only be fired for one move and not the following moves which of course also will be deleted.

Event Payload:

dirty

Defined in ..\api\src\model\game.js:1551

Event fired when model is clean, i.e. right after being saved to the server.

Event Payload:

dirty

Defined in ..\api\src\model\game.js:1537

Event fired when model is changed but not saved

Event Payload:

endOfBranch

Defined in ..\api\src\model\game.js:636

Fired when current move is last move in game.

Event Payload:

endOfBranch

Defined in ..\api\src\model\game.js:646

Fired when you try to append an invalid move to the game

Event Payload:

endOfBranch

Defined in ..\api\src\model\game.js:628

Fired when current move is last move in branch, either last move in game or last move inside a variation.

Event Payload:

newGame

Defined in ..\api\src\model\game.js:131

new game event. Fired when a new model is created or an old model is activated

Event Payload:

newMove

Defined in ..\api\src\model\game.js:620

Fired when a new move is appended to the game.

Event Payload:

newVariation

Defined in ..\api\src\model\game.js:715

Fired after creating a new variation

Event Payload:

noMoves

Defined in ..\api\src\model\game.js:155

Fired when there are no moves in the game

Event Payload:

notEndOfGame

Defined in ..\api\src\model\game.js:841

Fired when going to a move which is not last move in game

Event Payload:

overwriteOrVariation

Defined in ..\api\src\model\game.js:600

Fired when appending a move in the middle of a game. This method sends a message to the controller saying that it needs to know if appended move should be added as variation or if it should overwrite current next move

Event Payload:

setPosition

Defined in ..\api\src\model\game.js:138

Fired when current chess position is changed, example by moving to a different move

Event Payload:

updateMetadata

Defined in ..\api\src\model\game.js:342

Fired when metadata is updated

Event Payload:

verifyPromotion

Defined in ..\api\src\model\game.js:579

verify promotion event. This event is fired when you try to append a promotion move where the promoteTo info is missing

Event Payload: