diff --git a/libs/core/_locales/core-jsdoc-strings.json b/libs/core/_locales/core-jsdoc-strings.json index 6b91e893..0afa7384 100644 --- a/libs/core/_locales/core-jsdoc-strings.json +++ b/libs/core/_locales/core-jsdoc-strings.json @@ -72,13 +72,13 @@ "game": "A single-LED sprite game engine", "game.addLife": "Adds life points to the current life", "game.addLife|param|lives": "TODO", - "game.addScore": "Adds points to the current score", + "game.addScore": "Adds points to the current score and shows an animation", "game.addScore|param|points": "amount of points to change, eg: 1", "game.createSprite": "Creates a new LED sprite pointing to the right.", "game.createSprite|param|x": "sprite horizontal coordinate, eg: 2", "game.createSprite|param|y": "sprite vertical coordinate, eg: 2", "game.currentTime": "Gets the remaining time (since `start countdown`) or current time (since the device started or `start stopwatch`) in milliseconds.", - "game.gameOver": "Displays a game over animation.", + "game.gameOver": "Displays a game over animation and the score.", "game.invalidSprite": "Gets an invalid sprite; used to initialize locals.", "game.isGameOver": "Indicates if the game is display the game over sequence.", "game.isRunning": "Gets a value indicating if the game is still running. Returns `false` if game over.", @@ -93,7 +93,7 @@ "game.setScore": "Sets the current score value", "game.setScore|param|value": "new score value.", "game.showScore": "Displays the score on the screen.", - "game.startCountdown": "Starts a game countdown timer", + "game.startCountdown": "Shows an animation, then starts a game countdown timer, which causes Game Over when it reaches 0", "game.startCountdown|param|ms": "countdown duration in milliseconds, eg: 10000", "game.startStopwatch": "Starts a stopwatch timer. `current time` will return the elapsed time.", "images": "Creation, manipulation and display of LED images.", diff --git a/libs/core/game.ts b/libs/core/game.ts index bfa79ee9..12c67b60 100644 --- a/libs/core/game.ts +++ b/libs/core/game.ts @@ -59,7 +59,7 @@ namespace game { } /** - * Adds points to the current score + * Adds points to the current score and shows an animation * @param points amount of points to change, eg: 1 */ //% weight=10 help=game/add-score @@ -78,7 +78,7 @@ namespace game { } /** - * Starts a game countdown timer + * Shows an animation, then starts a game countdown timer, which causes Game Over when it reaches 0 * @param ms countdown duration in milliseconds, eg: 10000 */ //% weight=9 help=game/start-countdown @@ -102,7 +102,7 @@ namespace game { } /** - * Displays a game over animation. + * Displays a game over animation and the score. */ //% weight=8 help=game/game-over //% blockId=game_game_over block="game over" @@ -306,7 +306,7 @@ namespace game { } /** - * Move a certain number of LEDs + * Move a certain number of LEDs in the current direction * @param this the sprite to move * @param leds number of leds to move, eg: 1, -1 */ @@ -356,7 +356,7 @@ namespace game { } /** - * If touching the edge of the stage, then bounce away. + * If touching the edge of the stage and facing towards it, then turn away. * @param this TODO */ //% weight=18 @@ -568,7 +568,7 @@ namespace game { } /** - * Reports true if sprite is touching specified sprite + * Reports true if sprite has the same position as specified sprite * @param this TODO * @param other TODO */