Class ScoreService

constructor

• new ScoreService(): ScoreService

• Returns ScoreService

Optional loseSceneBuilder

onLose

onWin

stopWatch

Optional winSceneBuilder

addToGoodieCount

• addToGoodieCount(which, amount): void

• Update a goodie count by adding a number to it

  Parameters

  • which: 0 | 1 | 2 | 3

    Which goodie counter (0, 1, 2, or 3)

  • amount: number

    How much should be added to it (can be negative!)

  Returns void

getDestinationArrivals

• getDestinationArrivals(): number

• Return the number of heroes that have arrived at a destination so far

  Returns number

getEnemiesCreated

• getEnemiesCreated(): number

• Return the number of enemies created

  Returns number

getEnemiesDefeated

• getEnemiesDefeated(): number

• Return the number of enemies defeated

  Returns number

getGoodieCount

• getGoodieCount(which): number

• Return a goodie counter's value

  Parameters

  • which: 0 | 1 | 2 | 3

    Which goodie counter (0, 1, 2, or 3)

  Returns number

getHeroesCreated

• getHeroesCreated(): number

• Return the number of heroes that have been defeated so far

  Returns number

getHeroesDefeated

• getHeroesDefeated(): number

• Return the number of heroes that have been defeated so far

  Returns number

getLoseCountdownRemaining

• getLoseCountdownRemaining(): undefined | number

• Return the time left on the lose countdown

  Returns undefined | number

getStopwatch

• getStopwatch(): number

• Return the time on the stopwatch

  Returns number

getWinCountdownRemaining

• getWinCountdownRemaining(): undefined | number

• Return the time left on the win countdown

  Returns undefined | number

loseLevel

• loseLevel(): void

• When a playable level is lost, we run this code to shut it down, show an overlay, and then invoke the JetLagManager to choose the next stage

  Returns void

onClockTick

• onClockTick(elapsedMs): void

• On every clock tick, update the countdowns and stopwatch. It may lead to the level being won or lost.

  Parameters

  • elapsedMs: number

    The milliseconds that have passed

  Returns void

onDefeatHero

• onDefeatHero(): void

• Indicate that a hero has been defeated. This may cause the level to be lost.

  Returns void

onDestinationArrive

• onDestinationArrive(): void

• When a hero arrives at a destination, decide whether it means it is time for the game to be won.

  Returns void

onEnemyCreated

• onEnemyCreated(): void

• Indicate that an enemy has been created

  Returns void

onEnemyDefeated

• onEnemyDefeated(): void

• Indicate that an enemy was defeated. This may cause the level to be won

  Returns void

onGoodieCollected

• onGoodieCollected(): void

• Record that a goodie was collected, and possibly end the level

  Returns void

onHeroCreated

• onHeroCreated(): void

• Indicate that a hero has been created

  Returns void

reset

• reset(): void

• Reset all the scores at the beginning of a new level

  Returns void

setGoodieCount

• setGoodieCount(which, amount): void

• Update a goodie count by overwriting its value

  Parameters

  • which: 0 | 1 | 2 | 3

    Which goodie counter (0, 1, 2, or 3)

  • amount: number

    The new value

  Returns void

setLoseCountdownRemaining

• setLoseCountdownRemaining(amount): void

• Change the amount of time left on the lose countdown

  Parameters

  • amount: number

    The new time remaining

  Returns void

setStopwatch

• setStopwatch(amount): void

• Change the amount of time on the stopwatch

  Parameters

  • amount: number

    The new stopwatch value

  Returns void

setVictoryDestination

• setVictoryDestination(count): void

• Indicate that the level should be won by some number of heroes reaching the destination

  Parameters

  • count: number

    The number of heroes that must reach the destination

  Returns void

setVictoryEnemyCount

• setVictoryEnemyCount(count?): void

• Indicate that the level is won by defeating a certain number of enemies or by defeating all of the enemies, if not given an argument.

  Parameters

  • Optional count: number

    The number of enemies that must be defeated to win the level. Leave blank if the answer is "all"

  Returns void

setVictoryGoodies

• setVictoryGoodies(v0, v1, v2, v3): void

• Indicate that the level is won by collecting enough goodies. To win, all four goodie counts must be equal or greater than the values given to this function.

  Parameters

  • v0: number

    Number of type-0 goodies that must be collected to win the level

  • v1: number

    Number of type-1 goodies that must be collected to win the level

  • v2: number

    Number of type-2 goodies that must be collected to win the level

  • v3: number

    Number of type-3 goodies that must be collected to win the level

  Returns void

setVictorySurvive

• setVictorySurvive(duration): void

• Indicate that the level is won by surviving for long enough

  Parameters

  • duration: number

    How long the hero must survive, in seconds

  Returns void

setWinCountdownRemaining

• setWinCountdownRemaining(amount): void

• Change the amount of time left on the win countdown

  Parameters

  • amount: number

    The new time remaining

  Returns void

winLevel

• winLevel(): void

• When a playable level is won, we run this code to shut it down, show an overlay, and then invoke the JetLagManager to choose the next stage

  Returns void