melonjs 10.2.1 → 10.2.2

package/src/input/pointerevent.js

@@ -1,6 +1,5 @@
 import {preventDefault} from "./input.js";
 import {getBindingKey, triggerKeyEvent} from "./keyboard.js";
-import Vector2d from "./../math/vector2.js";
 import { renderer, scaleRatio } from "./../video/video.js";
 import * as fctUtil from "./../utils/function.js";
 import * as arrayUtil from "./../utils/array.js";
@@ -11,13 +10,11 @@ import device from "./../system/device.js";
 import Pointer from "./pointer.js";
 import Rect from "./../shapes/rectangle.js";
 import Container from "./../renderable/container.js";
-import Renderable from "./../renderable/renderable.js";
 import { world, viewport } from "./../game.js";
 
-
 /**
  * A pool of `Pointer` objects to cache pointer/touch event coordinates.
- * @type {Array.<Vector>}
+ * @type {Array.<me.Vector2d>}
  * @ignore
  */
 var T_POINTERS = [];
@@ -292,7 +289,7 @@ function dispatchEvent(normalizedEvents) {
                 var bounds = region.getBounds();
                 var eventInBounds = false;
 
-                if (region.floating === true) {
+                if (region.isFloating === true) {
                     pointer.gameX = pointer.gameLocalX = pointer.gameScreenX;
                     pointer.gameY = pointer.gameLocalY = pointer.gameScreenY;
                 } else {
@@ -308,10 +305,11 @@ function dispatchEvent(normalizedEvents) {
                     pointer.gameLocalY = pointer.gameY - parentBounds.y;
                 }
 
+                var gameX = pointer.gameX;
+                var gameY = pointer.gameY;
+
                 // apply inverse transformation for renderable
-                if (region instanceof Renderable) {
-                    var gameX = pointer.gameX;
-                    var gameY = pointer.gameY;
+                if (typeof region.currentTransform !== "undefined") {
                     if (!region.currentTransform.isIdentity()) {
                         var invV = region.currentTransform.applyInverse(
                             pool.pull("Vector2d", gameX, gameY)
@@ -320,14 +318,8 @@ function dispatchEvent(normalizedEvents) {
                         gameY = invV.y;
                         pool.push(invV);
                     }
-                    eventInBounds = bounds.contains(gameX, gameY);
-                } else {
-                    eventInBounds =
-                        bounds.contains(pointer.gameX, pointer.gameY) &&
-                        (bounds === region ||
-                        // if the given target is another shape than me.Rect
-                        region.contains(pointer.gameLocalX, pointer.gameLocalY));
                 }
+                eventInBounds = bounds.contains(gameX, gameY);
 
                 switch (pointer.type) {
                     case POINTER_MOVE[0]:
@@ -498,7 +490,7 @@ function onPointerEvent(e) {
  /**
   * the default target element for pointer events (usually the canvas element in which the game is rendered)
   * @public
-  * @type EventTarget
+  * @type {EventTarget}
   * @name pointerEventTarget
   * @memberOf me.input
   */
@@ -518,7 +510,7 @@ export var pointer = new Pointer(0, 0, 1, 1);
  * default value : "1000/me.timer.maxfps" ms<br>
  * set to 0 ms to disable the feature
  * @public
- * @type Number
+ * @type {number}
  * @name throttlingInterval
  * @memberOf me.input
  */
@@ -531,10 +523,10 @@ export var throttlingInterval;
  * @memberOf me.input
  * @public
  * @function
- * @param {Number} x the global x coordinate to be translated.
- * @param {Number} y the global y coordinate to be translated.
+ * @param {number} x the global x coordinate to be translated.
+ * @param {number} y the global y coordinate to be translated.
  * @param {me.Vector2d} [v] an optional vector object where to set the translated coordinates
- * @return {me.Vector2d} A vector object with the corresponding translated coordinates
+ * @returns {me.Vector2d} A vector object with the corresponding translated coordinates
  * @example
  * onMouseEvent : function (pointer) {
  *    // convert the given into local (viewport) relative coordinates
@@ -543,7 +535,7 @@ export var throttlingInterval;
  * };
  */
 export function globalToLocal(x, y, v) {
-    v = v || new Vector2d();
+    v = v || pool.pull("Vector2d");
     var rect = device.getElementBounds(renderer.getScreenCanvas());
     var pixelRatio = device.devicePixelRatio;
     x -= rect.left + (window.pageXOffset || 0);
@@ -565,7 +557,7 @@ export function globalToLocal(x, y, v) {
  * @public
  * @function
  * @param {HTMLCanvasElement} element
- * @param {String} [value="none"]
+ * @param {string} [value="none"]
  */
 export function setTouchAction(element, value) {
     element.style["touch-action"] = value || "none";
@@ -580,7 +572,7 @@ export function setTouchAction(element, value) {
  * @memberOf me.input
  * @public
  * @function
- * @param {Number} [button=me.input.pointer.LEFT] (accordingly to W3C values : 0,1,2 for left, middle and right buttons)
+ * @param {number} [button=me.input.pointer.LEFT] (accordingly to W3C values : 0,1,2 for left, middle and right buttons)
  * @param {me.input.KEY} keyCode
  * @example
  * // enable the keyboard
@@ -611,7 +603,7 @@ export function bindPointer() {
  * @memberOf me.input
  * @public
  * @function
- * @param {Number} [button=me.input.pointer.LEFT] (accordingly to W3C values : 0,1,2 for left, middle and right buttons)
+ * @param {number} [button=me.input.pointer.LEFT] (accordingly to W3C values : 0,1,2 for left, middle and right buttons)
  * @example
  * me.input.unbindPointer(me.input.pointer.LEFT);
  */
@@ -633,7 +625,7 @@ export function unbindPointer(button) {
  * @memberOf me.input
  * @public
  * @function
- * @param {String} eventType The event type for which the object is registering <br>
+ * @param {string} eventType The event type for which the object is registering <br>
  * melonJS currently supports: <br>
  * <ul>
  *   <li><code>"pointermove"</code></li>
@@ -705,7 +697,7 @@ export function registerPointerEvent(eventType, region, callback) {
  * @memberOf me.input
  * @public
  * @function
- * @param {String} eventType The event type for which the object was registered. See {@link me.input.registerPointerEvent}
+ * @param {string} eventType The event type for which the object was registered. See {@link me.input.registerPointerEvent}
  * @param {me.Rect|me.Polygon|me.Line|me.Ellipse} region the registered region to release for this event
  * @param {Function} [callback="all"] if specified unregister the event only for the specific callback
  * @example

package/src/lang/deprecated.js

@@ -10,9 +10,9 @@
  * @function
  * @memberOf me.deprecated
  * @name warning
- * @param {String} deprecated deprecated class,function or property name
- * @param {String} replacement the replacement class, function, or property name
- * @param {String} version the version since when the lass,function or property is deprecated
+ * @param {string} deprecated deprecated class,function or property name
+ * @param {string} replacement the replacement class, function, or property name
+ * @param {string} version the version since when the lass,function or property is deprecated
  */
 export function warning(deprecated, replacement, version) {
     var msg = "melonJS: %s is deprecated since version %s, please use %s";

package/src/level/level.js

@@ -13,6 +13,9 @@ var levelIdx = [];
 // current level index
 var currentLevelIdx = 0;
 
+/**
+ * @ignore
+ */
 function safeLoadLevel(levelId, options, restart) {
     // clean the destination container
     options.container.reset();
@@ -48,8 +51,8 @@ function safeLoadLevel(levelId, options, restart) {
  * @name loadTMXLevel
  * @memberOf me.level
  * @private
- * @param {String} level level id
- * @param {me.Container} target container
+ * @param {string} levelId level id
+ * @param {me.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
@@ -84,10 +87,10 @@ var level = {
      * @memberOf me.level
      * @public
      * @function
-     * @param {String} format level format (only "tmx" supported)
-     * @param {String} levelId the level id (or name)
+     * @param {string} format level format (only "tmx" supported)
+     * @param {string} levelId the level id (or name)
      * @param {Function} [callback] a function to be called once the level is loaded
-     * @return {Boolean} true if the level was loaded
+     * @returns {boolean} true if the level was loaded
      */
     add(format, levelId, callback) {
         switch (format) {
@@ -123,12 +126,13 @@ var level = {
      * @memberOf me.level
      * @public
      * @function
-     * @param {String} level level id
-     * @param {Object} [options] additional optional parameters
+     * @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 {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 {boolean} [options.setViewportBounds=true] if true, set the viewport bounds to the map size
+     * @returns {boolean} true if the level was successfully loaded
      * @example
      * // the game assets to be be preloaded
      * // TMX maps
@@ -196,7 +200,7 @@ var level = {
      * @memberOf me.level
      * @public
      * @function
-     * @return {String}
+     * @returns {string}
      */
     getCurrentLevelId() {
         return levelIdx[currentLevelIdx];
@@ -210,7 +214,7 @@ var level = {
      * @memberOf me.level
      * @public
      * @function
-     * @return {me.TMXTileMap}
+     * @returns {me.TMXTileMap}
      */
     getCurrentLevel() {
         return levels[this.getCurrentLevelId()];
@@ -222,10 +226,11 @@ var level = {
      * @memberOf me.level
      * @public
      * @function
-     * @param {Object} [options] additional optional parameters
+     * @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 {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
+     * @returns {object} the current level
      */
     reload(options) {
         // reset the level to initial state
@@ -239,10 +244,11 @@ var level = {
      * @memberOf me.level
      * @public
      * @function
-     * @param {Object} [options] additional optional parameters
+     * @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 {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
+     * @returns {boolean} true if the next level was successfully loaded
      */
     next(options) {
         //go to the next level
@@ -260,10 +266,11 @@ var level = {
      * @memberOf me.level
      * @public
      * @function
-     * @param {Object} [options] additional optional parameters
+     * @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 {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
+     * @returns {boolean} true if the previous level was successfully loaded
      */
     previous(options) {
         // go to previous level
@@ -281,6 +288,7 @@ var level = {
      * @memberOf me.level
      * @public
      * @function
+     * @returns {number} the amount of level preloaded
      */
     levelCount() {
         return levelIdx.length;

package/src/level/tiled/TMXGroup.js

@@ -18,7 +18,7 @@ export default class TMXGroup {
         /**
          * group name
          * @public
-         * @type String
+         * @type {string}
          * @name name
          * @memberOf me.TMXGroup
          */
@@ -27,7 +27,7 @@ export default class TMXGroup {
         /**
          * group width
          * @public
-         * @type Number
+         * @type {number}
          * @name width
          * @memberOf me.TMXGroup
          */
@@ -36,7 +36,7 @@ export default class TMXGroup {
         /**
          * group height
          * @public
-         * @type Number
+         * @type {number}
          * @name height
          * @memberOf me.TMXGroup
          */
@@ -45,7 +45,7 @@ export default class TMXGroup {
         /**
          * tint color
          * @public
-         * @type String
+         * @type {string}
          * @name tintcolor
          * @memberOf me.TMXGroup
          */
@@ -54,7 +54,7 @@ export default class TMXGroup {
         /**
          * group z order
          * @public
-         * @type Number
+         * @type {number}
          * @name z
          * @memberOf me.TMXGroup
          */
@@ -64,7 +64,7 @@ export default class TMXGroup {
          * group objects list definition
          * @see me.TMXObject
          * @public
-         * @type Array
+         * @type {object[]}
          * @name name
          * @memberOf me.TMXGroup
          */

package/src/level/tiled/TMXLayer.js

@@ -69,13 +69,13 @@ function preRenderLayer(layer, renderer) {
  * @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 {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
+ * @param {number} z z-index position
  */
 class TMXLayer extends Renderable {
     /**
@@ -95,7 +95,7 @@ class TMXLayer extends Renderable {
         /**
          * The Layer corresponding Tilesets
          * @public
-         * @type me.TMXTilesetGroup
+         * @type {me.TMXTilesetGroup}
          * @name me.TMXLayer#tilesets
          */
         this.tilesets = tilesets;
@@ -118,7 +118,7 @@ class TMXLayer extends Renderable {
         /**
          * All animated tilesets in this layer
          * @ignore
-         * @type Array
+         * @type {me.TMXTileset[]}
          * @name me.TMXLayer#animatedTilesets
          */
         this.animatedTilesets = [];
@@ -126,7 +126,7 @@ class TMXLayer extends Renderable {
         /**
          * Layer contains tileset animations
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @name me.TMXLayer#isAnimated
          */
         this.isAnimated = false;
@@ -135,7 +135,7 @@ class TMXLayer extends Renderable {
          * 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.TMXLayer#renderorder
          */
@@ -262,7 +262,7 @@ class TMXLayer extends Renderable {
      * @memberOf me.TMXLayer
      * @public
      * @function
-     * @return {me.TMXRenderer} renderer
+     * @returns {me.TMXRenderer} renderer
      */
     getRenderer() {
         return this.renderer;
@@ -275,9 +275,9 @@ class TMXLayer extends Renderable {
      * @memberOf me.TMXLayer
      * @public
      * @function
-     * @param {Number} x X coordinate (in world/pixels coordinates)
-     * @param {Number} y Y coordinate (in world/pixels coordinates)
-     * @return {Number} TileId or null if there is no Tile at the given position
+     * @param {number} x X coordinate (in world/pixels coordinates)
+     * @param {number} y Y coordinate (in world/pixels coordinates)
+     * @returns {number} TileId or null if there is no Tile at the given position
      */
     getTileId(x, y) {
         var tile = this.getTile(x, y);
@@ -290,9 +290,9 @@ class TMXLayer extends Renderable {
      * @memberOf me.TMXLayer
      * @public
      * @function
-     * @param {Number} x X coordinate (in world/pixels coordinates)
-     * @param {Number} y Y coordinate (in world/pixels coordinates)
-     * @return {me.Tile} corresponding tile or null if there is no defined tile at the coordinate or if outside of the layer bounds
+     * @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
      * @example
      * // get the TMX Map Layer called "Front layer"
      * var layer = me.game.world.getChildByName("Front Layer")[0];
@@ -316,10 +316,10 @@ class TMXLayer extends Renderable {
      * @memberOf me.TMXLayer
      * @public
      * @function
-     * @return {me.Tile} a Tile object
-     * @param {Number} x X coordinate (in world/pixels coordinates)
-     * @param {Number} y Y coordinate (in world/pixels coordinates)
-     * @return {me.Tile} the tile object
+     * @param {me.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
      */
     setTile(tile, x, y) {
         this.layerData[x][y] = tile;
@@ -332,10 +332,10 @@ class TMXLayer extends Renderable {
      * @memberOf me.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)
-     * @return {me.Tile} the tile object
+     * @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
      */
     getTileById(tileId, x, y) {
         if (!this.tileset.contains(tileId)) {
@@ -351,10 +351,10 @@ class TMXLayer extends Renderable {
      * @memberOf me.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
-     * @return {me.Tile} corresponding tile or null if there is no defined tile at the position or if outside of the layer bounds
+     * @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
      * @example
      * // return the first tile at offset 0, 0
      * var tile = layer.cellAt(0, 0);
@@ -378,8 +378,8 @@ class TMXLayer extends Renderable {
      * @memberOf me.TMXLayer
      * @public
      * @function
-     * @param {Number} x X coordinate (in map coordinates: row/column)
-     * @param {Number} y Y coordinate (in map coordinates: row/column)
+     * @param {number} x X coordinate (in map coordinates: row/column)
+     * @param {number} y Y coordinate (in map coordinates: row/column)
      * @example
      * me.game.world.getChildByType(me.TMXLayer).forEach(function(layer) {
      *     // clear all tiles at the given x,y coordinates

package/src/level/tiled/TMXObject.js

@@ -20,7 +20,7 @@ export default class TMXObject {
         /**
          * point list in JSON format
          * @public
-         * @type Object[]
+         * @type {object[]}
          * @name points
          * @memberOf me.TMXObject
          */
@@ -29,7 +29,7 @@ export default class TMXObject {
         /**
          * object name
          * @public
-         * @type String
+         * @type {string}
          * @name name
          * @memberOf me.TMXObject
          */
@@ -38,7 +38,7 @@ export default class TMXObject {
         /**
          * object x position
          * @public
-         * @type Number
+         * @type {number}
          * @name x
          * @memberOf me.TMXObject
          */
@@ -47,7 +47,7 @@ export default class TMXObject {
         /**
          * object y position
          * @public
-         * @type Number
+         * @type {number}
          * @name y
          * @memberOf me.TMXObject
          */
@@ -56,7 +56,7 @@ export default class TMXObject {
         /**
          * object z order
          * @public
-         * @type Number
+         * @type {number}
          * @name z
          * @memberOf me.TMXObject
          */
@@ -65,7 +65,7 @@ export default class TMXObject {
         /**
          * object width
          * @public
-         * @type Number
+         * @type {number}
          * @name width
          * @memberOf me.TMXObject
          */
@@ -74,7 +74,7 @@ export default class TMXObject {
         /**
          * object height
          * @public
-         * @type Number
+         * @type {number}
          * @name height
          * @memberOf me.TMXObject
          */
@@ -84,7 +84,7 @@ 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
          */
@@ -93,7 +93,7 @@ export default class TMXObject {
         /**
          * tint color
          * @public
-         * @type String
+         * @type {string}
          * @name tintcolor
          * @memberOf me.TMXObject
          */
@@ -102,7 +102,7 @@ export default class TMXObject {
         /**
          * object type
          * @public
-         * @type String
+         * @type {string}
          * @name type
          * @memberOf me.TMXObject
          */
@@ -111,7 +111,7 @@ export default class TMXObject {
         /**
          * object text
          * @public
-         * @type Object
+         * @type {object}
          * @see http://docs.mapeditor.org/en/stable/reference/tmx-map-format/#text
          * @name type
          * @memberOf me.TMXObject
@@ -121,7 +121,7 @@ export default class TMXObject {
         /**
          * The rotation of the object in radians clockwise (defaults to 0)
          * @public
-         * @type Number
+         * @type {number}
          * @name rotation
          * @memberOf me.TMXObject
          */
@@ -130,7 +130,7 @@ export default class TMXObject {
         /**
          * object unique identifier per level (Tiled 0.11.x+)
          * @public
-         * @type Number
+         * @type {number}
          * @name id
          * @memberOf me.TMXObject
          */
@@ -139,7 +139,7 @@ export default class TMXObject {
         /**
          * object orientation (orthogonal or isometric)
          * @public
-         * @type String
+         * @type {string}
          * @name orientation
          * @memberOf me.TMXObject
          */
@@ -148,7 +148,7 @@ export default class TMXObject {
         /**
          * the collision shapes defined for this object
          * @public
-         * @type Array
+         * @type {object[]}
          * @name shapes
          * @memberOf me.TMXObject
          */
@@ -157,7 +157,7 @@ export default class TMXObject {
         /**
          * if true, the object is an Ellipse
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @name isEllipse
          * @memberOf me.TMXObject
          */
@@ -166,7 +166,7 @@ export default class TMXObject {
         /**
          * if true, the object is a Polygon
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @name isPolygon
          * @memberOf me.TMXObject
          */
@@ -175,7 +175,7 @@ export default class TMXObject {
         /**
          * if true, the object is a PolyLine
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @name isPolyLine
          * @memberOf me.TMXObject
          */
@@ -252,7 +252,7 @@ export default class 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;