melonjs 10.2.3 → 10.3.0

package/src/level/tiled/TMXLayer.js

@@ -66,9 +66,8 @@ function preRenderLayer(layer, renderer) {
  * a TMX Tile Layer Object
  * Tiled QT 0.7.x format
  * @class
- * @extends me.Renderable
- * @memberOf me
- * @constructor
+ * @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
@@ -243,7 +242,7 @@ class TMXLayer extends Renderable {
     /**
      * Set the TMX renderer for this layer object
      * @name setRenderer
-     * @memberOf me.TMXLayer
+     * @memberof me.TMXLayer
      * @public
      * @function
      * @param {me.TMXRenderer} renderer
@@ -259,7 +258,7 @@ class TMXLayer extends Renderable {
     /**
      * Return the layer current renderer object
      * @name getRenderer
-     * @memberOf me.TMXLayer
+     * @memberof me.TMXLayer
      * @public
      * @function
      * @returns {me.TMXRenderer} renderer
@@ -272,7 +271,7 @@ class TMXLayer extends Renderable {
     /**
      * Return the TileId of the Tile at the specified position
      * @name getTileId
-     * @memberOf me.TMXLayer
+     * @memberof me.TMXLayer
      * @public
      * @function
      * @param {number} x X coordinate (in world/pixels coordinates)
@@ -287,7 +286,7 @@ class TMXLayer extends Renderable {
     /**
      * Return the Tile object at the specified position
      * @name getTile
-     * @memberOf me.TMXLayer
+     * @memberof me.TMXLayer
      * @public
      * @function
      * @param {number} x X coordinate (in world/pixels coordinates)
@@ -313,7 +312,7 @@ class TMXLayer extends Renderable {
     /**
      * assign the given Tile object to the specified position
      * @name getTile
-     * @memberOf me.TMXLayer
+     * @memberof me.TMXLayer
      * @public
      * @function
      * @param {me.Tile} tile the tile object to be assigned
@@ -329,7 +328,7 @@ class TMXLayer extends Renderable {
     /**
      * return a new the Tile object corresponding to the given tile id
      * @name setTile
-     * @memberOf me.TMXLayer
+     * @memberof me.TMXLayer
      * @public
      * @function
      * @param {number} tileId tileId
@@ -348,7 +347,7 @@ class TMXLayer extends Renderable {
     /**
      * Return the Tile object at the specified tile coordinates
      * @name cellAt
-     * @memberOf me.TMXLayer
+     * @memberof me.TMXLayer
      * @public
      * @function
      * @param {number} x x position of the tile (in Tile unit)
@@ -375,7 +374,7 @@ class TMXLayer extends Renderable {
     /**
      * clear the tile at the specified position
      * @name clearTile
-     * @memberOf me.TMXLayer
+     * @memberof me.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";
 
 /**
  * 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 me.TMXObject
          */
         this.points = undefined;
 
@@ -31,7 +30,7 @@ export default class TMXObject {
          * @public
          * @type {string}
          * @name name
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.name = settings.name;
 
@@ -40,7 +39,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name x
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.x = +settings.x;
 
@@ -49,7 +48,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name y
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.y = +settings.y;
 
@@ -58,7 +57,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name z
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.z = +z;
 
@@ -67,7 +66,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name width
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.width = +settings.width || 0;
 
@@ -76,7 +75,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name height
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.height = +settings.height || 0;
 
@@ -86,7 +85,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name gid
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.gid = +settings.gid || null;
 
@@ -95,7 +94,7 @@ export default class TMXObject {
          * @public
          * @type {string}
          * @name tintcolor
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.tintcolor = settings.tintcolor;
 
@@ -104,7 +103,7 @@ export default class TMXObject {
          * @public
          * @type {string}
          * @name type
-         * @memberOf me.TMXObject
+         * @memberof me.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 me.TMXObject
          */
         this.type = settings.type;
 
@@ -123,7 +122,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name rotation
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.rotation = degToRad(+settings.rotation || 0);
 
@@ -132,7 +131,7 @@ export default class TMXObject {
          * @public
          * @type {number}
          * @name id
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.id = +settings.id || undefined;
 
@@ -141,7 +140,7 @@ export default class TMXObject {
          * @public
          * @type {string}
          * @name orientation
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.orientation = map.orientation;
 
@@ -150,7 +149,7 @@ export default class TMXObject {
          * @public
          * @type {object[]}
          * @name shapes
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.shapes = undefined;
 
@@ -159,7 +158,7 @@ export default class TMXObject {
          * @public
          * @type {boolean}
          * @name isEllipse
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.isEllipse = false;
 
@@ -168,7 +167,7 @@ export default class TMXObject {
          * @public
          * @type {boolean}
          * @name isPolygon
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.isPolygon = false;
 
@@ -177,7 +176,7 @@ export default class TMXObject {
          * @public
          * @type {boolean}
          * @name isPolyLine
-         * @memberOf me.TMXObject
+         * @memberof me.TMXObject
          */
         this.isPolyLine = false;
 
@@ -249,7 +248,7 @@ 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
      * @returns {me.Polygon[]|me.Line[]|me.Ellipse[]} an array of shape objects
@@ -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,9 +11,8 @@ var TMX_FLIP_H          = 0x80000000,
 /**
  * a basic tile object
  * @class
- * @extends me.Bounds
- * @memberOf me
- * @constructor
+ * @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

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,8 +104,7 @@ function readObjectGroup(map, data, z) {
  * a TMX Tile Map Object
  * Tiled QT +0.7.x format
  * @class TMXTileMap
- * @memberOf me
- * @constructor
+ * @memberof me
  * @param {string} levelId name of TMX map
  * @param {object} data TMX map in JSON format
  * @example
@@ -258,7 +257,7 @@ export default class TMXTileMap {
     /**
      * Return the map default renderer
      * @name getRenderer
-     * @memberOf me.TMXTileMap
+     * @memberof me.TMXTileMap
      * @public
      * @function
      * @returns {me.TMXRenderer} a TMX renderer

package/src/level/tiled/TMXTileset.js

@@ -8,8 +8,7 @@ import loader from "./../../loader/loader.js";
  * @classdesc
  * a TMX Tile Set Object
  * @class TMXTileset
- * @memberOf me
- * @constructor
+ * @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 {

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 {
 

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

@@ -23,9 +23,8 @@ var offsetsStaggerY = [
  * @classdesc
  * an Hexagonal Map Renderder
  * @class TMXHexagonalRenderer
- * @memberOf me
- * @extends me.TMXRenderer
- * @constructor
+ * @memberof me
+ * @augments me.TMXRenderer
  * @param {me.TMXTileMap} map the TMX map
  */
 class TMXHexagonalRenderer extends TMXRenderer {

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

@@ -8,9 +8,8 @@ import TMXLayer from "./../TMXLayer.js";
  * @classdesc
  * an Isometric Map Renderder
  * @class TMXIsometricRenderer
- * @memberOf me
- * @extends me.TMXRenderer
- * @constructor
+ * @memberof me
+ * @augments me.TMXRenderer
  * @param {me.TMXTileMap} map the TMX map
  */
 class TMXIsometricRenderer extends TMXRenderer {

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

@@ -6,9 +6,8 @@ import TMXRenderer from "./TMXRenderer.js";
  * @classdesc
  * an Orthogonal Map Renderder
  * @class TMXOrthogonalRenderer
- * @memberOf me
- * @extends me.TMXRenderer
- * @constructor
+ * @memberof me
+ * @augments me.TMXRenderer
  * @param {me.TMXTileMap} map the TMX map
  */
 class TMXOrthogonalRenderer extends TMXRenderer {

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

@@ -8,8 +8,7 @@ import Bounds from "./../../../physics/Bounds.js";
  * @classdesc
  * The map renderer base class
  * @class TMXRenderer
- * @memberOf me
- * @constructor
+ * @memberof me
  * @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

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

@@ -8,9 +8,8 @@ import { degToRad } from "./../../../math/math.js";
  * @classdesc
  * a Staggered Map Renderder
  * @class TMXStaggeredRenderer
- * @memberOf me
- * @extends me.TMXHexagonalRenderer
- * @constructor
+ * @memberof me
+ * @augments me.TMXHexagonalRenderer
  * @param {me.TMXTileMap} map the TMX map
  */
 class TMXStaggeredRenderer extends TMXHexagonalRenderer {

package/src/loader/loader.js

@@ -294,7 +294,7 @@ function preloadJavascript(data, onload, onerror) {
 /**
  * a small class to manage loading of stuff and manage resources
  * @namespace loader
- * @memberOf me
+ * @memberof me
  */
 var loader = {
 
@@ -313,7 +313,7 @@ var loader = {
      * @public
      * @function
      * @name onload
-     * @memberOf me.loader
+     * @memberof me.loader
      * @example
      * // set a callback when everything is loaded
      * me.loader.onload = this.loaded.bind(this);
@@ -327,7 +327,7 @@ var loader = {
      * @public
      * @function
      * @name onProgress
-     * @memberOf me.loader
+     * @memberof me.loader
      * @example
      * // set a callback for progress notification
      * me.loader.onProgress = this.updateProgress.bind(this);
@@ -343,7 +343,7 @@ var loader = {
      * @type {string}
      * @name crossOrigin
      * @default undefined
-     * @memberOf me.loader
+     * @memberof me.loader
      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_settings_attributes
      * @example
      *  // allow for cross-origin texture loading in WebGL
@@ -361,7 +361,7 @@ var loader = {
      * @type {boolean}
      * @name withCredentials
      * @default false
-     * @memberOf me.loader
+     * @memberof me.loader
      * @see https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials
      * @example
      *  // enable withCredentials
@@ -411,7 +411,7 @@ var loader = {
      * change the default baseURL for the given asset type.<br>
      * (this will prepend the asset URL and must finish with a '/')
      * @name setBaseURL
-     * @memberOf me.loader
+     * @memberof me.loader
      * @public
      * @function
      * @param {string} type  "*", "audio", binary", "image", "json", "js", "tmx", "tsx"
@@ -442,7 +442,7 @@ var loader = {
     /**
      * set all the specified game resources to be preloaded.
      * @name preload
-     * @memberOf me.loader
+     * @memberof me.loader
      * @public
      * @function
      * @param {object[]} res
@@ -507,7 +507,7 @@ var loader = {
     /**
      * Load a single resource (to be used if you need to load additional resource during the game)
      * @name load
-     * @memberOf me.loader
+     * @memberof me.loader
      * @public
      * @function
      * @param {object} res
@@ -577,12 +577,14 @@ var loader = {
     /**
      * unload specified resource to free memory
      * @name unload
-     * @memberOf me.loader
+     * @memberof me.loader
      * @public
      * @function
      * @param {object} res
+     * @param {string} res.name internal name of the resource
+     * @param {string} res.type  "audio", binary", "image", "json", "tmx", "tsx"
      * @returns {boolean} true if unloaded
-     * @example me.loader.unload({name: "avatar",  type:"image",  src: "data/avatar.png"});
+     * @example me.loader.unload({name: "avatar",  type:"image"});
      */
     unload(res) {
         switch (res.type) {
@@ -637,7 +639,7 @@ var loader = {
     /**
      * unload all resources to free memory
      * @name unloadAll
-     * @memberOf me.loader
+     * @memberof me.loader
      * @public
      * @function
      * @example me.loader.unloadAll();
@@ -692,7 +694,7 @@ var loader = {
     /**
      * return the specified TMX/TSX object
      * @name getTMX
-     * @memberOf me.loader
+     * @memberof me.loader
      * @public
      * @function
      * @param {string} elt name of the tmx/tsx element ("map1");
@@ -710,7 +712,7 @@ var loader = {
     /**
      * return the specified Binary object
      * @name getBinary
-     * @memberOf me.loader
+     * @memberof me.loader
      * @public
      * @function
      * @param {string} elt name of the binary object ("ymTrack");
@@ -728,7 +730,7 @@ var loader = {
     /**
      * return the specified Image Object
      * @name getImage
-     * @memberOf me.loader
+     * @memberof me.loader
      * @public
      * @function
      * @param {string} image name of the Image element ("tileset-platformer");
@@ -747,7 +749,7 @@ var loader = {
     /**
      * return the specified JSON Object
      * @name getJSON
-     * @memberOf me.loader
+     * @memberof me.loader
      * @public
      * @function
      * @param {string} elt name of the json file to load

package/src/loader/loadingscreen.js

@@ -118,9 +118,8 @@ class IconLogo extends Renderable {
 
 /**
  * a default loading screen
- * @memberOf me
+ * @memberof me
  * @ignore
- * @constructor
  */
 class DefaultLoadingScreen extends Stage {
     /**