melonjs 10.1.0 → 10.2.2

package/src/level/tiled/TMXLayer.js

@@ -69,13 +69,13 @@ function preRenderLayer(layer, renderer) {
  * @extends me.Renderable
  * @memberOf me
  * @constructor
- * @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 {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 {me.TMXTilesetGroup} tilesets tileset as defined in Tiled
- * @param {Number} z z-index position
+ * @param {number} z z-index position
  */
 class TMXLayer extends Renderable {
     /**
@@ -95,7 +95,7 @@ class TMXLayer extends Renderable {
         /**
          * The Layer corresponding Tilesets
          * @public
-         * @type me.TMXTilesetGroup
+         * @type {me.TMXTilesetGroup}
          * @name me.TMXLayer#tilesets
          */
         this.tilesets = tilesets;
@@ -118,7 +118,7 @@ class TMXLayer extends Renderable {
         /**
          * All animated tilesets in this layer
          * @ignore
-         * @type Array
+         * @type {me.TMXTileset[]}
          * @name me.TMXLayer#animatedTilesets
          */
         this.animatedTilesets = [];
@@ -126,7 +126,7 @@ class TMXLayer extends Renderable {
         /**
          * Layer contains tileset animations
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @name me.TMXLayer#isAnimated
          */
         this.isAnimated = false;
@@ -135,7 +135,7 @@ class TMXLayer extends Renderable {
          * 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.TMXLayer#renderorder
          */
@@ -262,7 +262,7 @@ class TMXLayer extends Renderable {
      * @memberOf me.TMXLayer
      * @public
      * @function
-     * @return {me.TMXRenderer} renderer
+     * @returns {me.TMXRenderer} renderer
      */
     getRenderer() {
         return this.renderer;
@@ -275,9 +275,9 @@ class TMXLayer extends Renderable {
      * @memberOf me.TMXLayer
      * @public
      * @function
-     * @param {Number} x X coordinate (in world/pixels coordinates)
-     * @param {Number} y Y coordinate (in world/pixels coordinates)
-     * @return {Number} TileId or null if there is no Tile at the given position
+     * @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) {
         var tile = this.getTile(x, y);
@@ -290,9 +290,9 @@ class TMXLayer extends Renderable {
      * @memberOf me.TMXLayer
      * @public
      * @function
-     * @param {Number} x X coordinate (in world/pixels coordinates)
-     * @param {Number} y Y coordinate (in world/pixels coordinates)
-     * @return {me.Tile} corresponding tile or null if there is no defined tile at the coordinate or if outside of the layer bounds
+     * @param {number} x X coordinate (in world/pixels coordinates)
+     * @param {number} y Y coordinate (in world/pixels coordinates)
+     * @returns {me.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"
      * var layer = me.game.world.getChildByName("Front Layer")[0];
@@ -316,10 +316,10 @@ class TMXLayer extends Renderable {
      * @memberOf me.TMXLayer
      * @public
      * @function
-     * @return {me.Tile} a Tile object
-     * @param {Number} x X coordinate (in world/pixels coordinates)
-     * @param {Number} y Y coordinate (in world/pixels coordinates)
-     * @return {me.Tile} the tile object
+     * @param {me.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 {me.Tile} the tile object
      */
     setTile(tile, x, y) {
         this.layerData[x][y] = tile;
@@ -332,10 +332,10 @@ class TMXLayer extends Renderable {
      * @memberOf me.TMXLayer
      * @public
      * @function
-     * @param {Number} tileId tileId
-     * @param {Number} x X coordinate (in world/pixels coordinates)
-     * @param {Number} y Y coordinate (in world/pixels coordinates)
-     * @return {me.Tile} the tile object
+     * @param {number} tileId tileId
+     * @param {number} x X coordinate (in world/pixels coordinates)
+     * @param {number} y Y coordinate (in world/pixels coordinates)
+     * @returns {me.Tile} the tile object
      */
     getTileById(tileId, x, y) {
         if (!this.tileset.contains(tileId)) {
@@ -351,10 +351,10 @@ class TMXLayer extends Renderable {
      * @memberOf me.TMXLayer
      * @public
      * @function
-     * @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
-     * @return {me.Tile} corresponding tile or null if there is no defined tile at the position or if outside of 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 {me.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
      * var tile = layer.cellAt(0, 0);
@@ -378,8 +378,8 @@ class TMXLayer extends Renderable {
      * @memberOf me.TMXLayer
      * @public
      * @function
-     * @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/TMXObject.js

@@ -20,7 +20,7 @@ export default class TMXObject {
         /**
          * point list in JSON format
          * @public
-         * @type Object[]
+         * @type {object[]}
          * @name points
          * @memberOf me.TMXObject
          */
@@ -29,7 +29,7 @@ export default class TMXObject {
         /**
          * object name
          * @public
-         * @type String
+         * @type {string}
          * @name name
          * @memberOf me.TMXObject
          */
@@ -38,7 +38,7 @@ export default class TMXObject {
         /**
          * object x position
          * @public
-         * @type Number
+         * @type {number}
          * @name x
          * @memberOf me.TMXObject
          */
@@ -47,7 +47,7 @@ export default class TMXObject {
         /**
          * object y position
          * @public
-         * @type Number
+         * @type {number}
          * @name y
          * @memberOf me.TMXObject
          */
@@ -56,7 +56,7 @@ export default class TMXObject {
         /**
          * object z order
          * @public
-         * @type Number
+         * @type {number}
          * @name z
          * @memberOf me.TMXObject
          */
@@ -65,7 +65,7 @@ export default class TMXObject {
         /**
          * object width
          * @public
-         * @type Number
+         * @type {number}
          * @name width
          * @memberOf me.TMXObject
          */
@@ -74,7 +74,7 @@ export default class TMXObject {
         /**
          * object height
          * @public
-         * @type Number
+         * @type {number}
          * @name height
          * @memberOf me.TMXObject
          */
@@ -84,7 +84,7 @@ export default class TMXObject {
          * object gid value
          * when defined the object is a tiled object
          * @public
-         * @type Number
+         * @type {number}
          * @name gid
          * @memberOf me.TMXObject
          */
@@ -93,7 +93,7 @@ export default class TMXObject {
         /**
          * tint color
          * @public
-         * @type String
+         * @type {string}
          * @name tintcolor
          * @memberOf me.TMXObject
          */
@@ -102,7 +102,7 @@ export default class TMXObject {
         /**
          * object type
          * @public
-         * @type String
+         * @type {string}
          * @name type
          * @memberOf me.TMXObject
          */
@@ -111,7 +111,7 @@ export default class TMXObject {
         /**
          * object text
          * @public
-         * @type Object
+         * @type {object}
          * @see http://docs.mapeditor.org/en/stable/reference/tmx-map-format/#text
          * @name type
          * @memberOf me.TMXObject
@@ -121,7 +121,7 @@ export default class TMXObject {
         /**
          * The rotation of the object in radians clockwise (defaults to 0)
          * @public
-         * @type Number
+         * @type {number}
          * @name rotation
          * @memberOf me.TMXObject
          */
@@ -130,7 +130,7 @@ export default class TMXObject {
         /**
          * object unique identifier per level (Tiled 0.11.x+)
          * @public
-         * @type Number
+         * @type {number}
          * @name id
          * @memberOf me.TMXObject
          */
@@ -139,7 +139,7 @@ export default class TMXObject {
         /**
          * object orientation (orthogonal or isometric)
          * @public
-         * @type String
+         * @type {string}
          * @name orientation
          * @memberOf me.TMXObject
          */
@@ -148,7 +148,7 @@ export default class TMXObject {
         /**
          * the collision shapes defined for this object
          * @public
-         * @type Array
+         * @type {object[]}
          * @name shapes
          * @memberOf me.TMXObject
          */
@@ -157,7 +157,7 @@ export default class TMXObject {
         /**
          * if true, the object is an Ellipse
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @name isEllipse
          * @memberOf me.TMXObject
          */
@@ -166,7 +166,7 @@ export default class TMXObject {
         /**
          * if true, the object is a Polygon
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @name isPolygon
          * @memberOf me.TMXObject
          */
@@ -175,7 +175,7 @@ export default class TMXObject {
         /**
          * if true, the object is a PolyLine
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @name isPolyLine
          * @memberOf me.TMXObject
          */
@@ -252,7 +252,7 @@ export default class TMXObject {
      * @memberOf me.TMXObject
      * @private
      * @function
-     * @return {me.Polygon[]|me.Line[]|me.Ellipse[]} an array of shape objects
+     * @returns {me.Polygon[]|me.Line[]|me.Ellipse[]} an array of shape objects
      */
     parseTMXShapes() {
         var i = 0;

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;