melonjs 10.2.3 → 10.5.0

package/src/level/level.js

@@ -49,10 +49,10 @@ function safeLoadLevel(levelId, options, restart) {
 /**
  * Load a TMX level
  * @name loadTMXLevel
- * @memberOf me.level
+ * @memberof level
  * @private
  * @param {string} levelId level id
- * @param {me.Container} container target container
+ * @param {Container} container target container
  * @param {boolean} [flatten=true] if true, flatten all objects into the given container
  * @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.
  * @ignore
@@ -76,7 +76,6 @@ function loadTMXLevel(levelId, container, flatten, setViewportBounds) {
 /**
  * a level manager. once ressources loaded, the level manager contains all references of defined levels.
  * @namespace level
- * @memberOf me
  */
 
 var level = {
@@ -84,7 +83,7 @@ var level = {
     /**
      * add a level into the game manager (usually called by the preloader)
      * @name add
-     * @memberOf me.level
+     * @memberof level
      * @public
      * @function
      * @param {string} format level format (only "tmx" supported)
@@ -123,14 +122,14 @@ var level = {
      * load a level into the game manager<br>
      * (will also create all level defined entities, etc..)
      * @name load
-     * @memberOf me.level
+     * @memberof level
      * @public
      * @function
      * @param {string} levelId level id
      * @param {object} [options] additional optional parameters
-     * @param {me.Container} [options.container=me.game.world] container in which to load the specified level
-     * @param {Function} [options.onLoaded=me.game.onLevelLoaded] callback for when the level is fully loaded
-     * @param {boolean} [options.flatten=me.game.mergeGroup] if true, flatten all objects into the given container
+     * @param {Container} [options.container=game.world] container in which to load the specified level
+     * @param {Function} [options.onLoaded=ame.onLevelLoaded] callback for when the level is fully loaded
+     * @param {boolean} [options.flatten=game.mergeGroup] if true, flatten all objects into the given container
      * @param {boolean} [options.setViewportBounds=true] if true, set the viewport bounds to the map size
      * @returns {boolean} true if the level was successfully loaded
      * @example
@@ -197,7 +196,7 @@ var level = {
     /**
      * return the current level id<br>
      * @name getCurrentLevelId
-     * @memberOf me.level
+     * @memberof level
      * @public
      * @function
      * @returns {string}
@@ -211,10 +210,10 @@ var level = {
      * for a reference to the live instantiated level,
      * rather use the container in which it was loaded (e.g. me.game.world)
      * @name getCurrentLevel
-     * @memberOf me.level
+     * @memberof level
      * @public
      * @function
-     * @returns {me.TMXTileMap}
+     * @returns {TMXTileMap}
      */
     getCurrentLevel() {
         return levels[this.getCurrentLevelId()];
@@ -223,13 +222,13 @@ var level = {
     /**
      * reload the current level
      * @name reload
-     * @memberOf me.level
+     * @memberof level
      * @public
      * @function
      * @param {object} [options] additional optional parameters
-     * @param {me.Container} [options.container=me.game.world] container in which to load the specified level
-     * @param {Function} [options.onLoaded=me.game.onLevelLoaded] callback for when the level is fully loaded
-     * @param {boolean} [options.flatten=me.game.mergeGroup] if true, flatten all objects into the given container
+     * @param {Container} [options.container=game.world] container in which to load the specified level
+     * @param {Function} [options.onLoaded=game.onLevelLoaded] callback for when the level is fully loaded
+     * @param {boolean} [options.flatten=game.mergeGroup] if true, flatten all objects into the given container
      * @returns {object} the current level
      */
     reload(options) {
@@ -241,13 +240,13 @@ var level = {
     /**
      * load the next level
      * @name next
-     * @memberOf me.level
+     * @memberof level
      * @public
      * @function
      * @param {object} [options] additional optional parameters
-     * @param {me.Container} [options.container=me.game.world] container in which to load the specified level
-     * @param {Function} [options.onLoaded=me.game.onLevelLoaded] callback for when the level is fully loaded
-     * @param {boolean} [options.flatten=me.game.mergeGroup] if true, flatten all objects into the given container
+     * @param {Container} [options.container=game.world] container in which to load the specified level
+     * @param {Function} [options.onLoaded=game.onLevelLoaded] callback for when the level is fully loaded
+     * @param {boolean} [options.flatten=game.mergeGroup] if true, flatten all objects into the given container
      * @returns {boolean} true if the next level was successfully loaded
      */
     next(options) {
@@ -263,13 +262,13 @@ var level = {
     /**
      * load the previous level<br>
      * @name previous
-     * @memberOf me.level
+     * @memberof level
      * @public
      * @function
      * @param {object} [options] additional optional parameters
-     * @param {me.Container} [options.container=me.game.world] container in which to load the specified level
-     * @param {Function} [options.onLoaded=me.game.onLevelLoaded] callback for when the level is fully loaded
-     * @param {boolean} [options.flatten=me.game.mergeGroup] if true, flatten all objects into the given container
+     * @param {Container} [options.container=game.world] container in which to load the specified level
+     * @param {Function} [options.onLoaded=game.onLevelLoaded] callback for when the level is fully loaded
+     * @param {boolean} [options.flatten=game.mergeGroup] if true, flatten all objects into the given container
      * @returns {boolean} true if the previous level was successfully loaded
      */
     previous(options) {
@@ -285,7 +284,7 @@ var level = {
     /**
      * return the amount of level preloaded
      * @name levelCount
-     * @memberOf me.level
+     * @memberof level
      * @public
      * @function
      * @returns {number} the amount of level preloaded

package/src/level/tiled/TMXGroup.js

@@ -7,8 +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
- * @constructor
  * @ignore
  */
 export default class TMXGroup {
@@ -20,7 +18,7 @@ export default class TMXGroup {
          * @public
          * @type {string}
          * @name name
-         * @memberOf me.TMXGroup
+         * @memberof TMXGroup
          */
         this.name = data.name;
 
@@ -29,7 +27,7 @@ export default class TMXGroup {
          * @public
          * @type {number}
          * @name width
-         * @memberOf me.TMXGroup
+         * @memberof TMXGroup
          */
         this.width = data.width || 0;
 
@@ -38,7 +36,7 @@ export default class TMXGroup {
          * @public
          * @type {number}
          * @name height
-         * @memberOf me.TMXGroup
+         * @memberof TMXGroup
          */
         this.height = data.height || 0;
 
@@ -47,7 +45,7 @@ export default class TMXGroup {
          * @public
          * @type {string}
          * @name tintcolor
-         * @memberOf me.TMXGroup
+         * @memberof TMXGroup
          */
         this.tintcolor = data.tintcolor;
 
@@ -56,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,23 +63,20 @@ function preRenderLayer(layer, renderer) {
 }
 
 /**
+ * @classdesc
  * a TMX Tile Layer Object
  * Tiled QT 0.7.x format
- * @class
- * @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 {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
@@ -95,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;
 
@@ -118,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 = [];
 
@@ -127,7 +124,7 @@ class TMXLayer extends Renderable {
          * Layer contains tileset animations
          * @public
          * @type {boolean}
-         * @name me.TMXLayer#isAnimated
+         * @name TMXLayer#isAnimated
          */
         this.isAnimated = false;
 
@@ -137,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";
 
@@ -243,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(...);
@@ -259,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;
@@ -272,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)
@@ -287,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];
@@ -313,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;
@@ -329,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)) {
@@ -348,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);
@@ -375,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

@@ -1,16 +1,15 @@
 import Vector2d from "./../../math/vector2.js";
 import { applyTMXProperties } from "./TMXUtils.js";
 import Tile from "./TMXTile.js";
-import Ellipse from "./../../shapes/ellipse.js";
-import Polygon from "./../../shapes/poly.js";
-import Line from "./../../shapes/line.js";
+import Ellipse from "./../../geometries/ellipse.js";
+import Polygon from "./../../geometries/poly.js";
+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
- * @constructor
  * @ignore
  */
 export default class TMXObject {
@@ -22,7 +21,7 @@ export default class TMXObject {
          * @public
          * @type {object[]}
          * @name points
-         * @memberOf me.TMXObject
+         * @memberof TMXObject
          */
         this.points = undefined;
 
@@ -31,7 +30,7 @@ export default class TMXObject {
          * @public
          * @type {string}
          * @name name
-         * @memberOf me.TMXObject
+         * @memberof TMXObject
          */
         this.name = settings.name;
 
@@ -40,7 +39,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name x
-         * @memberOf me.TMXObject
+         * @memberof TMXObject
          */
         this.x = +settings.x;
 
@@ -49,7 +48,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name y
-         * @memberOf me.TMXObject
+         * @memberof TMXObject
          */
         this.y = +settings.y;
 
@@ -58,7 +57,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name z
-         * @memberOf me.TMXObject
+         * @memberof TMXObject
          */
         this.z = +z;
 
@@ -67,7 +66,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name width
-         * @memberOf me.TMXObject
+         * @memberof TMXObject
          */
         this.width = +settings.width || 0;
 
@@ -76,7 +75,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name height
-         * @memberOf me.TMXObject
+         * @memberof TMXObject
          */
         this.height = +settings.height || 0;
 
@@ -86,7 +85,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name gid
-         * @memberOf me.TMXObject
+         * @memberof TMXObject
          */
         this.gid = +settings.gid || null;
 
@@ -95,7 +94,7 @@ export default class TMXObject {
          * @public
          * @type {string}
          * @name tintcolor
-         * @memberOf me.TMXObject
+         * @memberof TMXObject
          */
         this.tintcolor = settings.tintcolor;
 
@@ -104,7 +103,7 @@ export default class TMXObject {
          * @public
          * @type {string}
          * @name type
-         * @memberOf me.TMXObject
+         * @memberof TMXObject
          */
         this.type = settings.type;
 
@@ -114,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;
 
@@ -123,7 +122,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name rotation
-         * @memberOf me.TMXObject
+         * @memberof TMXObject
          */
         this.rotation = degToRad(+settings.rotation || 0);
 
@@ -132,7 +131,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name id
-         * @memberOf me.TMXObject
+         * @memberof TMXObject
          */
         this.id = +settings.id || undefined;
 
@@ -141,7 +140,7 @@ export default class TMXObject {
          * @public
          * @type {string}
          * @name orientation
-         * @memberOf me.TMXObject
+         * @memberof TMXObject
          */
         this.orientation = map.orientation;
 
@@ -150,7 +149,7 @@ export default class TMXObject {
          * @public
          * @type {object[]}
          * @name shapes
-         * @memberOf me.TMXObject
+         * @memberof TMXObject
          */
         this.shapes = undefined;
 
@@ -159,7 +158,7 @@ export default class TMXObject {
          * @public
          * @type {boolean}
          * @name isEllipse
-         * @memberOf me.TMXObject
+         * @memberof TMXObject
          */
         this.isEllipse = false;
 
@@ -168,7 +167,7 @@ export default class TMXObject {
          * @public
          * @type {boolean}
          * @name isPolygon
-         * @memberOf me.TMXObject
+         * @memberof TMXObject
          */
         this.isPolygon = false;
 
@@ -177,7 +176,7 @@ export default class TMXObject {
          * @public
          * @type {boolean}
          * @name isPolyLine
-         * @memberOf me.TMXObject
+         * @memberof TMXObject
          */
         this.isPolyLine = false;
 
@@ -249,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;
@@ -267,39 +266,46 @@ export default class TMXObject {
                 this.width,
                 this.height
             )).rotate(this.rotation));
-        }
+        } else {
 
-        // add a polygon
-        else if (this.isPolygon === true) {
-            shapes.push((new Polygon(0, 0, this.points)).rotate(this.rotation));
-        }
+            // add a polygon
+            if (this.isPolygon === true) {
+                var _polygon = new Polygon(0, 0, this.points);
+                // make sure it's a convex polygon
+                if (_polygon.isConvex() === false ) {
+                    throw new Error("collision polygones in Tiled should be defined as Convex");
+                }
+                shapes.push(_polygon.rotate(this.rotation));
+            }
 
-        // add a polyline
-        else if (this.isPolyLine === true) {
-            var p = this.points;
-            var p1, p2;
-            var segments = p.length - 1;
-            for (i = 0; i < segments; i++) {
-                // clone the value before, as [i + 1]
-                // is reused later by the next segment
-                p1 = new Vector2d(p[i].x, p[i].y);
-                p2 = new Vector2d(p[i + 1].x, p[i + 1].y);
-                if (this.rotation !== 0) {
-                    p1 = p1.rotate(this.rotation);
-                    p2 = p2.rotate(this.rotation);
+            // add a polyline
+            else if (this.isPolyLine === true) {
+                var p = this.points;
+                var p1, p2;
+                var segments = p.length - 1;
+                for (i = 0; i < segments; i++) {
+                    // clone the value before, as [i + 1]
+                    // is reused later by the next segment
+                    p1 = new Vector2d(p[i].x, p[i].y);
+                    p2 = new Vector2d(p[i + 1].x, p[i + 1].y);
+                    if (this.rotation !== 0) {
+                        p1 = p1.rotate(this.rotation);
+                        p2 = p2.rotate(this.rotation);
+                    }
+                    shapes.push(new Line(0, 0, [ p1, p2 ]));
                 }
-                shapes.push(new Line(0, 0, [ p1, p2 ]));
             }
-        }
 
-        // it's a rectangle, returns a polygon object anyway
-        else {
-            shapes.push((new Polygon(
-                0, 0, [
-                    new Vector2d(), new Vector2d(this.width, 0),
-                    new Vector2d(this.width, this.height), new Vector2d(0, this.height)
-                ]
-            )).rotate(this.rotation));
+            // it's a rectangle, returns a polygon object anyway
+            else {
+                shapes.push((new Polygon(
+                    0, 0, [
+                        new Vector2d(), new Vector2d(this.width, 0),
+                        new Vector2d(this.width, this.height), new Vector2d(0, this.height)
+                    ]
+                )).rotate(this.rotation));
+            }
+
         }
 
         // Apply isometric projection