melonjs 10.2.0 → 10.3.0

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";
 
 /**
  * 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 {
@@ -20,63 +19,63 @@ export default class TMXObject {
         /**
          * point list in JSON format
          * @public
-         * @type Object[]
+         * @type {object[]}
          * @name points
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.points = undefined;
 
         /**
          * object name
          * @public
-         * @type String
+         * @type {string}
          * @name name
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.name = settings.name;
 
         /**
          * object x position
          * @public
-         * @type Number
+         * @type {number}
          * @name x
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.x = +settings.x;
 
         /**
          * object y position
          * @public
-         * @type Number
+         * @type {number}
          * @name y
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.y = +settings.y;
 
         /**
          * object z order
          * @public
-         * @type Number
+         * @type {number}
          * @name z
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.z = +z;
 
         /**
          * object width
          * @public
-         * @type Number
+         * @type {number}
          * @name width
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.width = +settings.width || 0;
 
         /**
          * object height
          * @public
-         * @type Number
+         * @type {number}
          * @name height
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.height = +settings.height || 0;
 
@@ -84,100 +83,100 @@ 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
+         * @memberof me.TMXObject
          */
         this.gid = +settings.gid || null;
 
         /**
          * tint color
          * @public
-         * @type String
+         * @type {string}
          * @name tintcolor
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.tintcolor = settings.tintcolor;
 
         /**
          * object type
          * @public
-         * @type String
+         * @type {string}
          * @name type
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.type = settings.type;
 
         /**
          * object text
          * @public
-         * @type Object
+         * @type {object}
          * @see http://docs.mapeditor.org/en/stable/reference/tmx-map-format/#text
          * @name type
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.type = settings.type;
 
         /**
          * The rotation of the object in radians clockwise (defaults to 0)
          * @public
-         * @type Number
+         * @type {number}
          * @name rotation
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.rotation = degToRad(+settings.rotation || 0);
 
         /**
          * object unique identifier per level (Tiled 0.11.x+)
          * @public
-         * @type Number
+         * @type {number}
          * @name id
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.id = +settings.id || undefined;
 
         /**
          * object orientation (orthogonal or isometric)
          * @public
-         * @type String
+         * @type {string}
          * @name orientation
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.orientation = map.orientation;
 
         /**
          * the collision shapes defined for this object
          * @public
-         * @type Array
+         * @type {object[]}
          * @name shapes
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.shapes = undefined;
 
         /**
          * if true, the object is an Ellipse
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @name isEllipse
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.isEllipse = false;
 
         /**
          * if true, the object is a Polygon
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @name isPolygon
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.isPolygon = false;
 
         /**
          * if true, the object is a PolyLine
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @name isPolyLine
-         * @memberOf me.TMXObject
+         * @memberof me.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 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;
@@ -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

package/src/level/tiled/TMXTile.js

@@ -11,12 +11,11 @@ var TMX_FLIP_H          = 0x80000000,
 /**
  * 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
+ * @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
  */
 class Tile extends Bounds {
@@ -42,7 +41,7 @@ class Tile extends Bounds {
         /**
          * tileset
          * @public
-         * @type me.TMXTileset
+         * @type {me.TMXTileset}
          * @name me.Tile#tileset
          */
         this.tileset = tileset;
@@ -60,28 +59,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 +88,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 +107,6 @@ class Tile extends Bounds {
 
     /**
      * set the transformation matrix for this tile
-     * @return {me.Matrix2d) a transformation matrix
      * @ignore
      */
     setTileTransform(transform) {
@@ -135,8 +133,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

@@ -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";
@@ -104,10 +104,9 @@ function readObjectGroup(map, data, z) {
  * 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
+ * @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));
@@ -128,7 +127,7 @@ export default class TMXTileMap {
         /**
          * name of the tilemap
          * @public
-         * @type {String}
+         * @type {string}
          * @name me.TMXTileMap#name
          */
         this.name = levelId;
@@ -136,14 +135,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 +150,7 @@ export default class TMXTileMap {
         /**
          * Tile width
          * @public
-         * @type {Number}
+         * @type {number}
          * @name me.TMXTileMap#tilewidth
          */
         this.tilewidth = +data.tilewidth;
@@ -159,7 +158,7 @@ export default class TMXTileMap {
         /**
          * Tile height
          * @public
-         * @type {Number}
+         * @type {number}
          * @name me.TMXTileMap#tileheight
          */
         this.tileheight = +data.tileheight;
@@ -167,7 +166,7 @@ export default class TMXTileMap {
         /**
          * is the map an infinite map
          * @public
-         * @type {Number}
+         * @type {number}
          * @default 0
          * @name me.TMXTileMap#infinite
          */
@@ -176,17 +175,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 +194,7 @@ export default class TMXTileMap {
         /**
          * the TMX format version
          * @public
-         * @type {String}
+         * @type {string}
          * @name me.TMXTileMap#version
          */
         this.version = data.version;
@@ -203,7 +202,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;
@@ -258,10 +257,10 @@ export default class TMXTileMap {
     /**
      * Return the map default renderer
      * @name getRenderer
-     * @memberOf me.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 +274,7 @@ export default class TMXTileMap {
      * @name me.TMXRenderer#getBounds
      * @public
      * @function
-     * @return {me.Bounds}
+     * @returns {me.Bounds}
      */
     getBounds() {
         // calculated in the constructor
@@ -369,7 +368,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 +403,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 +443,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 +590,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

@@ -8,9 +8,8 @@ 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})
+ * @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 {
 
@@ -51,7 +50,7 @@ export default class TMXTileset {
         /**
          * Tileset contains animated tiles
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @name me.TMXTileset#isAnimated
          */
         this.isAnimated = false;
@@ -59,7 +58,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 +66,7 @@ export default class TMXTileset {
         /**
          * Tileset animations
          * @private
-         * @type Map
+         * @type {Map}
          * @name me.TMXTileset#animations
          */
         this.animations = new Map();
@@ -75,7 +74,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 +172,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 +195,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 +207,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 +226,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

@@ -6,8 +6,7 @@ var TMX_CLEAR_BIT_MASK = ~(0x80000000 | 0x40000000 | 0x20000000);
  * @classdesc
  * an object containing all tileset
  * @class TMXTilesetGroup
- * @memberOf me
- * @constructor
+ * @memberof me
  */
 export default class TMXTilesetGroup {
 
@@ -33,8 +32,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 +45,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;