melonjs 10.2.1 → 10.2.2

package/src/level/tiled/TMXTile.js

@@ -14,9 +14,9 @@ var TMX_FLIP_H          = 0x80000000,
  * @extends me.Bounds
  * @memberOf me
  * @constructor
- * @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 {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 {me.TMXTileset} tileset the corresponding tileset object
  */
 class Tile extends Bounds {
@@ -42,7 +42,7 @@ class Tile extends Bounds {
         /**
          * tileset
          * @public
-         * @type me.TMXTileset
+         * @type {me.TMXTileset}
          * @name me.Tile#tileset
          */
         this.tileset = tileset;
@@ -60,28 +60,28 @@ class Tile extends Bounds {
         /**
          * tileId
          * @public
-         * @type Number
+         * @type {number}
          * @name me.Tile#tileId
          */
         this.tileId = gid;
         /**
          * True if the tile is flipped horizontally<br>
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @name me.Tile#flipX
          */
         this.flippedX  = (this.tileId & TMX_FLIP_H) !== 0;
         /**
          * True if the tile is flipped vertically<br>
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @name me.Tile#flippedY
          */
         this.flippedY  = (this.tileId & TMX_FLIP_V) !== 0;
         /**
          * True if the tile is flipped anti-diagonally<br>
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @name me.Tile#flippedAD
          */
         this.flippedAD = (this.tileId & TMX_FLIP_AD) !== 0;
@@ -89,7 +89,7 @@ class Tile extends Bounds {
         /**
          * Global flag that indicates if the tile is flipped<br>
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @name me.Tile#flipped
          */
         this.flipped = this.flippedX || this.flippedY || this.flippedAD;
@@ -108,7 +108,6 @@ class Tile extends Bounds {
 
     /**
      * set the transformation matrix for this tile
-     * @return {me.Matrix2d) a transformation matrix
      * @ignore
      */
     setTileTransform(transform) {
@@ -135,8 +134,8 @@ class Tile extends Bounds {
      * @name me.Tile#getRenderable
      * @public
      * @function
-     * @param {Object} [settings] see {@link me.Sprite}
-     * @return {me.Renderable} a me.Sprite object
+     * @param {object} [settings] see {@link me.Sprite}
+     * @returns {me.Renderable} a me.Sprite object
      */
     getRenderable(settings) {
         var renderable;

package/src/level/tiled/TMXTileMap.js

@@ -106,8 +106,8 @@ function readObjectGroup(map, data, z) {
  * @class TMXTileMap
  * @memberOf me
  * @constructor
- * @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));
@@ -128,7 +128,7 @@ export default class TMXTileMap {
         /**
          * name of the tilemap
          * @public
-         * @type {String}
+         * @type {string}
          * @name me.TMXTileMap#name
          */
         this.name = levelId;
@@ -136,14 +136,14 @@ export default class TMXTileMap {
         /**
          * width of the tilemap in tiles
          * @public
-         * @type {Number}
+         * @type {number}
          * @name me.TMXTileMap#cols
          */
         this.cols = +data.width;
         /**
          * height of the tilemap in tiles
          * @public
-         * @type {Number}
+         * @type {number}
          * @name me.TMXTileMap#rows
          */
         this.rows = +data.height;
@@ -151,7 +151,7 @@ export default class TMXTileMap {
         /**
          * Tile width
          * @public
-         * @type {Number}
+         * @type {number}
          * @name me.TMXTileMap#tilewidth
          */
         this.tilewidth = +data.tilewidth;
@@ -159,7 +159,7 @@ export default class TMXTileMap {
         /**
          * Tile height
          * @public
-         * @type {Number}
+         * @type {number}
          * @name me.TMXTileMap#tileheight
          */
         this.tileheight = +data.tileheight;
@@ -167,7 +167,7 @@ export default class TMXTileMap {
         /**
          * is the map an infinite map
          * @public
-         * @type {Number}
+         * @type {number}
          * @default 0
          * @name me.TMXTileMap#infinite
          */
@@ -176,17 +176,17 @@ export default class TMXTileMap {
         /**
          * the map orientation type. melonJS supports “orthogonal”, “isometric”, “staggered” and “hexagonal”.
          * @public
-         * @type {String}
+         * @type {string}
          * @default "orthogonal"
          * @name me.TMXTileMap#orientation
          */
         this.orientation = data.orientation;
 
         /**
-        * the order in which tiles on orthogonal tile layers are rendered.
-        * (valid values are "left-down", "left-up", "right-down", "right-up")
+         * the order in which tiles on orthogonal tile layers are rendered.
+         * (valid values are "left-down", "left-up", "right-down", "right-up")
          * @public
-         * @type {String}
+         * @type {string}
          * @default "right-down"
          * @name me.TMXTileMap#renderorder
          */
@@ -195,7 +195,7 @@ export default class TMXTileMap {
         /**
          * the TMX format version
          * @public
-         * @type {String}
+         * @type {string}
          * @name me.TMXTileMap#version
          */
         this.version = data.version;
@@ -203,7 +203,7 @@ export default class TMXTileMap {
         /**
          * The Tiled version used to save the file (since Tiled 1.0.1).
          * @public
-         * @type {String}
+         * @type {string}
          * @name me.TMXTileMap#tiledversion
          */
         this.tiledversion = data.tiledversion;
@@ -261,7 +261,7 @@ export default class TMXTileMap {
      * @memberOf me.TMXTileMap
      * @public
      * @function
-     * @return {me.TMXRenderer} a TMX renderer
+     * @returns {me.TMXRenderer} a TMX renderer
      */
     getRenderer() {
         if ((typeof(this.renderer) === "undefined") || (!this.renderer.canRender(this))) {
@@ -275,7 +275,7 @@ export default class TMXTileMap {
      * @name me.TMXRenderer#getBounds
      * @public
      * @function
-     * @return {me.Bounds}
+     * @returns {me.Bounds}
      */
     getBounds() {
         // calculated in the constructor
@@ -369,7 +369,7 @@ export default class TMXTileMap {
      * @name me.TMXTileMap#addTo
      * @public
      * @function
-     * @param {me.Container} target container
+     * @param {me.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
@@ -404,8 +404,10 @@ export default class TMXTileMap {
         // sort everything (recursively)
         container.sort(true);
 
-
-        // callback funtion for the viewport resize event
+        /**
+         * callback funtion for the viewport resize event
+         * @ignore
+         */
         function _setBounds(width, height) {
             // adjust the viewport bounds if level is smaller
             viewport.setBounds(
@@ -442,7 +444,7 @@ export default class TMXTileMap {
      * @function
      * @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
-     * @return {me.Renderable[]} Array of Objects
+     * @returns {me.Renderable[]} Array of Objects
      */
     getObjects(flatten) {
         var objects = [];
@@ -589,7 +591,7 @@ export default class TMXTileMap {
      * @name me.TMXTileMap#getLayers
      * @public
      * @function
-     * @return {me.TMXLayer[]} Array of Layers
+     * @returns {me.TMXLayer[]} Array of Layers
      */
     getLayers() {
         // parse the map for objects

package/src/level/tiled/TMXTileset.js

@@ -10,7 +10,7 @@ import loader from "./../../loader/loader.js";
  * @class TMXTileset
  * @memberOf me
  * @constructor
- * @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})
  */
 export default class TMXTileset {
 
@@ -51,7 +51,7 @@ export default class TMXTileset {
         /**
          * Tileset contains animated tiles
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @name me.TMXTileset#isAnimated
          */
         this.isAnimated = false;
@@ -59,7 +59,7 @@ export default class TMXTileset {
         /**
          * true if the tileset is a "Collection of Image" Tileset
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @name me.TMXTileset#isCollection
          */
         this.isCollection = false;
@@ -67,7 +67,7 @@ export default class TMXTileset {
         /**
          * Tileset animations
          * @private
-         * @type Map
+         * @type {Map}
          * @name me.TMXTileset#animations
          */
         this.animations = new Map();
@@ -75,7 +75,7 @@ export default class TMXTileset {
         /**
          * Remember the last update timestamp to prevent too many animation updates
          * @private
-         * @type Map
+         * @type {Map}
          * @name me.TMXTileset#_lastUpdate
          */
         this._lastUpdate = 0;
@@ -173,8 +173,8 @@ export default class TMXTileset {
      * @name me.TMXTileset#getTileImage
      * @public
      * @function
-     * @param {Number} gid
-     * @return {Image} corresponding image or undefined
+     * @param {number} gid
+     * @returns {Image} corresponding image or undefined
      */
     getTileImage(gid) {
         return this.imageCollection[gid];
@@ -196,8 +196,8 @@ export default class TMXTileset {
      * @name me.TMXTileset#contains
      * @public
      * @function
-     * @param {Number} gid
-     * @return {Boolean}
+     * @param {number} gid
+     * @returns {boolean}
      */
     contains(gid) {
         return gid >= this.firstgid && gid <= this.lastgid;
@@ -208,8 +208,8 @@ export default class TMXTileset {
      * @name me.TMXTileset#getViewTileId
      * @public
      * @function
-     * @param {Number} gid Global tile ID
-     * @return {Number} View tile ID
+     * @param {number} gid Global tile ID
+     * @returns {number} View tile ID
      */
     getViewTileId(gid) {
         var localId = gid - this.firstgid;
@@ -227,8 +227,8 @@ export default class TMXTileset {
      * @name me.TMXTileset#getTileProperties
      * @public
      * @function
-     * @param {Number} tileId
-     * @return {Object}
+     * @param {number} tileId
+     * @returns {object}
      */
     getTileProperties(tileId) {
         return this.TileProperties[tileId];

package/src/level/tiled/TMXTilesetGroup.js

@@ -33,8 +33,8 @@ export default class TMXTilesetGroup {
      * @name me.TMXTilesetGroup#getTilesetByIndex
      * @public
      * @function
-     * @param {Number} i
-     * @return {me.TMXTileset} corresponding tileset
+     * @param {number} i
+     * @returns {me.TMXTileset} corresponding tileset
      */
     getTilesetByIndex(i) {
         return this.tilesets[i];
@@ -46,8 +46,8 @@ export default class TMXTilesetGroup {
      * @name me.TMXTilesetGroup#getTilesetByGid
      * @public
      * @function
-     * @param {Number} gid
-     * @return {me.TMXTileset} corresponding tileset
+     * @param {number} gid
+     * @returns {me.TMXTileset} corresponding tileset
      */
     getTilesetByGid(gid) {
         var invalidRange = -1;

package/src/level/tiled/TMXUtils.js

@@ -76,6 +76,9 @@ function setTMXValue(name, type, value) {
     return value;
 }
 
+/**
+ * @ignore
+ */
 function parseAttributes(obj, elt) {
     // do attributes
     if (elt.attributes && elt.attributes.length > 0) {
@@ -97,9 +100,8 @@ function parseAttributes(obj, elt) {
  * @ignore
  * @function
  * @name decompress
- * @param  {Number[]} data Array of bytes
- * @param  {String} format compressed data format ("gzip","zlib")
- * @return {Number[]} Decompressed data
+ * @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,8 +112,8 @@ export function decompress() {
  * @ignore
  * @function
  * @name decodeCSV
- * @param  {String} input CSV formatted data (only numbers, everything else will be converted to NaN)
- * @return {Number[]} Decoded data
+ * @param  {string} input CSV formatted data (only numbers, everything else will be converted to NaN)
+ * @returns {number[]} Decoded data
  */
 export function decodeCSV(input) {
     var entries = input.replace("\n", "").trim().split(",");
@@ -128,9 +130,9 @@ export function decodeCSV(input) {
  * @ignore
  * @function
  * @name decodeBase64AsArray
- * @param {String} input Base64 encoded data
- * @param {Number} [bytes] number of bytes per array entry
- * @return {Uint32Array} Decoded data
+ * @param {string} input Base64 encoded data
+ * @param {number} [bytes] number of bytes per array entry
+ * @returns {Uint32Array} Decoded data
  */
 export function decodeBase64AsArray(input, bytes) {
     bytes = bytes || 1;
@@ -149,9 +151,9 @@ export function decodeBase64AsArray(input, bytes) {
 };
 
 /**
-* Decode the given data
-* @ignore
-*/
+ * Decode the given data
+ * @ignore
+ */
 export function decode(data, encoding, compression) {
     compression = compression || "none";
     encoding = encoding || "none";

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

@@ -85,7 +85,7 @@ class TMXHexagonalRenderer extends TMXRenderer {
      * @public
      * @function
      * @param {me.TMXLayer} [layer] calculate the bounding rect for a specific layer (will return a new bounds object)
-     * @return {me.Bounds}
+     * @returns {me.Bounds}
      */
     getBounds(layer) {
         var bounds = layer instanceof TMXLayer ? pool.pull("Bounds") : this.bounds;

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

@@ -45,7 +45,7 @@ class TMXIsometricRenderer extends TMXRenderer {
      * @public
      * @function
      * @param {me.TMXLayer} [layer] calculate the bounding rect for a specific layer (will return a new bounds object)
-     * @return {me.Bounds}
+     * @returns {me.Bounds}
      */
     getBounds(layer) {
         var bounds = layer instanceof TMXLayer ? pool.pull("Bounds") : this.bounds;

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

@@ -10,10 +10,10 @@ import Bounds from "./../../../physics/Bounds.js";
  * @class TMXRenderer
  * @memberOf me
  * @constructor
- * @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
  */
 class TMXRenderer {
 
@@ -31,7 +31,7 @@ class TMXRenderer {
      * @public
      * @function
      * @param {me.TMXTileMap|me.TMXLayer} component TMX Map or Layer
-     * @return {boolean}
+     * @returns {boolean}
      */
     canRender(component) {
         return (
@@ -52,7 +52,7 @@ class TMXRenderer {
      * @public
      * @function
      * @param {me.TMXLayer} [layer] calculate the bounding rect for a specific layer (will return a new bounds object)
-     * @return {me.Bounds}
+     * @returns {me.Bounds}
      */
     getBounds(layer) {
         var bounds = layer instanceof TMXLayer ? pool.pull("Bounds") : this.bounds;
@@ -69,10 +69,10 @@ class TMXRenderer {
      * @name me.TMXRenderer#pixelToTileCoords
      * @public
      * @function
-     * @param {Number} x X coordinate
-     * @param {Number} y Y coordinate
-     * @param {me.Vector2d} [vector] an optional vector object where to put the return values
-     * @return {me.Vector2d}
+     * @param {number} x X coordinate
+     * @param {number} y Y coordinate
+     * @param {me.Vector2d} [v] an optional vector object where to put the return values
+     * @returns {me.Vector2d}
      */
     pixelToTileCoords(x, y, v) {
         return v;
@@ -83,12 +83,12 @@ class TMXRenderer {
      * @name me.TMXRenderer#tileToPixelCoords
      * @public
      * @function
-     * @param {Number} col tile horizontal position
-     * @param {Number} row tile vertical position
-     * @param {me.Vector2d} [vector] an optional vector object where to put the return values
-     * @return {me.Vector2d}
+     * @param {number} col tile horizontal position
+     * @param {number} row tile vertical position
+     * @param {me.Vector2d} [v] an optional vector object where to put the return values
+     * @returns {me.Vector2d}
      */
-    tileToPixelCoords(x, y, v) {
+    tileToPixelCoords(col, row, v) {
         return v;
     }
 
@@ -98,8 +98,8 @@ class TMXRenderer {
      * @public
      * @function
      * @param {me.CanvasRenderer|me.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 {number} x X coordinate where to draw the tile
+     * @param {number} y Y coordinate where to draw the tile
      * @param {me.Tile} tile the tile object to draw
      */
     drawTile(renderer, x, y, tile) {

package/src/loader/loader.js

@@ -102,6 +102,9 @@ function preloadFontFace(data, onload, onerror) {
  * @ignore
  */
 function preloadTMX(tmxData, onload, onerror) {
+    /**
+     * @ignore
+     */
     function addToTMXList(data) {
         // set the TMX content
         tmxList[tmxData.name] = data;
@@ -337,7 +340,7 @@ var loader = {
      * The "anonymous" keyword means that there will be no exchange of user credentials via cookies,
      * client-side SSL certificates or HTTP authentication as described in the Terminology section of the CORS specification.<br>
      * @public
-     * @type String
+     * @type {string}
      * @name crossOrigin
      * @default undefined
      * @memberOf me.loader
@@ -355,7 +358,7 @@ var loader = {
      * indicates whether or not cross-site Access-Control requests should be made using credentials such as cookies,
      * authorization headers or TLS client certificates. Setting withCredentials has no effect on same-site requests.
      * @public
-     * @type Boolean
+     * @type {boolean}
      * @name withCredentials
      * @default false
      * @memberOf me.loader
@@ -411,8 +414,8 @@ var loader = {
      * @memberOf me.loader
      * @public
      * @function
-     * @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/");
@@ -442,12 +445,12 @@ var loader = {
      * @memberOf me.loader
      * @public
      * @function
-     * @param {Object[]} resources
-     * @param {String} resources.name internal name of the resource
-     * @param {String} resources.type  "audio", binary", "image", "json","js", "tmx", "tsx", "fontface"
-     * @param {String} resources.src  path and/or file name of the resource (for audio assets only the path is required)
-     * @param {Boolean} [resources.stream] Set to true to force HTML5 Audio, which allows not to wait for large file to be downloaded before playing.
-     * @param {function} [onload=me.loader.onload] function to be called when all resources are loaded
+     * @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=me.loader.onload] function to be called when all resources are loaded
      * @param {boolean} [switchToLoadState=true] automatically switch to the loading screen
      * @example
      * game_resources = [
@@ -507,13 +510,14 @@ var loader = {
      * @memberOf me.loader
      * @public
      * @function
-     * @param {Object} resource
-     * @param {String} resource.name internal name of the resource
-     * @param {String} resource.type  "audio", binary", "image", "json", "tmx", "tsx"
-     * @param {String} resource.src  path and/or file name of the resource (for audio assets only the path is required)
-     * @param {Boolean} [resource.stream] Set to true to force HTML5 Audio, which allows not to wait for large file to be downloaded before playing.
+     * @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
+     * @returns {number} the amount of corresponding resource to be preloaded
      * @example
      * // load an image asset
      * me.loader.load({name: "avatar",  type:"image",  src: "data/avatar.png"}, this.onload.bind(this), this.onerror.bind(this));
@@ -576,8 +580,8 @@ var loader = {
      * @memberOf me.loader
      * @public
      * @function
-     * @param {Object} resource
-     * @return {Boolean} true if unloaded
+     * @param {object} res
+     * @returns {boolean} true if unloaded
      * @example me.loader.unload({name: "avatar",  type:"image",  src: "data/avatar.png"});
      */
     unload(res) {
@@ -691,8 +695,8 @@ var loader = {
      * @memberOf me.loader
      * @public
      * @function
-     * @param {String} tmx name of the tmx/tsx element ("map1");
-     * @return {XML|Object} requested element or null if not found
+     * @param {string} elt name of the tmx/tsx element ("map1");
+     * @returns {object} requested element or null if not found
      */
     getTMX(elt) {
         // force as string
@@ -709,8 +713,8 @@ var loader = {
      * @memberOf me.loader
      * @public
      * @function
-     * @param {String} name of the binary object ("ymTrack");
-     * @return {Object} requested element or null if not found
+     * @param {string} elt name of the binary object ("ymTrack");
+     * @returns {object} requested element or null if not found
      */
     getBinary(elt) {
         // force as string
@@ -727,8 +731,8 @@ var loader = {
      * @memberOf me.loader
      * @public
      * @function
-     * @param {String} image name of the Image element ("tileset-platformer");
-     * @return {HTMLImageElement} requested element or null if not found
+     * @param {string} image name of the Image element ("tileset-platformer");
+     * @returns {HTMLImageElement} requested element or null if not found
      */
     getImage(image) {
         // force as string and extract the base name
@@ -746,8 +750,8 @@ var loader = {
      * @memberOf me.loader
      * @public
      * @function
-     * @param {String} Name for the json file to load
-     * @return {Object}
+     * @param {string} elt name of the json file to load
+     * @returns {object}
      */
     getJSON(elt) {
         // force as string