melonjs 14.0.2 → 14.1.0

package/src/level/level.js

@@ -51,10 +51,10 @@ function safeLoadLevel(levelId, options, restart) {
  * @name loadTMXLevel
  * @memberof level
  * @private
- * @param {string} levelId level id
- * @param {Container} container target container
- * @param {boolean} [flatten=true] if true, flatten all objects into the given container
- * @param {boolean} [setViewportBounds=false] if true, set the viewport bounds to the map size, this should be set to true especially if adding a level to the game world container.
+ * @param {string} levelId - level id
+ * @param {Container} container - target container
+ * @param {boolean} [flatten=true] - if true, flatten all objects into the given container
+ * @param {boolean} [setViewportBounds=false] - if true, set the viewport bounds to the map size, this should be set to true especially if adding a level to the game world container.
  * @ignore
  */
 function loadTMXLevel(levelId, container, flatten, setViewportBounds) {
@@ -84,9 +84,9 @@ var level = {
      * @name add
      * @memberof level
      * @public
-     * @param {string} format level format (only "tmx" supported)
-     * @param {string} levelId the level id (or name)
-     * @param {Function} [callback] a function to be called once the level is loaded
+     * @param {string} format - level format (only "tmx" supported)
+     * @param {string} levelId - the level id (or name)
+     * @param {Function} [callback] - a function to be called once the level is loaded
      * @returns {boolean} true if the level was loaded
      */
     add(format, levelId, callback) {
@@ -122,12 +122,12 @@ var level = {
      * @name load
      * @memberof level
      * @public
-     * @param {string} levelId level id
-     * @param {object} [options] additional optional parameters
-     * @param {Container} [options.container=game.world] container in which to load the specified level
-     * @param {Function} [options.onLoaded=game.onLevelLoaded] callback for when the level is fully loaded
-     * @param {boolean} [options.flatten=game.mergeGroup] if true, flatten all objects into the given container
-     * @param {boolean} [options.setViewportBounds=true] if true, set the viewport bounds to the map size
+     * @param {string} levelId - level id
+     * @param {object} [options] - additional optional parameters
+     * @param {Container} [options.container=game.world] - container in which to load the specified level
+     * @param {Function} [options.onLoaded=game.onLevelLoaded] - callback for when the level is fully loaded
+     * @param {boolean} [options.flatten=game.mergeGroup] - if true, flatten all objects into the given container
+     * @param {boolean} [options.setViewportBounds=true] - if true, set the viewport bounds to the map size
      * @returns {boolean} true if the level was successfully loaded
      * @example
      * // the game assets to be be preloaded
@@ -219,10 +219,10 @@ var level = {
      * @name reload
      * @memberof level
      * @public
-     * @param {object} [options] additional optional parameters
-     * @param {Container} [options.container=game.world] container in which to load the specified level
-     * @param {Function} [options.onLoaded=game.onLevelLoaded] callback for when the level is fully loaded
-     * @param {boolean} [options.flatten=game.mergeGroup] if true, flatten all objects into the given container
+     * @param {object} [options] - additional optional parameters
+     * @param {Container} [options.container=game.world] - container in which to load the specified level
+     * @param {Function} [options.onLoaded=game.onLevelLoaded] - callback for when the level is fully loaded
+     * @param {boolean} [options.flatten=game.mergeGroup] - if true, flatten all objects into the given container
      * @returns {object} the current level
      */
     reload(options) {
@@ -236,10 +236,10 @@ var level = {
      * @name next
      * @memberof level
      * @public
-     * @param {object} [options] additional optional parameters
-     * @param {Container} [options.container=game.world] container in which to load the specified level
-     * @param {Function} [options.onLoaded=game.onLevelLoaded] callback for when the level is fully loaded
-     * @param {boolean} [options.flatten=game.mergeGroup] if true, flatten all objects into the given container
+     * @param {object} [options] - additional optional parameters
+     * @param {Container} [options.container=game.world] - container in which to load the specified level
+     * @param {Function} [options.onLoaded=game.onLevelLoaded] - callback for when the level is fully loaded
+     * @param {boolean} [options.flatten=game.mergeGroup] - if true, flatten all objects into the given container
      * @returns {boolean} true if the next level was successfully loaded
      */
     next(options) {
@@ -257,10 +257,10 @@ var level = {
      * @name previous
      * @memberof level
      * @public
-     * @param {object} [options] additional optional parameters
-     * @param {Container} [options.container=game.world] container in which to load the specified level
-     * @param {Function} [options.onLoaded=game.onLevelLoaded] callback for when the level is fully loaded
-     * @param {boolean} [options.flatten=game.mergeGroup] if true, flatten all objects into the given container
+     * @param {object} [options] - additional optional parameters
+     * @param {Container} [options.container=game.world] - container in which to load the specified level
+     * @param {Function} [options.onLoaded=game.onLevelLoaded] - callback for when the level is fully loaded
+     * @param {boolean} [options.flatten=game.mergeGroup] - if true, flatten all objects into the given container
      * @returns {boolean} true if the previous level was successfully loaded
      */
     previous(options) {

package/src/level/tiled/TMXLayer.js

@@ -70,13 +70,13 @@ function preRenderLayer(layer, renderer) {
  */
 class TMXLayer extends Renderable {
     /**
-     * @param {object} map layer data in JSON format ({@link http://docs.mapeditor.org/en/stable/reference/tmx-map-format/#layer})
-     * @param {object} data layer data in JSON format ({@link http://docs.mapeditor.org/en/stable/reference/tmx-map-format/#layer})
-     * @param {number} tilewidth width of each tile in pixels
-     * @param {number} tileheight height of each tile in pixels
-     * @param {string} orientation "isometric" or "orthogonal"
-     * @param {TMXTilesetGroup} tilesets tileset as defined in Tiled
-     * @param {number} z z-index position
+     * @param {object} map - layer data in JSON format ({@link http://docs.mapeditor.org/en/stable/reference/tmx-map-format/#layer})
+     * @param {object} data - layer data in JSON format ({@link http://docs.mapeditor.org/en/stable/reference/tmx-map-format/#layer})
+     * @param {number} tilewidth - width of each tile in pixels
+     * @param {number} tileheight - height of each tile in pixels
+     * @param {string} orientation - "isometric" or "orthogonal"
+     * @param {TMXTilesetGroup} tilesets - tileset as defined in Tiled
+     * @param {number} z - z-index position
      */
     constructor(map, data, tilewidth, tileheight, orientation, tilesets, z) {
         // super constructor
@@ -278,8 +278,8 @@ class TMXLayer extends Renderable {
      * @name getTileId
      * @memberof TMXLayer
      * @public
-     * @param {number} x X coordinate (in world/pixels coordinates)
-     * @param {number} y Y coordinate (in world/pixels coordinates)
+     * @param {number} x - X coordinate (in world/pixels coordinates)
+     * @param {number} y - Y coordinate (in world/pixels coordinates)
      * @returns {number} TileId or null if there is no Tile at the given position
      */
     getTileId(x, y) {
@@ -292,8 +292,8 @@ class TMXLayer extends Renderable {
      * @name getTile
      * @memberof TMXLayer
      * @public
-     * @param {number} x X coordinate (in world/pixels coordinates)
-     * @param {number} y Y coordinate (in world/pixels coordinates)
+     * @param {number} x - X coordinate (in world/pixels coordinates)
+     * @param {number} y - Y coordinate (in world/pixels coordinates)
      * @returns {Tile} corresponding tile or null if there is no defined tile at the coordinate or if outside of the layer bounds
      * @example
      * // get the TMX Map Layer called "Front layer"
@@ -317,9 +317,9 @@ class TMXLayer extends Renderable {
      * @name getTile
      * @memberof TMXLayer
      * @public
-     * @param {Tile} tile the tile object to be assigned
-     * @param {number} x x coordinate (in world/pixels coordinates)
-     * @param {number} y y coordinate (in world/pixels coordinates)
+     * @param {Tile} tile - the tile object to be assigned
+     * @param {number} x - x coordinate (in world/pixels coordinates)
+     * @param {number} y - y coordinate (in world/pixels coordinates)
      * @returns {Tile} the tile object
      */
     setTile(tile, x, y) {
@@ -332,9 +332,9 @@ class TMXLayer extends Renderable {
      * @name setTile
      * @memberof TMXLayer
      * @public
-     * @param {number} tileId tileId
-     * @param {number} x X coordinate (in world/pixels coordinates)
-     * @param {number} y Y coordinate (in world/pixels coordinates)
+     * @param {number} tileId - tileId
+     * @param {number} x - X coordinate (in world/pixels coordinates)
+     * @param {number} y - Y coordinate (in world/pixels coordinates)
      * @returns {Tile} the tile object
      */
     getTileById(tileId, x, y) {
@@ -350,9 +350,9 @@ class TMXLayer extends Renderable {
      * @name cellAt
      * @memberof TMXLayer
      * @public
-     * @param {number} x x position of the tile (in Tile unit)
-     * @param {number} y x position of the tile (in Tile unit)
-     * @param {number} [boundsCheck=true] check first if within the layer bounds
+     * @param {number} x - x position of the tile (in Tile unit)
+     * @param {number} y - x position of the tile (in Tile unit)
+     * @param {number} [boundsCheck=true] - check first if within the layer bounds
      * @returns {Tile} corresponding tile or null if there is no defined tile at the position or if outside of the layer bounds
      * @example
      * // return the first tile at offset 0, 0
@@ -376,8 +376,8 @@ class TMXLayer extends Renderable {
      * @name clearTile
      * @memberof TMXLayer
      * @public
-     * @param {number} x X coordinate (in map coordinates: row/column)
-     * @param {number} y Y coordinate (in map coordinates: row/column)
+     * @param {number} x - X coordinate (in map coordinates: row/column)
+     * @param {number} y - Y coordinate (in map coordinates: row/column)
      * @example
      * me.game.world.getChildByType(me.TMXLayer).forEach(function(layer) {
      *     // clear all tiles at the given x,y coordinates

package/src/level/tiled/TMXTile.js

@@ -15,10 +15,10 @@ const TMX_FLIP_H          = 0x80000000,
  */
 class Tile extends Bounds {
     /**
-     * @param {number} x x index of the Tile in the map
-     * @param {number} y y index of the Tile in the map
-     * @param {number} gid tile gid
-     * @param {TMXTileset} tileset the corresponding tileset object
+     * @param {number} x - x index of the Tile in the map
+     * @param {number} y - y index of the Tile in the map
+     * @param {number} gid - tile gid
+     * @param {TMXTileset} tileset - the corresponding tileset object
      */
     constructor(x, y, gid, tileset) {
         var width, height;
@@ -132,7 +132,7 @@ class Tile extends Bounds {
      * return a renderable object for this Tile object
      * @name Tile#getRenderable
      * @public
-     * @param {object} [settings] see {@link Sprite}
+     * @param {object} [settings] - see {@link Sprite}
      * @returns {Renderable} a me.Sprite object
      */
     getRenderable(settings) {

package/src/level/tiled/TMXTileMap.js

@@ -105,8 +105,8 @@ function readObjectGroup(map, data, z) {
  */
 class TMXTileMap {
     /**
-     * @param {string} levelId name of TMX map
-     * @param {object} data TMX map in JSON format
+     * @param {string} levelId - name of TMX map
+     * @param {object} data - TMX map in JSON format
      * @example
      * // create a new level object based on the TMX JSON object
      * var level = new me.TMXTileMap(levelId, me.loader.getTMX(levelId));
@@ -361,9 +361,9 @@ class TMXTileMap {
      * note : this will not automatically update the camera viewport
      * @name TMXTileMap#addTo
      * @public
-     * @param {Container} container target container
-     * @param {boolean} [flatten=true] if true, flatten all objects into the given container, else a `me.Container` object will be created for each corresponding groups
-     * @param {boolean} [setViewportBounds=false] if true, set the viewport bounds to the map size, this should be set to true especially if adding a level to the game world container.
+     * @param {Container} container - target container
+     * @param {boolean} [flatten=true] - if true, flatten all objects into the given container, else a `me.Container` object will be created for each corresponding groups
+     * @param {boolean} [setViewportBounds=false] - if true, set the viewport bounds to the map size, this should be set to true especially if adding a level to the game world container.
      * @example
      * // create a new level object based on the TMX JSON object
      * var level = new me.TMXTileMap(levelId, me.loader.getTMX(levelId));
@@ -437,7 +437,7 @@ class TMXTileMap {
      * return an Array of instantiated objects, based on the map object definition
      * @name TMXTileMap#getObjects
      * @public
-     * @param {boolean} [flatten=true] if true, flatten all objects into the returned array.
+     * @param {boolean} [flatten=true] - if true, flatten all objects into the returned array.
      * when false, a `me.Container` object will be created for each corresponding groups
      * @returns {Renderable[]} Array of Objects
      */

package/src/level/tiled/TMXTileset.js

@@ -10,7 +10,7 @@ import loader from "./../../loader/loader.js";
  */
 class TMXTileset {
     /**
-     *  @param {object} tileset tileset data in JSON format ({@link http://docs.mapeditor.org/en/stable/reference/tmx-map-format/#tileset})
+     *  @param {object} tileset - tileset data in JSON format ({@link http://docs.mapeditor.org/en/stable/reference/tmx-map-format/#tileset})
      */
     constructor(tileset) {
         var i = 0;
@@ -206,7 +206,7 @@ class TMXTileset {
      * Get the view (local) tile ID from a GID, with animations applied
      * @name TMXTileset#getViewTileId
      * @public
-     * @param {number} gid Global tile ID
+     * @param {number} gid - Global tile ID
      * @returns {number} View tile ID
      */
     getViewTileId(gid) {

package/src/level/tiled/TMXUtils.js

@@ -99,8 +99,8 @@ function parseAttributes(obj, elt) {
  * decompress zlib/gzip data (NOT IMPLEMENTED)
  * @ignore
  * @name decompress
- * @param  {number[]} data Array of bytes
- * @param  {string} format compressed data format ("gzip","zlib")
+ * @param  {number[]} data- -  Array of bytes
+ * @param  {string} format- -  compressed data format ("gzip","zlib")
  */
 export function decompress() {
     throw new Error("GZIP/ZLIB compressed TMX Tile Map not supported!");
@@ -110,7 +110,7 @@ export function decompress() {
  * Decode a CSV encoded array into a binary array
  * @ignore
  * @name decodeCSV
- * @param  {string} input CSV formatted data (only numbers, everything else will be converted to NaN)
+ * @param  {string} input- -  CSV formatted data (only numbers, everything else will be converted to NaN)
  * @returns {number[]} Decoded data
  */
 export function decodeCSV(input) {
@@ -127,8 +127,8 @@ export function decodeCSV(input) {
  * Decode a base64 encoded string into a byte array
  * @ignore
  * @name decodeBase64AsArray
- * @param {string} input Base64 encoded data
- * @param {number} [bytes] number of bytes per array entry
+ * @param {string} input - Base64 encoded data
+ * @param {number} [bytes] - number of bytes per array entry
  * @returns {Uint32Array} Decoded data
  */
 export function decodeBase64AsArray(input, bytes) {

package/src/level/tiled/renderer/TMXHexagonalRenderer.js

@@ -26,7 +26,7 @@ const offsetsStaggerY = [
  */
 class TMXHexagonalRenderer extends TMXRenderer {
     /**
-     * @param {TMXTileMap} map the TMX map
+     * @param {TMXTileMap} map - the TMX map
      */
     constructor(map) {
         super(
@@ -81,7 +81,7 @@ class TMXHexagonalRenderer extends TMXRenderer {
      * return the bounding rect for this map renderer
      * @name TMXHexagonalRenderer#getBounds
      * @public
-     * @param {TMXLayer} [layer] calculate the bounding rect for a specific layer (will return a new bounds object)
+     * @param {TMXLayer} [layer] - calculate the bounding rect for a specific layer (will return a new bounds object)
      * @returns {Bounds}
      */
     getBounds(layer) {

package/src/level/tiled/renderer/TMXIsometricRenderer.js

@@ -11,7 +11,7 @@ import TMXLayer from "./../TMXLayer.js";
  */
 class TMXIsometricRenderer extends TMXRenderer {
     /**
-     * @param {TMXTileMap} map the TMX map
+     * @param {TMXTileMap} map - the TMX map
      */
     constructor(map) {
         super(
@@ -41,7 +41,7 @@ class TMXIsometricRenderer extends TMXRenderer {
      * return the bounding rect for this map renderer
      * @name TMXIsometricRenderer#getBounds
      * @public
-     * @param {TMXLayer} [layer] calculate the bounding rect for a specific layer (will return a new bounds object)
+     * @param {TMXLayer} [layer] - calculate the bounding rect for a specific layer (will return a new bounds object)
      * @returns {Bounds}
      */
     getBounds(layer) {

package/src/level/tiled/renderer/TMXOrthogonalRenderer.js

@@ -9,7 +9,7 @@ import TMXRenderer from "./TMXRenderer.js";
  */
 class TMXOrthogonalRenderer extends TMXRenderer {
     /**
-     * @param {TMXTileMap} map the TMX map
+     * @param {TMXTileMap} map - the TMX map
      */
     constructor(map) {
         super(

package/src/level/tiled/renderer/TMXRenderer.js

@@ -10,10 +10,10 @@ import Bounds from "./../../../physics/bounds.js";
  */
 class TMXRenderer {
     /**
-     * @param {number} cols width of the tilemap in tiles
-     * @param {number} rows height of the tilemap in tiles
-     * @param {number} tilewidth width of each tile in pixels
-     * @param {number} tileheight height of each tile in pixels
+     * @param {number} cols - width of the tilemap in tiles
+     * @param {number} rows - height of the tilemap in tiles
+     * @param {number} tilewidth - width of each tile in pixels
+     * @param {number} tileheight - height of each tile in pixels
      */
     constructor(cols, rows, tilewidth, tileheight) {
         this.cols = cols;
@@ -27,7 +27,7 @@ class TMXRenderer {
      * return true if the renderer can render the specified map or layer
      * @name TMXRenderer#canRender
      * @public
-     * @param {TMXTileMap|TMXLayer} component TMX Map or Layer
+     * @param {TMXTileMap|TMXLayer} component - TMX Map or Layer
      * @returns {boolean}
      */
     canRender(component) {
@@ -47,7 +47,7 @@ class TMXRenderer {
      * return the bounding rect for this map renderer
      * @name TMXRenderer#getBounds
      * @public
-     * @param {TMXLayer} [layer] calculate the bounding rect for a specific layer (will return a new bounds object)
+     * @param {TMXLayer} [layer] - calculate the bounding rect for a specific layer (will return a new bounds object)
      * @returns {Bounds}
      */
     getBounds(layer) {
@@ -64,9 +64,9 @@ class TMXRenderer {
      * return the tile position corresponding to the specified pixel
      * @name TMXRenderer#pixelToTileCoords
      * @public
-     * @param {number} x X coordinate
-     * @param {number} y Y coordinate
-     * @param {Vector2d} [v] an optional vector object where to put the return values
+     * @param {number} x - X coordinate
+     * @param {number} y - Y coordinate
+     * @param {Vector2d} [v] - an optional vector object where to put the return values
      * @returns {Vector2d}
      */
     pixelToTileCoords(x, y, v) {
@@ -77,9 +77,9 @@ class TMXRenderer {
      * return the pixel position corresponding of the specified tile
      * @name TMXRenderer#tileToPixelCoords
      * @public
-     * @param {number} col tile horizontal position
-     * @param {number} row tile vertical position
-     * @param {Vector2d} [v] an optional vector object where to put the return values
+     * @param {number} col - tile horizontal position
+     * @param {number} row - tile vertical position
+     * @param {Vector2d} [v] - an optional vector object where to put the return values
      * @returns {Vector2d}
      */
     tileToPixelCoords(col, row, v) {
@@ -90,10 +90,10 @@ class TMXRenderer {
      * draw the given tile at the specified layer
      * @name TMXRenderer#drawTile
      * @public
-     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
-     * @param {number} x X coordinate where to draw the tile
-     * @param {number} y Y coordinate where to draw the tile
-     * @param {Tile} tile the tile object to draw
+     * @param {CanvasRenderer|WebGLRenderer} renderer - a renderer object
+     * @param {number} x - X coordinate where to draw the tile
+     * @param {number} y - Y coordinate where to draw the tile
+     * @param {Tile} tile - the tile object to draw
      */
     drawTile(renderer, x, y, tile) {
     }
@@ -102,9 +102,9 @@ class TMXRenderer {
      * draw the given TMX Layer for the given area
      * @name TMXRenderer#drawTileLayer
      * @public
-     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
-     * @param {TMXLayer} layer a TMX Layer object
-     * @param {Rect} rect the area of the layer to draw
+     * @param {CanvasRenderer|WebGLRenderer} renderer - a renderer object
+     * @param {TMXLayer} layer - a TMX Layer object
+     * @param {Rect} rect - the area of the layer to draw
      */
     drawTileLayer(renderer, layer, rect) {
     }

package/src/loader/loader.js

@@ -441,8 +441,8 @@ var loader = {
      * @name setBaseURL
      * @memberof loader
      * @public
-     * @param {string} type  "*", "audio", binary", "image", "json", "js", "tmx", "tsx"
-     * @param {string} [url="./"] default base URL
+     * @param {string} type  - "*", "audio", binary", "image", "json", "js", "tmx", "tsx"
+     * @param {string} [url="./"] - default base URL
      * @example
      * // change the base URL relative address for audio assets
      * me.loader.setBaseURL("audio", "data/audio/");
@@ -472,12 +472,12 @@ var loader = {
      * @memberof loader
      * @public
      * @param {object[]} res
-     * @param {string} res.name internal name of the resource
-     * @param {string} res.type  "audio", binary", "image", "json","js", "tmx", "tsx", "fontface"
-     * @param {string} res.src  path and/or file name of the resource (for audio assets only the path is required)
-     * @param {boolean} [res.stream] Set to true to force HTML5 Audio, which allows not to wait for large file to be downloaded before playing.
-     * @param {Function} [onload=loader.onload] function to be called when all resources are loaded
-     * @param {boolean} [switchToLoadState=true] automatically switch to the loading screen
+     * @param {string} res.name - internal name of the resource
+     * @param {string} res.type  - "audio", binary", "image", "json","js", "tmx", "tsx", "fontface"
+     * @param {string} res.src  - path and/or file name of the resource (for audio assets only the path is required)
+     * @param {boolean} [res.stream] - Set to true to force HTML5 Audio, which allows not to wait for large file to be downloaded before playing.
+     * @param {Function} [onload=loader.onload] - function to be called when all resources are loaded
+     * @param {boolean} [switchToLoadState=true] - automatically switch to the loading screen
      * @example
      * game_resources = [
      *   // PNG tileset
@@ -540,12 +540,12 @@ var loader = {
      * @memberof loader
      * @public
      * @param {object} res
-     * @param {string} res.name internal name of the resource
-     * @param {string} res.type  "audio", binary", "image", "json", "tmx", "tsx"
-     * @param {string} res.src  path and/or file name of the resource (for audio assets only the path is required)
-     * @param {boolean} [res.stream] Set to true to force HTML5 Audio, which allows not to wait for large file to be downloaded before playing.
-     * @param {Function} [onload] function to be called when the resource is loaded
-     * @param {Function} [onerror] function to be called in case of error
+     * @param {string} res.name - internal name of the resource
+     * @param {string} res.type  - "audio", binary", "image", "json", "tmx", "tsx"
+     * @param {string} res.src  - path and/or file name of the resource (for audio assets only the path is required)
+     * @param {boolean} [res.stream] - Set to true to force HTML5 Audio, which allows not to wait for large file to be downloaded before playing.
+     * @param {Function} [onload] - function to be called when the resource is loaded
+     * @param {Function} [onerror] - function to be called in case of error
      * @returns {number} the amount of corresponding resource to be preloaded
      * @example
      * // load an image asset
@@ -610,8 +610,8 @@ var loader = {
      * @memberof loader
      * @public
      * @param {object} res
-     * @param {string} res.name internal name of the resource
-     * @param {string} res.type  "audio", binary", "image", "json", "tmx", "tsx"
+     * @param {string} res.name - internal name of the resource
+     * @param {string} res.type  - "audio", binary", "image", "json", "tmx", "tsx"
      * @returns {boolean} true if unloaded
      * @example me.loader.unload({name: "avatar",  type:"image"});
      */
@@ -724,7 +724,7 @@ var loader = {
      * @name getTMX
      * @memberof loader
      * @public
-     * @param {string} elt name of the tmx/tsx element ("map1");
+     * @param {string} elt - name of the tmx/tsx element ("map1");
      * @returns {object} requested element or null if not found
      */
     getTMX(elt) {
@@ -741,7 +741,7 @@ var loader = {
      * @name getBinary
      * @memberof loader
      * @public
-     * @param {string} elt name of the binary object ("ymTrack");
+     * @param {string} elt - name of the binary object ("ymTrack");
      * @returns {object} requested element or null if not found
      */
     getBinary(elt) {
@@ -758,7 +758,7 @@ var loader = {
      * @name getImage
      * @memberof loader
      * @public
-     * @param {string} image name of the Image element ("tileset-platformer");
+     * @param {string} image - name of the Image element ("tileset-platformer");
      * @returns {HTMLImageElement} requested element or null if not found
      */
     getImage(image) {
@@ -776,7 +776,7 @@ var loader = {
      * @name getJSON
      * @memberof loader
      * @public
-     * @param {string} elt name of the json file to load
+     * @param {string} elt - name of the json file to load
      * @returns {object}
      */
     getJSON(elt) {

package/src/math/color.js

@@ -184,10 +184,10 @@ var cssToRGB = new Map();
  */
 class Color {
     /**
-     * @param {number} [r=0] red component or array of color components
-     * @param {number} [g=0] green component
-     * @param {number} [b=0] blue component
-     * @param {number} [alpha=1.0] alpha value
+     * @param {number} [r=0] - red component or array of color components
+     * @param {number} [g=0] - green component
+     * @param {number} [b=0] - blue component
+     * @param {number} [alpha=1.0] - alpha value
      */
     constructor(r = 0, g = 0, b = 0, alpha = 1.0) {
         this.onResetEvent(r, g, b, alpha);
@@ -257,10 +257,10 @@ class Color {
 
     /**
      * Set this color to the specified value.
-     * @param {number} r red component [0 .. 255]
-     * @param {number} g green component [0 .. 255]
-     * @param {number} b blue component [0 .. 255]
-     * @param {number} [alpha=1.0] alpha value [0.0 .. 1.0]
+     * @param {number} r - red component [0 .. 255]
+     * @param {number} g - green component [0 .. 255]
+     * @param {number} b - blue component [0 .. 255]
+     * @param {number} [alpha=1.0] - alpha value [0.0 .. 1.0]
      * @returns {Color} Reference to this object for method chaining
      */
     setColor(r, g, b, alpha = 1.0) {
@@ -273,9 +273,9 @@ class Color {
 
     /**
      * set this color to the specified HSV value
-     * @param {number} h hue (a value from 0 to 1)
-     * @param {number} s saturation (a value from 0 to 1)
-     * @param {number} v value (a value from 0 to 1)
+     * @param {number} h - hue (a value from 0 to 1)
+     * @param {number} s - saturation (a value from 0 to 1)
+     * @param {number} v - value (a value from 0 to 1)
      * @returns {Color} Reference to this object for method chaining
      */
     setHSV(h, s, v) {
@@ -300,9 +300,9 @@ class Color {
 
     /**
      * set this color to the specified HSL value
-     * @param {number} h hue (a value from 0 to 1)
-     * @param {number} s saturation (a value from 0 to 1)
-     * @param {number} l lightness (a value from 0 to 1)
+     * @param {number} h - hue (a value from 0 to 1)
+     * @param {number} s - saturation (a value from 0 to 1)
+     * @param {number} l - lightness (a value from 0 to 1)
      * @returns {Color} Reference to this object for method chaining
      */
     setHSL(h, s, l) {
@@ -375,7 +375,7 @@ class Color {
     /**
      * Linearly interpolate between this color and the given one.
      * @param {Color} color
-     * @param {number} alpha with alpha = 0 being this color, and alpha = 1 being the given one.
+     * @param {number} alpha - with alpha = 0 being this color, and alpha = 1 being the given one.
      * @returns {Color} Reference to this object for method chaining
      */
     lerp(color, alpha) {
@@ -403,8 +403,8 @@ class Color {
 
     /**
      * Generate random r,g,b values for this color object
-     * @param {number} [min=0] minimum value for the random range
-     * @param {number} [max=255] maxmium value for the random range
+     * @param {number} [min=0] - minimum value for the random range
+     * @param {number} [max=255] - maxmium value for the random range
      * @returns {Color} Reference to this object for method chaining
      */
     random(min = 0, max = 255) {
@@ -474,7 +474,7 @@ class Color {
      * Parse a Hex color ("#RGB", "#RGBA" or "#RRGGBB", "#RRGGBBAA" format) and set this color to
      * the corresponding r,g,b,a values
      * @param {string} hexColor
-     * @param {boolean} [argb = false] true if format is #ARGB, or #AARRGGBB (as opposed to #RGBA or #RGGBBAA)
+     * @param {boolean} [argb = false] - true if format is #ARGB, or #AARRGGBB (as opposed to #RGBA or #RGGBBAA)
      * @returns {Color} Reference to this object for method chaining
      */
     parseHex(hexColor, argb = false) {
@@ -530,7 +530,7 @@ class Color {
 
     /**
      * Pack this color into a Uint32 ARGB representation
-     * @param {number} [alpha=1.0] alpha value [0.0 .. 1.0]
+     * @param {number} [alpha=1.0] - alpha value [0.0 .. 1.0]
      * @returns {number}
      */
     toUint32(alpha = 1.0) {
@@ -590,7 +590,7 @@ class Color {
 
     /**
      * Get the color in "rgba(R,G,B,A)" format
-     * @param {number} [alpha=1.0] alpha value [0.0 .. 1.0]
+     * @param {number} [alpha=1.0] - alpha value [0.0 .. 1.0]
      * @returns {string}
      */
     toRGBA(alpha = this.alpha) {