melonjs 10.3.0 → 10.4.0

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;

package/src/level/tiled/TMXTileMap.js

@@ -103,19 +103,17 @@ function readObjectGroup(map, data, z) {
  * @classdesc
  * a TMX Tile Map Object
  * Tiled QT +0.7.x format
- * @class TMXTileMap
- * @memberof me
- * @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));
- * // add the level to the game world container
- * level.addTo(me.game.world, true);
  */
-export default class TMXTileMap {
-
-    // constructor
+class TMXTileMap {
+    /**
+     * @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));
+     * // add the level to the game world container
+     * level.addTo(me.game.world, true);
+     */
     constructor(levelId, data) {
 
         /**
@@ -128,7 +126,7 @@ export default class TMXTileMap {
          * name of the tilemap
          * @public
          * @type {string}
-         * @name me.TMXTileMap#name
+         * @name TMXTileMap#name
          */
         this.name = levelId;
 
@@ -136,14 +134,14 @@ export default class TMXTileMap {
          * width of the tilemap in tiles
          * @public
          * @type {number}
-         * @name me.TMXTileMap#cols
+         * @name TMXTileMap#cols
          */
         this.cols = +data.width;
         /**
          * height of the tilemap in tiles
          * @public
          * @type {number}
-         * @name me.TMXTileMap#rows
+         * @name TMXTileMap#rows
          */
         this.rows = +data.height;
 
@@ -151,7 +149,7 @@ export default class TMXTileMap {
          * Tile width
          * @public
          * @type {number}
-         * @name me.TMXTileMap#tilewidth
+         * @name TMXTileMap#tilewidth
          */
         this.tilewidth = +data.tilewidth;
 
@@ -159,7 +157,7 @@ export default class TMXTileMap {
          * Tile height
          * @public
          * @type {number}
-         * @name me.TMXTileMap#tileheight
+         * @name TMXTileMap#tileheight
          */
         this.tileheight = +data.tileheight;
 
@@ -168,7 +166,7 @@ export default class TMXTileMap {
          * @public
          * @type {number}
          * @default 0
-         * @name me.TMXTileMap#infinite
+         * @name TMXTileMap#infinite
          */
         this.infinite = +data.infinite;
 
@@ -177,7 +175,7 @@ export default class TMXTileMap {
          * @public
          * @type {string}
          * @default "orthogonal"
-         * @name me.TMXTileMap#orientation
+         * @name TMXTileMap#orientation
          */
         this.orientation = data.orientation;
 
@@ -187,7 +185,7 @@ export default class TMXTileMap {
          * @public
          * @type {string}
          * @default "right-down"
-         * @name me.TMXTileMap#renderorder
+         * @name TMXTileMap#renderorder
          */
         this.renderorder = data.renderorder || "right-down";
 
@@ -195,7 +193,7 @@ export default class TMXTileMap {
          * the TMX format version
          * @public
          * @type {string}
-         * @name me.TMXTileMap#version
+         * @name TMXTileMap#version
          */
         this.version = data.version;
 
@@ -203,7 +201,7 @@ export default class TMXTileMap {
          * The Tiled version used to save the file (since Tiled 1.0.1).
          * @public
          * @type {string}
-         * @name me.TMXTileMap#tiledversion
+         * @name TMXTileMap#tiledversion
          */
         this.tiledversion = data.tiledversion;
 
@@ -257,10 +255,10 @@ export default class TMXTileMap {
     /**
      * Return the map default renderer
      * @name getRenderer
-     * @memberof me.TMXTileMap
+     * @memberof TMXTileMap
      * @public
      * @function
-     * @returns {me.TMXRenderer} a TMX renderer
+     * @returns {TMXRenderer} a TMX renderer
      */
     getRenderer() {
         if ((typeof(this.renderer) === "undefined") || (!this.renderer.canRender(this))) {
@@ -271,10 +269,10 @@ export default class TMXTileMap {
 
     /**
      * return the map bounding rect
-     * @name me.TMXRenderer#getBounds
+     * @name TMXRenderer#getBounds
      * @public
      * @function
-     * @returns {me.Bounds}
+     * @returns {Bounds}
      */
     getBounds() {
         // calculated in the constructor
@@ -309,17 +307,6 @@ export default class TMXTileMap {
             });
         }
 
-        // check if a user-defined background color is defined
-        if (this.backgroundcolor) {
-            this.layers.push(
-                pool.pull("ColorLayer",
-                    "background_color",
-                    this.backgroundcolor,
-                    zOrder++
-                )
-            );
-        }
-
         // check if a background image is defined
         if (this.background_image) {
             // add a new image layer
@@ -365,10 +352,10 @@ export default class TMXTileMap {
     /**
      * add all the map layers and objects to the given container.
      * note : this will not automatically update the camera viewport
-     * @name me.TMXTileMap#addTo
+     * @name TMXTileMap#addTo
      * @public
      * @function
-     * @param {me.Container} container target 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
@@ -387,6 +374,10 @@ export default class TMXTileMap {
         container.autoSort = false;
         container.autoDepth = false;
 
+        if (this.backgroundcolor) {
+            container.backgroundColor.parseCSS(this.backgroundcolor);
+        }
+
         // add all layers instances
         this.getLayers().forEach(function (layer) {
             container.addChild(layer);
@@ -438,12 +429,12 @@ export default class TMXTileMap {
 
     /**
      * return an Array of instantiated objects, based on the map object definition
-     * @name me.TMXTileMap#getObjects
+     * @name TMXTileMap#getObjects
      * @public
      * @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
-     * @returns {me.Renderable[]} Array of Objects
+     * @returns {Renderable[]} Array of Objects
      */
     getObjects(flatten) {
         var objects = [];
@@ -587,10 +578,10 @@ export default class TMXTileMap {
 
     /**
      * return all the existing layers
-     * @name me.TMXTileMap#getLayers
+     * @name TMXTileMap#getLayers
      * @public
      * @function
-     * @returns {me.TMXLayer[]} Array of Layers
+     * @returns {TMXLayer[]} Array of Layers
      */
     getLayers() {
         // parse the map for objects
@@ -600,7 +591,7 @@ export default class TMXTileMap {
 
     /**
      * destroy function, clean all allocated objects
-     * @name me.TMXTileMap#destroy
+     * @name TMXTileMap#destroy
      * @public
      * @function
      */
@@ -611,3 +602,5 @@ export default class TMXTileMap {
         this.initialized = false;
     }
 };
+
+export default TMXTileMap;

package/src/level/tiled/TMXTileset.js

@@ -7,12 +7,11 @@ import loader from "./../../loader/loader.js";
 /**
  * @classdesc
  * a TMX Tile Set Object
- * @class TMXTileset
- * @memberof me
- * @param {object} tileset tileset data in JSON format ({@link http://docs.mapeditor.org/en/stable/reference/tmx-map-format/#tileset})
  */
-export default class TMXTileset {
-
+class TMXTileset {
+    /**
+     *  @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;
         // first gid
@@ -51,7 +50,7 @@ export default class TMXTileset {
          * Tileset contains animated tiles
          * @public
          * @type {boolean}
-         * @name me.TMXTileset#isAnimated
+         * @name TMXTileset#isAnimated
          */
         this.isAnimated = false;
 
@@ -59,23 +58,19 @@ export default class TMXTileset {
          * true if the tileset is a "Collection of Image" Tileset
          * @public
          * @type {boolean}
-         * @name me.TMXTileset#isCollection
+         * @name TMXTileset#isCollection
          */
         this.isCollection = false;
 
         /**
          * Tileset animations
          * @private
-         * @type {Map}
-         * @name me.TMXTileset#animations
          */
         this.animations = new Map();
 
         /**
          * Remember the last update timestamp to prevent too many animation updates
          * @private
-         * @type {Map}
-         * @name me.TMXTileset#_lastUpdate
          */
         this._lastUpdate = 0;
 
@@ -169,7 +164,7 @@ export default class TMXTileset {
 
     /**
      * return the tile image from a "Collection of Image" tileset
-     * @name me.TMXTileset#getTileImage
+     * @name TMXTileset#getTileImage
      * @public
      * @function
      * @param {number} gid
@@ -192,7 +187,7 @@ export default class TMXTileset {
 
     /**
      * return true if the gid belongs to the tileset
-     * @name me.TMXTileset#contains
+     * @name TMXTileset#contains
      * @public
      * @function
      * @param {number} gid
@@ -204,7 +199,7 @@ export default class TMXTileset {
 
     /**
      * Get the view (local) tile ID from a GID, with animations applied
-     * @name me.TMXTileset#getViewTileId
+     * @name TMXTileset#getViewTileId
      * @public
      * @function
      * @param {number} gid Global tile ID
@@ -223,7 +218,7 @@ export default class TMXTileset {
 
     /**
      * return the properties of the specified tile
-     * @name me.TMXTileset#getTileProperties
+     * @name TMXTileset#getTileProperties
      * @public
      * @function
      * @param {number} tileId
@@ -300,3 +295,5 @@ export default class TMXTileset {
         }
     }
 };
+
+export default TMXTileset;

package/src/level/tiled/TMXTilesetGroup.js

@@ -5,10 +5,8 @@ var TMX_CLEAR_BIT_MASK = ~(0x80000000 | 0x40000000 | 0x20000000);
 /**
  * @classdesc
  * an object containing all tileset
- * @class TMXTilesetGroup
- * @memberof me
  */
-export default class TMXTilesetGroup {
+class TMXTilesetGroup {
 
     constructor() {
         this.tilesets = [];
@@ -17,10 +15,10 @@ export default class TMXTilesetGroup {
 
     /**
      * add a tileset to the tileset group
-     * @name me.TMXTilesetGroup#add
+     * @name TMXTilesetGroup#add
      * @public
      * @function
-     * @param  {me.TMXTileset} tileset
+     * @param {TMXTileset} tileset
      */
     add(tileset) {
         this.tilesets.push(tileset);
@@ -29,11 +27,11 @@ export default class TMXTilesetGroup {
 
     /**
      * return the tileset at the specified index
-     * @name me.TMXTilesetGroup#getTilesetByIndex
+     * @name TMXTilesetGroup#getTilesetByIndex
      * @public
      * @function
      * @param {number} i
-     * @returns {me.TMXTileset} corresponding tileset
+     * @returns {TMXTileset} corresponding tileset
      */
     getTilesetByIndex(i) {
         return this.tilesets[i];
@@ -42,11 +40,11 @@ export default class TMXTilesetGroup {
     /**
      * return the tileset corresponding to the specified id <br>
      * will throw an exception if no matching tileset is found
-     * @name me.TMXTilesetGroup#getTilesetByGid
+     * @name TMXTilesetGroup#getTilesetByGid
      * @public
      * @function
      * @param {number} gid
-     * @returns {me.TMXTileset} corresponding tileset
+     * @returns {TMXTileset} corresponding tileset
      */
     getTilesetByGid(gid) {
         var invalidRange = -1;
@@ -76,3 +74,5 @@ export default class TMXTilesetGroup {
         }
     }
 };
+
+export default TMXTilesetGroup;

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

@@ -22,13 +22,12 @@ var offsetsStaggerY = [
 /**
  * @classdesc
  * an Hexagonal Map Renderder
- * @class TMXHexagonalRenderer
- * @memberof me
- * @augments me.TMXRenderer
- * @param {me.TMXTileMap} map the TMX map
+ * @augments TMXRenderer
  */
 class TMXHexagonalRenderer extends TMXRenderer {
-    // constructor
+    /**
+     * @param {TMXTileMap} map the TMX map
+     */
     constructor(map) {
         super(
             map.cols,
@@ -80,11 +79,11 @@ class TMXHexagonalRenderer extends TMXRenderer {
 
     /**
      * return the bounding rect for this map renderer
-     * @name me.TMXHexagonalRenderer#getBounds
+     * @name TMXHexagonalRenderer#getBounds
      * @public
      * @function
-     * @param {me.TMXLayer} [layer] calculate the bounding rect for a specific layer (will return a new bounds object)
-     * @returns {me.Bounds}
+     * @param {TMXLayer} [layer] calculate the bounding rect for a specific layer (will return a new bounds object)
+     * @returns {Bounds}
      */
     getBounds(layer) {
         var bounds = layer instanceof TMXLayer ? pool.pull("Bounds") : this.bounds;