melonjs 10.1.0 → 10.2.2

package/src/input/pointer.js

@@ -14,7 +14,7 @@ var tmpVec = new Vector2d();
 /**
  * @classdesc
  * a pointer object, representing a single finger on a touch enabled device.
- * @class
+ * @class Pointer
  * @extends me.Bounds
  * @memberOf me
  * @constructor
@@ -35,7 +35,7 @@ class Pointer extends Bounds {
         /**
          * constant for left button
          * @public
-         * @type {Number}
+         * @type {number}
          * @name LEFT
          * @memberOf me.Pointer
          */
@@ -44,7 +44,7 @@ class Pointer extends Bounds {
         /**
          * constant for middle button
          * @public
-         * @type {Number}
+         * @type {number}
          * @name MIDDLE
          * @memberOf me.Pointer
          */
@@ -53,7 +53,7 @@ class Pointer extends Bounds {
         /**
          * constant for right button
          * @public
-         * @type {Number}
+         * @type {number}
          * @name RIGHT
          * @memberOf me.Pointer
          */
@@ -74,7 +74,7 @@ class Pointer extends Bounds {
         /**
          * a string containing the event's type.
          * @public
-         * @type {String}
+         * @type {string}
          * @name type
          * @see https://developer.mozilla.org/en-US/docs/Web/API/Event/type
          * @memberOf me.Pointer
@@ -85,7 +85,7 @@ class Pointer extends Bounds {
         /**
          * the button property indicates which button was pressed on the mouse to trigger the event.
          * @public
-         * @type {Number}
+         * @type {number}
          * @name button
          * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/button
          * @memberOf me.Pointer
@@ -95,7 +95,7 @@ class Pointer extends Bounds {
         /**
          * indicates whether or not the pointer device that created the event is the primary pointer.
          * @public
-         * @type {Boolean}
+         * @type {boolean}
          * @name isPrimary
          * @see https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/isPrimary
          * @memberOf me.Pointer
@@ -105,7 +105,7 @@ class Pointer extends Bounds {
         /**
          * the horizontal coordinate at which the event occurred, relative to the left edge of the entire document.
          * @public
-         * @type {Number}
+         * @type {number}
          * @name pageX
          * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/pageX
          * @memberOf me.Pointer
@@ -115,7 +115,7 @@ class Pointer extends Bounds {
         /**
          * the vertical coordinate at which the event occurred, relative to the left edge of the entire document.
          * @public
-         * @type {Number}
+         * @type {number}
          * @name pageY
          * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/pageY
          * @memberOf me.Pointer
@@ -125,7 +125,7 @@ class Pointer extends Bounds {
         /**
          * the horizontal coordinate within the application's client area at which the event occurred
          * @public
-         * @type {Number}
+         * @type {number}
          * @name clientX
          * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/clientX
          * @memberOf me.Pointer
@@ -135,7 +135,7 @@ class Pointer extends Bounds {
        /**
         * the vertical coordinate within the application's client area at which the event occurred
         * @public
-        * @type {Number}
+        * @type {number}
         * @name clientY
         * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/clientY
         * @memberOf me.Pointer
@@ -145,7 +145,7 @@ class Pointer extends Bounds {
         /**
          * an unsigned long representing the unit of the delta values scroll amount
          * @public
-         * @type {Number}
+         * @type {number}
          * @name deltaMode
          * @see https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaMode
          * @memberOf me.Pointer
@@ -155,7 +155,7 @@ class Pointer extends Bounds {
         /**
          * a double representing the horizontal scroll amount in the Wheel Event deltaMode unit.
          * @public
-         * @type {Number}
+         * @type {number}
          * @name deltaX
          * @see https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaX
          * @memberOf me.Pointer
@@ -165,7 +165,7 @@ class Pointer extends Bounds {
         /**
          * a double representing the vertical scroll amount in the Wheel Event deltaMode unit.
          * @public
-         * @type {Number}
+         * @type {number}
          * @name deltaY
          * @see https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaY
          * @memberOf me.Pointer
@@ -175,7 +175,7 @@ class Pointer extends Bounds {
         /**
          * a double representing the scroll amount in the z-axis, in the Wheel Event deltaMode unit.
          * @public
-         * @type {Number}
+         * @type {number}
          * @name deltaZ
          * @see https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaZ
          * @memberOf me.Pointer
@@ -186,7 +186,7 @@ class Pointer extends Bounds {
          * Event normalized X coordinate within the game canvas itself<br>
          * <img src="images/event_coord.png"/>
          * @public
-         * @type {Number}
+         * @type {number}
          * @name gameX
          * @memberOf me.Pointer
          */
@@ -196,7 +196,7 @@ class Pointer extends Bounds {
          * Event normalized Y coordinate within the game canvas itself<br>
          * <img src="images/event_coord.png"/>
          * @public
-         * @type {Number}
+         * @type {number}
          * @name gameY
          * @memberOf me.Pointer
          */
@@ -205,7 +205,7 @@ class Pointer extends Bounds {
         /**
          * Event X coordinate relative to the viewport
          * @public
-         * @type {Number}
+         * @type {number}
          * @name gameScreenX
          * @memberOf me.Pointer
          */
@@ -214,7 +214,7 @@ class Pointer extends Bounds {
         /**
          * Event Y coordinate relative to the viewport
          * @public
-         * @type {Number}
+         * @type {number}
          * @name gameScreenY
          * @memberOf me.Pointer
          */
@@ -223,7 +223,7 @@ class Pointer extends Bounds {
         /**
          * Event X coordinate relative to the map
          * @public
-         * @type {Number}
+         * @type {number}
          * @name gameWorldX
          * @memberOf me.Pointer
          */
@@ -232,7 +232,7 @@ class Pointer extends Bounds {
         /**
          * Event Y coordinate relative to the map
          * @public
-         * @type {Number}
+         * @type {number}
          * @name gameWorldY
          * @memberOf me.Pointer
          */
@@ -241,7 +241,7 @@ class Pointer extends Bounds {
         /**
          * Event X coordinate relative to the holding container
          * @public
-         * @type {Number}
+         * @type {number}
          * @name gameLocalX
          * @memberOf me.Pointer
          */
@@ -250,21 +250,30 @@ class Pointer extends Bounds {
         /**
          * Event Y coordinate relative to the holding container
          * @public
-         * @type {Number}
+         * @type {number}
          * @name gameLocalY
          * @memberOf me.Pointer
          */
         this.gameLocalY = 0;
 
        /**
-         * The unique identifier of the contact for a touch, mouse or pen
+        * The unique identifier of the contact for a touch, mouse or pen
+        * @public
+        * @type {number}
+        * @name pointerId
+        * @memberOf me.Pointer
+        * @see https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/pointerId
+        */
+        this.pointerId = undefined;
+
+        /**
+         * true if not originally a pointer event
          * @public
-         * @type {Number}
-         * @name pointerId
+         * @type {boolean}
+         * @name isNormalized
          * @memberOf me.Pointer
-         * @see https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/pointerId
          */
-        this.pointerId = undefined;
+        this.isNormalized = false;
 
         // bind list for mouse buttons
         this.bind = [ 0, 0, 0 ];
@@ -276,11 +285,11 @@ class Pointer extends Bounds {
      * @private
      * @function
      * @param {Event} event the original Event object
-     * @param {Number} [pageX=0] the horizontal coordinate at which the event occurred, relative to the left edge of the entire document
-     * @param {Number} [pageY=0] the vertical coordinate at which the event occurred, relative to the left edge of the entire document
-     * @param {Number} [clientX=0] the horizontal coordinate within the application's client area at which the event occurred
-     * @param {Number} [clientX=0] the vertical coordinate within the application's client area at which the event occurred
-     * @param {Number} [pointedId=1] the Pointer, Touch or Mouse event Id (1)
+     * @param {number} [pageX=0] the horizontal coordinate at which the event occurred, relative to the left edge of the entire document
+     * @param {number} [pageY=0] the vertical coordinate at which the event occurred, relative to the left edge of the entire document
+     * @param {number} [clientX=0] the horizontal coordinate within the application's client area at which the event occurred
+     * @param {number} [clientY=0] the vertical coordinate within the application's client area at which the event occurred
+     * @param {number} [pointerId=1] the Pointer, Touch or Mouse event Id (1)
      */
     setEvent(event, pageX = 0, pageY = 0, clientX = 0, clientY = 0, pointerId = 1) {
         // the original event object
@@ -320,8 +329,6 @@ class Pointer extends Bounds {
 
         this.type = event.type;
 
-
-
         // get the current screen to game world offset
         if (typeof viewport !== "undefined") {
             viewport.localToWorld(this.gameScreenX, this.gameScreenY, tmpVec);

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]:
@@ -410,15 +402,15 @@ function dispatchEvent(normalizedEvents) {
  * @ignore
  */
 function normalizeEvent(originalEvent) {
-    var pointer;
+    var _pointer;
 
     // PointerEvent or standard Mouse event
     if (device.TouchEvent && originalEvent.changedTouches) {
         // iOS/Android Touch event
         for (var i = 0, l = originalEvent.changedTouches.length; i < l; i++) {
             var touchEvent = originalEvent.changedTouches[i];
-            pointer = T_POINTERS.pop();
-            pointer.setEvent(
+            _pointer = T_POINTERS.pop();
+            _pointer.setEvent(
                 originalEvent,
                 touchEvent.pageX,
                 touchEvent.pageY,
@@ -426,12 +418,12 @@ function normalizeEvent(originalEvent) {
                 touchEvent.clientY,
                 touchEvent.identifier
             );
-            normalizedEvents.push(pointer);
+            normalizedEvents.push(_pointer);
         }
     } else {
         // Mouse or PointerEvent
-        pointer = T_POINTERS.pop();
-        pointer.setEvent(
+        _pointer = T_POINTERS.pop();
+        _pointer.setEvent(
             originalEvent,
             originalEvent.pageX,
             originalEvent.pageY,
@@ -439,7 +431,7 @@ function normalizeEvent(originalEvent) {
             originalEvent.clientY,
             originalEvent.pointerId
         );
-        normalizedEvents.push(pointer);
+        normalizedEvents.push(_pointer);
     }
 
     // if event.isPrimary is defined and false, return
@@ -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
          */