Pre-release
AdventureJS Docs Downloads
Score: 0 Moves: 0

Class:Scorecard

constructor description methods properties

Defined in: adventure/Scorecard.js, line 5

Framework class

Description

Scorecard is a repository for Game score options. Scorecard is created automatically by Game. This is an internal class that authors should not need to construct. However, authors can set scoring options from their game file as shown below, and call score updates from custom scripts.

Example:

var MyGame = new adventurejs.Game( "MyGame", "GameDisplay" );
MyGame.scorecard.set({
  score_events: {
    "unlock door": { points: 1, complete: false, bonus: false, message: '', recorded: false },
    "unlock chest": { points: 1, complete: false, bonus: false, recorded: message: '', false },
    "drink potion": { points: 1, complete: false, bonus: false, recorded: message: '', false },
  }
});

Private Constructor:

var foo = new adventurejs.Scorecard(game)

Parameters:

  • game Game
    A reference to the game instance.
Inherited Overrides

Methods Collapse all  |  Expand all

aggregateUpdates
aggregateUpdates()

Defined in: adventure/Scorecard.js, line 118

Print score updates in the aggregate.
completeEvent
completeEvent(event) → {Boolean}

Defined in: adventure/Scorecard.js, line 75

Parameters:

  • event String
    A string matching an event key.
Mark the selected event as complete and update the score.

Returns:

Boolean
createEvent
createEvent() → {String}

Defined in: adventure/Scorecard.js, line 59

Create a new event.

Returns:

String
set
set(props) → {adventurejs.Scorecard}

Defined in: adventure/Scorecard.js, line 186

Parameters:

  • props Object
    A generic object containing properties to copy to the instance.
Provides a chainable shortcut method for setting a number of properties on the instance.

Returns:

adventurejs.Scorecard Returns the instance the method is called on (useful for chaining calls.)
setScore
setScore()

Defined in: adventure/Scorecard.js, line 174

Format the score/total before printing it to display.
stackUpdates
stackUpdates()

Defined in: adventure/Scorecard.js, line 140

Print score updates in a stack.
updateScore
updateScore()

Defined in: adventure/Scorecard.js, line 87

Get the current score.

Properties  |