melonjs 10.3.0 → 10.5.1

package/src/level/tiled/TMXGroup.js

@@ -7,7 +7,6 @@ import { clamp } from "./../../math/math.js";
  * @classdesc
  * object group definition as defined in Tiled.
  * (group definition is translated into the virtual `me.game.world` using `me.Container`)
- * @class TMXGroup
  * @ignore
  */
 export default class TMXGroup {
@@ -19,7 +18,7 @@ export default class TMXGroup {
          * @public
          * @type {string}
          * @name name
-         * @memberof me.TMXGroup
+         * @memberof TMXGroup
          */
         this.name = data.name;
 
@@ -28,7 +27,7 @@ export default class TMXGroup {
          * @public
          * @type {number}
          * @name width
-         * @memberof me.TMXGroup
+         * @memberof TMXGroup
          */
         this.width = data.width || 0;
 
@@ -37,7 +36,7 @@ export default class TMXGroup {
          * @public
          * @type {number}
          * @name height
-         * @memberof me.TMXGroup
+         * @memberof TMXGroup
          */
         this.height = data.height || 0;
 
@@ -46,7 +45,7 @@ export default class TMXGroup {
          * @public
          * @type {string}
          * @name tintcolor
-         * @memberof me.TMXGroup
+         * @memberof TMXGroup
          */
         this.tintcolor = data.tintcolor;
 
@@ -55,17 +54,17 @@ export default class TMXGroup {
          * @public
          * @type {number}
          * @name z
-         * @memberof me.TMXGroup
+         * @memberof TMXGroup
          */
         this.z = z;
 
         /**
          * group objects list definition
-         * @see me.TMXObject
+         * @see TMXObject
          * @public
          * @type {object[]}
          * @name name
-         * @memberof me.TMXGroup
+         * @memberof TMXGroup
          */
         this.objects = [];
 

package/src/level/tiled/TMXLayer.js

@@ -63,22 +63,20 @@ function preRenderLayer(layer, renderer) {
 }
 
 /**
+ * @classdesc
  * a TMX Tile Layer Object
  * Tiled QT 0.7.x format
- * @class
- * @augments me.Renderable
- * @memberof me
- * @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
+ * @augments Renderable
  */
 class TMXLayer extends Renderable {
     /**
-     * @ignore
+     * @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
@@ -94,8 +92,8 @@ class TMXLayer extends Renderable {
         /**
          * The Layer corresponding Tilesets
          * @public
-         * @type {me.TMXTilesetGroup}
-         * @name me.TMXLayer#tilesets
+         * @type {TMXTilesetGroup}
+         * @name TMXLayer#tilesets
          */
         this.tilesets = tilesets;
 
@@ -117,8 +115,8 @@ class TMXLayer extends Renderable {
         /**
          * All animated tilesets in this layer
          * @ignore
-         * @type {me.TMXTileset[]}
-         * @name me.TMXLayer#animatedTilesets
+         * @type {TMXTileset[]}
+         * @name TMXLayer#animatedTilesets
          */
         this.animatedTilesets = [];
 
@@ -126,7 +124,7 @@ class TMXLayer extends Renderable {
          * Layer contains tileset animations
          * @public
          * @type {boolean}
-         * @name me.TMXLayer#isAnimated
+         * @name TMXLayer#isAnimated
          */
         this.isAnimated = false;
 
@@ -136,7 +134,7 @@ class TMXLayer extends Renderable {
          * @public
          * @type {string}
          * @default "right-down"
-         * @name me.TMXLayer#renderorder
+         * @name TMXLayer#renderorder
          */
         this.renderorder = data.renderorder || "right-down";
 
@@ -242,10 +240,10 @@ class TMXLayer extends Renderable {
     /**
      * Set the TMX renderer for this layer object
      * @name setRenderer
-     * @memberof me.TMXLayer
+     * @memberof TMXLayer
      * @public
      * @function
-     * @param {me.TMXRenderer} renderer
+     * @param {TMXRenderer} renderer
      * @example
      * // use the parent map default renderer
      * var layer = new me.TMXLayer(...);
@@ -258,10 +256,10 @@ class TMXLayer extends Renderable {
     /**
      * Return the layer current renderer object
      * @name getRenderer
-     * @memberof me.TMXLayer
+     * @memberof TMXLayer
      * @public
      * @function
-     * @returns {me.TMXRenderer} renderer
+     * @returns {TMXRenderer} renderer
      */
     getRenderer() {
         return this.renderer;
@@ -271,7 +269,7 @@ class TMXLayer extends Renderable {
     /**
      * Return the TileId of the Tile at the specified position
      * @name getTileId
-     * @memberof me.TMXLayer
+     * @memberof TMXLayer
      * @public
      * @function
      * @param {number} x X coordinate (in world/pixels coordinates)
@@ -286,12 +284,12 @@ class TMXLayer extends Renderable {
     /**
      * Return the Tile object at the specified position
      * @name getTile
-     * @memberof me.TMXLayer
+     * @memberof TMXLayer
      * @public
      * @function
      * @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
+     * @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"
      * var layer = me.game.world.getChildByName("Front Layer")[0];
@@ -312,13 +310,13 @@ class TMXLayer extends Renderable {
     /**
      * assign the given Tile object to the specified position
      * @name getTile
-     * @memberof me.TMXLayer
+     * @memberof TMXLayer
      * @public
      * @function
-     * @param {me.Tile} tile the tile object to be assigned
+     * @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 {me.Tile} the tile object
+     * @returns {Tile} the tile object
      */
     setTile(tile, x, y) {
         this.layerData[x][y] = tile;
@@ -328,13 +326,13 @@ class TMXLayer extends Renderable {
     /**
      * return a new the Tile object corresponding to the given tile id
      * @name setTile
-     * @memberof me.TMXLayer
+     * @memberof 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)
-     * @returns {me.Tile} the tile object
+     * @returns {Tile} the tile object
      */
     getTileById(tileId, x, y) {
         if (!this.tileset.contains(tileId)) {
@@ -347,13 +345,13 @@ class TMXLayer extends Renderable {
     /**
      * Return the Tile object at the specified tile coordinates
      * @name cellAt
-     * @memberof me.TMXLayer
+     * @memberof 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
-     * @returns {me.Tile} corresponding tile or null if there is no defined tile at the position or if outside of 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
      * var tile = layer.cellAt(0, 0);
@@ -374,7 +372,7 @@ class TMXLayer extends Renderable {
     /**
      * clear the tile at the specified position
      * @name clearTile
-     * @memberof me.TMXLayer
+     * @memberof TMXLayer
      * @public
      * @function
      * @param {number} x X coordinate (in map coordinates: row/column)

package/src/level/tiled/TMXObject.js

@@ -7,9 +7,9 @@ import Line from "./../../geometries/line.js";
 import { degToRad } from "./../../math/math.js";
 
 /**
+ * @classdesc
  * a TMX Object defintion, as defined in Tiled
  * (Object definition is translated into the virtual `me.game.world` using `me.Renderable`)
- * @class TMXObject
  * @ignore
  */
 export default class TMXObject {
@@ -21,7 +21,7 @@ export default class TMXObject {
          * @public
          * @type {object[]}
          * @name points
-         * @memberof me.TMXObject
+         * @memberof TMXObject
          */
         this.points = undefined;
 
@@ -30,7 +30,7 @@ export default class TMXObject {
          * @public
          * @type {string}
          * @name name
-         * @memberof me.TMXObject
+         * @memberof TMXObject
          */
         this.name = settings.name;
 
@@ -39,7 +39,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name x
-         * @memberof me.TMXObject
+         * @memberof TMXObject
          */
         this.x = +settings.x;
 
@@ -48,7 +48,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name y
-         * @memberof me.TMXObject
+         * @memberof TMXObject
          */
         this.y = +settings.y;
 
@@ -57,7 +57,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name z
-         * @memberof me.TMXObject
+         * @memberof TMXObject
          */
         this.z = +z;
 
@@ -66,7 +66,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name width
-         * @memberof me.TMXObject
+         * @memberof TMXObject
          */
         this.width = +settings.width || 0;
 
@@ -75,7 +75,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name height
-         * @memberof me.TMXObject
+         * @memberof TMXObject
          */
         this.height = +settings.height || 0;
 
@@ -85,7 +85,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name gid
-         * @memberof me.TMXObject
+         * @memberof TMXObject
          */
         this.gid = +settings.gid || null;
 
@@ -94,7 +94,7 @@ export default class TMXObject {
          * @public
          * @type {string}
          * @name tintcolor
-         * @memberof me.TMXObject
+         * @memberof TMXObject
          */
         this.tintcolor = settings.tintcolor;
 
@@ -103,7 +103,7 @@ export default class TMXObject {
          * @public
          * @type {string}
          * @name type
-         * @memberof me.TMXObject
+         * @memberof TMXObject
          */
         this.type = settings.type;
 
@@ -113,7 +113,7 @@ export default class TMXObject {
          * @type {object}
          * @see http://docs.mapeditor.org/en/stable/reference/tmx-map-format/#text
          * @name type
-         * @memberof me.TMXObject
+         * @memberof TMXObject
          */
         this.type = settings.type;
 
@@ -122,7 +122,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name rotation
-         * @memberof me.TMXObject
+         * @memberof TMXObject
          */
         this.rotation = degToRad(+settings.rotation || 0);
 
@@ -131,7 +131,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name id
-         * @memberof me.TMXObject
+         * @memberof TMXObject
          */
         this.id = +settings.id || undefined;
 
@@ -140,7 +140,7 @@ export default class TMXObject {
          * @public
          * @type {string}
          * @name orientation
-         * @memberof me.TMXObject
+         * @memberof TMXObject
          */
         this.orientation = map.orientation;
 
@@ -149,7 +149,7 @@ export default class TMXObject {
          * @public
          * @type {object[]}
          * @name shapes
-         * @memberof me.TMXObject
+         * @memberof TMXObject
          */
         this.shapes = undefined;
 
@@ -158,7 +158,7 @@ export default class TMXObject {
          * @public
          * @type {boolean}
          * @name isEllipse
-         * @memberof me.TMXObject
+         * @memberof TMXObject
          */
         this.isEllipse = false;
 
@@ -167,7 +167,7 @@ export default class TMXObject {
          * @public
          * @type {boolean}
          * @name isPolygon
-         * @memberof me.TMXObject
+         * @memberof TMXObject
          */
         this.isPolygon = false;
 
@@ -176,7 +176,7 @@ export default class TMXObject {
          * @public
          * @type {boolean}
          * @name isPolyLine
-         * @memberof me.TMXObject
+         * @memberof TMXObject
          */
         this.isPolyLine = false;
 
@@ -248,10 +248,10 @@ export default class TMXObject {
     /**
      * parses the TMX shape definition and returns a corresponding array of me.Shape object
      * @name parseTMXShapes
-     * @memberof me.TMXObject
+     * @memberof TMXObject
      * @private
      * @function
-     * @returns {me.Polygon[]|me.Line[]|me.Ellipse[]} an array of shape objects
+     * @returns {Polygon[]|Line[]|Ellipse[]} an array of shape objects
      */
     parseTMXShapes() {
         var i = 0;

package/src/level/tiled/TMXTile.js

@@ -9,17 +9,17 @@ var TMX_FLIP_H          = 0x80000000,
     TMX_CLEAR_BIT_MASK  = ~(0x80000000 | 0x40000000 | 0x20000000);
 
 /**
+ * @classdesc
  * a basic tile object
- * @class
- * @augments me.Bounds
- * @memberof me
- * @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
+ * @augments Bounds
  */
 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
+     */
     constructor(x, y, gid, tileset) {
         var width, height;
 
@@ -41,8 +41,8 @@ class Tile extends Bounds {
         /**
          * tileset
          * @public
-         * @type {me.TMXTileset}
-         * @name me.Tile#tileset
+         * @type {TMXTileset}
+         * @name Tile#tileset
          */
         this.tileset = tileset;
 
@@ -60,28 +60,28 @@ class Tile extends Bounds {
          * tileId
          * @public
          * @type {number}
-         * @name me.Tile#tileId
+         * @name Tile#tileId
          */
         this.tileId = gid;
         /**
          * True if the tile is flipped horizontally<br>
          * @public
          * @type {boolean}
-         * @name me.Tile#flipX
+         * @name Tile#flipX
          */
         this.flippedX  = (this.tileId & TMX_FLIP_H) !== 0;
         /**
          * True if the tile is flipped vertically<br>
          * @public
          * @type {boolean}
-         * @name me.Tile#flippedY
+         * @name Tile#flippedY
          */
         this.flippedY  = (this.tileId & TMX_FLIP_V) !== 0;
         /**
          * True if the tile is flipped anti-diagonally<br>
          * @public
          * @type {boolean}
-         * @name me.Tile#flippedAD
+         * @name 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}
-         * @name me.Tile#flipped
+         * @name Tile#flipped
          */
         this.flipped = this.flippedX || this.flippedY || this.flippedAD;
 
@@ -130,11 +130,11 @@ class Tile extends Bounds {
 
     /**
      * return a renderable object for this Tile object
-     * @name me.Tile#getRenderable
+     * @name Tile#getRenderable
      * @public
      * @function
-     * @param {object} [settings] see {@link me.Sprite}
-     * @returns {me.Renderable} a me.Sprite object
+     * @param {object} [settings] see {@link Sprite}
+     * @returns {Renderable} a me.Sprite object
      */
     getRenderable(settings) {
         var renderable;