melonjs 10.2.2 → 10.4.0

package/src/level/tiled/TMXTile.js

@@ -9,18 +9,17 @@ var TMX_FLIP_H          = 0x80000000,
     TMX_CLEAR_BIT_MASK  = ~(0x80000000 | 0x40000000 | 0x20000000);
 
 /**
+ * @classdesc
  * a basic tile object
- * @class
- * @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 {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;
 
@@ -42,8 +41,8 @@ class Tile extends Bounds {
         /**
          * tileset
          * @public
-         * @type {me.TMXTileset}
-         * @name me.Tile#tileset
+         * @type {TMXTileset}
+         * @name Tile#tileset
          */
         this.tileset = tileset;
 
@@ -61,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;
 
@@ -90,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;
 
@@ -131,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

@@ -14,7 +14,7 @@ import TMXLayer from "./TMXLayer.js";
 import { applyTMXProperties } from "./TMXUtils.js";
 import Renderable from "./../../renderable/renderable.js";
 import Container from "./../../renderable/container.js";
-import Rect from "./../../shapes/rectangle.js";
+import Rect from "./../../geometries/rectangle.js";
 
 // constant to identify the collision object layer
 var COLLISION_GROUP = "collision";
@@ -103,20 +103,17 @@ function readObjectGroup(map, data, z) {
  * @classdesc
  * a TMX Tile Map Object
  * Tiled QT +0.7.x format
- * @class TMXTileMap
- * @memberOf me
- * @constructor
- * @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) {
 
         /**
@@ -129,7 +126,7 @@ export default class TMXTileMap {
          * name of the tilemap
          * @public
          * @type {string}
-         * @name me.TMXTileMap#name
+         * @name TMXTileMap#name
          */
         this.name = levelId;
 
@@ -137,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;
 
@@ -152,7 +149,7 @@ export default class TMXTileMap {
          * Tile width
          * @public
          * @type {number}
-         * @name me.TMXTileMap#tilewidth
+         * @name TMXTileMap#tilewidth
          */
         this.tilewidth = +data.tilewidth;
 
@@ -160,7 +157,7 @@ export default class TMXTileMap {
          * Tile height
          * @public
          * @type {number}
-         * @name me.TMXTileMap#tileheight
+         * @name TMXTileMap#tileheight
          */
         this.tileheight = +data.tileheight;
 
@@ -169,7 +166,7 @@ export default class TMXTileMap {
          * @public
          * @type {number}
          * @default 0
-         * @name me.TMXTileMap#infinite
+         * @name TMXTileMap#infinite
          */
         this.infinite = +data.infinite;
 
@@ -178,7 +175,7 @@ export default class TMXTileMap {
          * @public
          * @type {string}
          * @default "orthogonal"
-         * @name me.TMXTileMap#orientation
+         * @name TMXTileMap#orientation
          */
         this.orientation = data.orientation;
 
@@ -188,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";
 
@@ -196,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;
 
@@ -204,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;
 
@@ -258,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))) {
@@ -272,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
@@ -310,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
@@ -366,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
@@ -388,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);
@@ -439,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 = [];
@@ -588,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
@@ -601,7 +591,7 @@ export default class TMXTileMap {
 
     /**
      * destroy function, clean all allocated objects
-     * @name me.TMXTileMap#destroy
+     * @name TMXTileMap#destroy
      * @public
      * @function
      */
@@ -612,3 +602,5 @@ export default class TMXTileMap {
         this.initialized = false;
     }
 };
+
+export default TMXTileMap;

package/src/level/tiled/TMXTileset.js

@@ -7,13 +7,11 @@ import loader from "./../../loader/loader.js";
 /**
  * @classdesc
  * a TMX Tile Set Object
- * @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})
  */
-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
@@ -52,7 +50,7 @@ export default class TMXTileset {
          * Tileset contains animated tiles
          * @public
          * @type {boolean}
-         * @name me.TMXTileset#isAnimated
+         * @name TMXTileset#isAnimated
          */
         this.isAnimated = false;
 
@@ -60,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;
 
@@ -170,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
@@ -193,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
@@ -205,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
@@ -224,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
@@ -301,3 +295,5 @@ export default class TMXTileset {
         }
     }
 };
+
+export default TMXTileset;

package/src/level/tiled/TMXTilesetGroup.js

@@ -5,11 +5,8 @@ var TMX_CLEAR_BIT_MASK = ~(0x80000000 | 0x40000000 | 0x20000000);
 /**
  * @classdesc
  * an object containing all tileset
- * @class TMXTilesetGroup
- * @memberOf me
- * @constructor
  */
-export default class TMXTilesetGroup {
+class TMXTilesetGroup {
 
     constructor() {
         this.tilesets = [];
@@ -18,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);
@@ -30,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];
@@ -43,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;
@@ -77,3 +74,5 @@ export default class TMXTilesetGroup {
         }
     }
 };
+
+export default TMXTilesetGroup;

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

@@ -22,14 +22,12 @@ var offsetsStaggerY = [
 /**
  * @classdesc
  * an Hexagonal Map Renderder
- * @class TMXHexagonalRenderer
- * @memberOf me
- * @extends me.TMXRenderer
- * @constructor
- * @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,
@@ -81,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;

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

@@ -7,14 +7,12 @@ import TMXLayer from "./../TMXLayer.js";
 /**
  * @classdesc
  * an Isometric Map Renderder
- * @class TMXIsometricRenderer
- * @memberOf me
- * @extends me.TMXRenderer
- * @constructor
- * @param {me.TMXTileMap} map the TMX map
+ * @augments TMXRenderer
  */
 class TMXIsometricRenderer extends TMXRenderer {
-    // constructor
+    /**
+     * @param {TMXTileMap} map the TMX map
+     */
     constructor(map) {
         super(
             map.cols,
@@ -41,11 +39,11 @@ class TMXIsometricRenderer extends TMXRenderer {
 
     /**
      * return the bounding rect for this map renderer
-     * @name me.TMXIsometricRenderer#getBounds
+     * @name TMXIsometricRenderer#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;

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

@@ -5,14 +5,12 @@ import TMXRenderer from "./TMXRenderer.js";
 /**
  * @classdesc
  * an Orthogonal Map Renderder
- * @class TMXOrthogonalRenderer
- * @memberOf me
- * @extends me.TMXRenderer
- * @constructor
- * @param {me.TMXTileMap} map the TMX map
+ * @augments TMXRenderer
  */
 class TMXOrthogonalRenderer extends TMXRenderer {
-    // constructor
+    /**
+     * @param {TMXTileMap} map the TMX map
+     */
     constructor(map) {
         super(
             map.cols,

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

@@ -7,16 +7,14 @@ import Bounds from "./../../../physics/Bounds.js";
 /**
  * @classdesc
  * The map renderer base class
- * @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
  */
 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
+     */
     constructor(cols, rows, tilewidth, tileheight) {
         this.cols = cols;
         this.rows = rows;
@@ -27,10 +25,10 @@ class TMXRenderer {
 
     /**
      * return true if the renderer can render the specified map or layer
-     * @name me.TMXRenderer#canRender
+     * @name TMXRenderer#canRender
      * @public
      * @function
-     * @param {me.TMXTileMap|me.TMXLayer} component TMX Map or Layer
+     * @param {TMXTileMap|TMXLayer} component TMX Map or Layer
      * @returns {boolean}
      */
     canRender(component) {
@@ -48,11 +46,11 @@ class TMXRenderer {
 
     /**
      * return the bounding rect for this map renderer
-     * @name me.TMXRenderer#getBounds
+     * @name TMXRenderer#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;
@@ -66,13 +64,13 @@ class TMXRenderer {
 
     /**
      * return the tile position corresponding to the specified pixel
-     * @name me.TMXRenderer#pixelToTileCoords
+     * @name TMXRenderer#pixelToTileCoords
      * @public
      * @function
      * @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}
+     * @param {Vector2d} [v] an optional vector object where to put the return values
+     * @returns {Vector2d}
      */
     pixelToTileCoords(x, y, v) {
         return v;
@@ -80,13 +78,13 @@ class TMXRenderer {
 
     /**
      * return the pixel position corresponding of the specified tile
-     * @name me.TMXRenderer#tileToPixelCoords
+     * @name TMXRenderer#tileToPixelCoords
      * @public
      * @function
      * @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}
+     * @param {Vector2d} [v] an optional vector object where to put the return values
+     * @returns {Vector2d}
      */
     tileToPixelCoords(col, row, v) {
         return v;
@@ -94,25 +92,25 @@ class TMXRenderer {
 
     /**
      * draw the given tile at the specified layer
-     * @name me.TMXRenderer#drawTile
+     * @name TMXRenderer#drawTile
      * @public
      * @function
-     * @param {me.CanvasRenderer|me.WebGLRenderer} renderer a renderer object
+     * @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 {me.Tile} tile the tile object to draw
+     * @param {Tile} tile the tile object to draw
      */
     drawTile(renderer, x, y, tile) {
     }
 
     /**
      * draw the given TMX Layer for the given area
-     * @name me.TMXRenderer#drawTileLayer
+     * @name TMXRenderer#drawTileLayer
      * @public
      * @function
-     * @param {me.CanvasRenderer|me.WebGLRenderer} renderer a renderer object
-     * @param {me.TMXLayer} layer a TMX Layer object
-     * @param {me.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) {
     }