melonjs 10.2.3 → 10.3.0

package/src/input/pointer.js

@@ -3,6 +3,7 @@ import device from "./../system/device.js";
 import Bounds from "./../physics/bounds.js";
 import { viewport } from "./../game.js";
 import { globalToLocal } from "./input.js";
+import { locked } from "./pointerevent.js";
 
 
 /**
@@ -15,9 +16,8 @@ var tmpVec = new Vector2d();
  * @classdesc
  * a pointer object, representing a single finger on a touch enabled device.
  * @class Pointer
- * @extends me.Bounds
- * @memberOf me
- * @constructor
+ * @augments me.Bounds
+ * @memberof me
  */
 class Pointer extends Bounds {
 
@@ -37,7 +37,7 @@ class Pointer extends Bounds {
          * @public
          * @type {number}
          * @name LEFT
-         * @memberOf me.Pointer
+         * @memberof me.Pointer
          */
         this.LEFT = 0;
 
@@ -46,7 +46,7 @@ class Pointer extends Bounds {
          * @public
          * @type {number}
          * @name MIDDLE
-         * @memberOf me.Pointer
+         * @memberof me.Pointer
          */
         this.MIDDLE = 1;
 
@@ -55,7 +55,7 @@ class Pointer extends Bounds {
          * @public
          * @type {number}
          * @name RIGHT
-         * @memberOf me.Pointer
+         * @memberof me.Pointer
          */
         this.RIGHT = 2;
 
@@ -67,7 +67,7 @@ class Pointer extends Bounds {
          * @see https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent
          * @see https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent
          * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent
-         * @memberOf me.Pointer
+         * @memberof me.Pointer
          */
         this.event = undefined;
 
@@ -77,7 +77,7 @@ class Pointer extends Bounds {
          * @type {string}
          * @name type
          * @see https://developer.mozilla.org/en-US/docs/Web/API/Event/type
-         * @memberOf me.Pointer
+         * @memberof me.Pointer
          */
         this.type = undefined;
 
@@ -88,7 +88,7 @@ class Pointer extends Bounds {
          * @type {number}
          * @name button
          * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/button
-         * @memberOf me.Pointer
+         * @memberof me.Pointer
          */
         this.button = 0;
 
@@ -98,7 +98,7 @@ class Pointer extends Bounds {
          * @type {boolean}
          * @name isPrimary
          * @see https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/isPrimary
-         * @memberOf me.Pointer
+         * @memberof me.Pointer
          */
         this.isPrimary = false;
 
@@ -108,7 +108,7 @@ class Pointer extends Bounds {
          * @type {number}
          * @name pageX
          * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/pageX
-         * @memberOf me.Pointer
+         * @memberof me.Pointer
          */
         this.pageX = 0;
 
@@ -118,7 +118,7 @@ class Pointer extends Bounds {
          * @type {number}
          * @name pageY
          * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/pageY
-         * @memberOf me.Pointer
+         * @memberof me.Pointer
          */
         this.pageY = 0;
 
@@ -128,7 +128,7 @@ class Pointer extends Bounds {
          * @type {number}
          * @name clientX
          * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/clientX
-         * @memberOf me.Pointer
+         * @memberof me.Pointer
          */
         this.clientX = 0;
 
@@ -138,17 +138,37 @@ class Pointer extends Bounds {
         * @type {number}
         * @name clientY
         * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/clientY
-        * @memberOf me.Pointer
+        * @memberof me.Pointer
         */
         this.clientY = 0;
 
+        /**
+         * the difference in the X coordinate of the pointer since the previous move event
+         * @public
+         * @type {number}
+         * @name movementX
+         * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/movementX
+         * @memberof me.Pointer
+         */
+        this.movementX = 0;
+
+       /**
+        * the difference in the Y coordinate of the pointer since the previous move event
+        * @public
+        * @type {number}
+        * @name movementY
+        * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/movementY
+        * @memberof me.Pointer
+        */
+        this.movementY = 0;
+
         /**
          * an unsigned long representing the unit of the delta values scroll amount
          * @public
          * @type {number}
          * @name deltaMode
          * @see https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaMode
-         * @memberOf me.Pointer
+         * @memberof me.Pointer
          */
         this.deltaMode = 0;
 
@@ -158,7 +178,7 @@ class Pointer extends Bounds {
          * @type {number}
          * @name deltaX
          * @see https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaX
-         * @memberOf me.Pointer
+         * @memberof me.Pointer
          */
         this.deltaX = 0;
 
@@ -168,7 +188,7 @@ class Pointer extends Bounds {
          * @type {number}
          * @name deltaY
          * @see https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaY
-         * @memberOf me.Pointer
+         * @memberof me.Pointer
          */
         this.deltaY = 0;
 
@@ -178,7 +198,7 @@ class Pointer extends Bounds {
          * @type {number}
          * @name deltaZ
          * @see https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaZ
-         * @memberOf me.Pointer
+         * @memberof me.Pointer
          */
         this.deltaZ = 0;
 
@@ -188,7 +208,7 @@ class Pointer extends Bounds {
          * @public
          * @type {number}
          * @name gameX
-         * @memberOf me.Pointer
+         * @memberof me.Pointer
          */
         this.gameX = 0;
 
@@ -198,7 +218,7 @@ class Pointer extends Bounds {
          * @public
          * @type {number}
          * @name gameY
-         * @memberOf me.Pointer
+         * @memberof me.Pointer
          */
         this.gameY = 0;
 
@@ -207,7 +227,7 @@ class Pointer extends Bounds {
          * @public
          * @type {number}
          * @name gameScreenX
-         * @memberOf me.Pointer
+         * @memberof me.Pointer
          */
         this.gameScreenX = 0;
 
@@ -216,7 +236,7 @@ class Pointer extends Bounds {
          * @public
          * @type {number}
          * @name gameScreenY
-         * @memberOf me.Pointer
+         * @memberof me.Pointer
          */
         this.gameScreenY = 0;
 
@@ -225,7 +245,7 @@ class Pointer extends Bounds {
          * @public
          * @type {number}
          * @name gameWorldX
-         * @memberOf me.Pointer
+         * @memberof me.Pointer
          */
         this.gameWorldX = 0;
 
@@ -234,7 +254,7 @@ class Pointer extends Bounds {
          * @public
          * @type {number}
          * @name gameWorldY
-         * @memberOf me.Pointer
+         * @memberof me.Pointer
          */
         this.gameWorldY = 0;
 
@@ -243,7 +263,7 @@ class Pointer extends Bounds {
          * @public
          * @type {number}
          * @name gameLocalX
-         * @memberOf me.Pointer
+         * @memberof me.Pointer
          */
         this.gameLocalX = 0;
 
@@ -252,7 +272,7 @@ class Pointer extends Bounds {
          * @public
          * @type {number}
          * @name gameLocalY
-         * @memberOf me.Pointer
+         * @memberof me.Pointer
          */
         this.gameLocalY = 0;
 
@@ -261,7 +281,7 @@ class Pointer extends Bounds {
         * @public
         * @type {number}
         * @name pointerId
-        * @memberOf me.Pointer
+        * @memberof me.Pointer
         * @see https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/pointerId
         */
         this.pointerId = undefined;
@@ -271,10 +291,19 @@ class Pointer extends Bounds {
          * @public
          * @type {boolean}
          * @name isNormalized
-         * @memberOf me.Pointer
+         * @memberof me.Pointer
          */
         this.isNormalized = false;
 
+        /**
+         * true if the pointer is currently locked
+         * @public
+         * @type {boolean}
+         * @name locked
+         * @memberof me.Pointer
+         */
+        this.locked = false;
+
         // bind list for mouse buttons
         this.bind = [ 0, 0, 0 ];
     }
@@ -308,6 +337,10 @@ class Pointer extends Bounds {
         // true if not originally a pointer event
         this.isNormalized = !device.PointerEvent || (device.PointerEvent && !(event instanceof window.PointerEvent));
 
+        this.locked = locked;
+        this.movementX = event.movementX || 0;
+        this.movementY = event.movementY || 0;
+
         if (event.type === "wheel") {
             this.deltaMode = event.deltaMode || 0;
             this.deltaX = event.deltaX || 0;

package/src/input/pointerevent.js

@@ -1,14 +1,14 @@
 import {preventDefault} from "./input.js";
 import {getBindingKey, triggerKeyEvent} from "./keyboard.js";
-import { renderer, scaleRatio } from "./../video/video.js";
-import * as fctUtil from "./../utils/function.js";
-import * as arrayUtil from "./../utils/array.js";
+import { renderer, scaleRatio, getParent } from "./../video/video.js";
+import { throttle } from "./../utils/function.js";
+import { remove } from "./../utils/array.js";
 import * as event from "./../system/event.js";
 import timer from "./../system/timer.js";
 import pool from "./../system/pooling.js";
 import device from "./../system/device.js";
 import Pointer from "./pointer.js";
-import Rect from "./../shapes/rectangle.js";
+import Rect from "./../geometries/rectangle.js";
 import Container from "./../renderable/container.js";
 import { world, viewport } from "./../game.js";
 
@@ -178,7 +178,7 @@ function enablePointerEvent() {
                 if (activeEventList.indexOf(events[i]) !== -1) {
                     pointerEventTarget.addEventListener(
                         events[i],
-                        fctUtil.throttle(
+                        throttle(
                             onMoveEvent,
                             throttlingInterval,
                             false
@@ -191,6 +191,17 @@ function enablePointerEvent() {
         // disable all gesture by default
         setTouchAction(pointerEventTarget);
 
+        // set a on change listener on pointerlock if supported
+        if (device.hasPointerLockSupport) {
+            document.addEventListener("pointerlockchange", () => {
+                // change the locked status accordingly
+                locked = document.pointerLockElement === getParent();
+                // emit the corresponding internal event
+                event.emit(event.POINTERLOCKCHANGE, locked);
+            }, true);
+        }
+
+        // all done !
         pointerInitialized = true;
     }
 }
@@ -492,7 +503,7 @@ function onPointerEvent(e) {
   * @public
   * @type {EventTarget}
   * @name pointerEventTarget
-  * @memberOf me.input
+  * @memberof me.input
   */
  export var pointerEventTarget = null;
 
@@ -501,10 +512,20 @@ function onPointerEvent(e) {
  * @public
  * @type {me.Rect}
  * @name pointer
- * @memberOf me.input
+ * @memberof me.input
  */
 export var pointer = new Pointer(0, 0, 1, 1);
 
+
+/**
+ * indicates if the pointer is currently locked
+ * @public
+ * @type {boolean}
+ * @name locked
+ * @memberof me.input
+ */
+export var locked = false;
+
 /**
  * time interval for event throttling in milliseconds<br>
  * default value : "1000/me.timer.maxfps" ms<br>
@@ -512,7 +533,7 @@ export var pointer = new Pointer(0, 0, 1, 1);
  * @public
  * @type {number}
  * @name throttlingInterval
- * @memberOf me.input
+ * @memberof me.input
  */
 export var throttlingInterval;
 
@@ -520,7 +541,7 @@ export var throttlingInterval;
  * Translate the specified x and y values from the global (absolute)
  * coordinate to local (viewport) relative coordinate.
  * @name globalToLocal
- * @memberOf me.input
+ * @memberof me.input
  * @public
  * @function
  * @param {number} x the global x coordinate to be translated.
@@ -552,7 +573,7 @@ export function globalToLocal(x, y, v) {
  * enable/disable all gestures on the given element.<br>
  * by default melonJS will disable browser handling of all panning and zooming gestures.
  * @name setTouchAction
- * @memberOf me.input
+ * @memberof me.input
  * @see https://developer.mozilla.org/en-US/docs/Web/CSS/touch-action
  * @public
  * @function
@@ -569,7 +590,7 @@ export function setTouchAction(element, value) {
  * Middle button – 1
  * Right button – 2
  * @name bindPointer
- * @memberOf me.input
+ * @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)
@@ -600,7 +621,7 @@ export function bindPointer() {
 /**
  * unbind the defined keycode
  * @name unbindPointer
- * @memberOf me.input
+ * @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)
@@ -622,7 +643,7 @@ export function unbindPointer(button) {
  * @see me.Pointer
  * @see {@link http://www.w3.org/TR/pointerevents/#list-of-pointer-events|W3C Pointer Event list}
  * @name registerPointerEvent
- * @memberOf me.input
+ * @memberof me.input
  * @public
  * @function
  * @param {string} eventType The event type for which the object is registering <br>
@@ -694,7 +715,7 @@ export function registerPointerEvent(eventType, region, callback) {
  * allows the removal of event listeners from the object target.
  * @see {@link http://www.w3.org/TR/pointerevents/#list-of-pointer-events|W3C Pointer Event list}
  * @name releasePointerEvent
- * @memberOf me.input
+ * @memberof me.input
  * @public
  * @function
  * @param {string} eventType The event type for which the object was registered. See {@link me.input.registerPointerEvent}
@@ -718,7 +739,7 @@ export function releasePointerEvent(eventType, region, callback) {
             eventType = eventTypes[i];
             if (handlers.callbacks[eventType]) {
                 if (typeof (callback) !== "undefined") {
-                    arrayUtil.remove(handlers.callbacks[eventType], callback);
+                    remove(handlers.callbacks[eventType], callback);
                 } else {
                     while (handlers.callbacks[eventType].length > 0) {
                         handlers.callbacks[eventType].pop();
@@ -739,7 +760,7 @@ export function releasePointerEvent(eventType, region, callback) {
 /**
  * allows the removal of all registered event listeners from the object target.
  * @name releaseAllPointerEvents
- * @memberOf me.input
+ * @memberof me.input
  * @public
  * @function
  * @param {me.Rect|me.Polygon|me.Line|me.Ellipse} region the registered region to release event from
@@ -754,3 +775,45 @@ export function releaseAllPointerEvents(region) {
         }
     };
 };
+
+/**
+ * request for the pointer to be locked on the parent DOM element.
+ * (Must be called in a click event or an event that requires user interaction)
+ * @name requestPointerLock
+ * @memberof me.input
+ * @public
+ * @function
+ * @param {Function} [success] callback if the request is successful
+ * @returns {boolean} return true if the request was successfully submitted
+ * @example
+ * // register on the pointer lock change event
+ * event.on(event.POINTERLOCKCHANGE, (locked)=> {
+ *     console.log("pointer lock: " + locked);
+ * });
+ * // request for pointer lock
+ * me.input.requestPointerLock();
+ */
+export function requestPointerLock() {
+    if (device.hasPointerLockSupport) {
+        var element = getParent();
+        element.requestPointerLock();
+        return true;
+    }
+    return false;
+}
+
+/**
+ * Initiates an exit from pointer lock state
+ * @name exitPointerLock
+ * @memberof me.input
+ * @public
+ * @function
+ * @returns {boolean} return true if the request was successfully submitted
+ */
+export function exitPointerLock() {
+    if (device.hasPointerLockSupport) {
+        document.exitPointerLock();
+        return true;
+    }
+    return false;
+}

package/src/lang/deprecated.js

@@ -1,15 +1,13 @@
+import device from "./../system/device.js";
+import { requestPointerLock, exitPointerLock } from "./../input/input.js";
+
 /**
  * placeholder for all deprecated classes and corresponding alias for backward compatibility
- * @namespace deprecated
- * @memberOf me
  */
 
 /**
  * display a deprecation warning in the console
- * @public
- * @function
- * @memberOf me.deprecated
- * @name warning
+ * @ignore
  * @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
@@ -42,17 +40,30 @@ export function warning(deprecated, replacement, version) {
     if (console.groupCollapsed) {
         console.groupEnd();
     }
-
-
 };
 
+/**
+ * @public
+ * @type {Function}
+ * @name turnOnPointerLock
+ * @memberof me.device
+ * @deprecated since 10.3.0
+ * @see me.input.requestPointerLock
+ */
+device.turnOnPointerLock = function () {
+    warning("me.device.turnOnPointerLock()", "me.input.requestPointerLock()", "10.3.0");
+    return requestPointerLock();
+};
 
 /**
- * Backward compatibility for deprecated method or properties are automatically
- * applied when automatically generating an UMD bundle (which is the default since version 9.0).
- * @memberof me.deprecated
- * @function apply
+ * @public
+ * @type {Function}
+ * @name turnOffPointerLock
+ * @memberof me.device
+ * @deprecated since 10.3.0
+ * @see me.input.exitPointerLock
  */
- export function apply() {
-     ;
- };
+device.turnOffPointerLock = function () {
+    warning("me.device.turnOffPointerLock()", "me.input.exitPointerLock()", "10.3.0");
+    return exitPointerLock();
+};

package/src/level/level.js

@@ -49,7 +49,7 @@ function safeLoadLevel(levelId, options, restart) {
 /**
  * Load a TMX level
  * @name loadTMXLevel
- * @memberOf me.level
+ * @memberof me.level
  * @private
  * @param {string} levelId level id
  * @param {me.Container} container target container
@@ -76,7 +76,7 @@ function loadTMXLevel(levelId, container, flatten, setViewportBounds) {
 /**
  * a level manager. once ressources loaded, the level manager contains all references of defined levels.
  * @namespace level
- * @memberOf me
+ * @memberof me
  */
 
 var level = {
@@ -84,7 +84,7 @@ var level = {
     /**
      * add a level into the game manager (usually called by the preloader)
      * @name add
-     * @memberOf me.level
+     * @memberof me.level
      * @public
      * @function
      * @param {string} format level format (only "tmx" supported)
@@ -123,7 +123,7 @@ var level = {
      * load a level into the game manager<br>
      * (will also create all level defined entities, etc..)
      * @name load
-     * @memberOf me.level
+     * @memberof me.level
      * @public
      * @function
      * @param {string} levelId level id
@@ -197,7 +197,7 @@ var level = {
     /**
      * return the current level id<br>
      * @name getCurrentLevelId
-     * @memberOf me.level
+     * @memberof me.level
      * @public
      * @function
      * @returns {string}
@@ -211,7 +211,7 @@ var level = {
      * for a reference to the live instantiated level,
      * rather use the container in which it was loaded (e.g. me.game.world)
      * @name getCurrentLevel
-     * @memberOf me.level
+     * @memberof me.level
      * @public
      * @function
      * @returns {me.TMXTileMap}
@@ -223,7 +223,7 @@ var level = {
     /**
      * reload the current level
      * @name reload
-     * @memberOf me.level
+     * @memberof me.level
      * @public
      * @function
      * @param {object} [options] additional optional parameters
@@ -241,7 +241,7 @@ var level = {
     /**
      * load the next level
      * @name next
-     * @memberOf me.level
+     * @memberof me.level
      * @public
      * @function
      * @param {object} [options] additional optional parameters
@@ -263,7 +263,7 @@ var level = {
     /**
      * load the previous level<br>
      * @name previous
-     * @memberOf me.level
+     * @memberof me.level
      * @public
      * @function
      * @param {object} [options] additional optional parameters
@@ -285,7 +285,7 @@ var level = {
     /**
      * return the amount of level preloaded
      * @name levelCount
-     * @memberOf me.level
+     * @memberof me.level
      * @public
      * @function
      * @returns {number} the amount of level preloaded

package/src/level/tiled/TMXGroup.js

@@ -8,7 +8,6 @@ import { clamp } from "./../../math/math.js";
  * object group definition as defined in Tiled.
  * (group definition is translated into the virtual `me.game.world` using `me.Container`)
  * @class TMXGroup
- * @constructor
  * @ignore
  */
 export default class TMXGroup {
@@ -20,7 +19,7 @@ export default class TMXGroup {
          * @public
          * @type {string}
          * @name name
-         * @memberOf me.TMXGroup
+         * @memberof me.TMXGroup
          */
         this.name = data.name;
 
@@ -29,7 +28,7 @@ export default class TMXGroup {
          * @public
          * @type {number}
          * @name width
-         * @memberOf me.TMXGroup
+         * @memberof me.TMXGroup
          */
         this.width = data.width || 0;
 
@@ -38,7 +37,7 @@ export default class TMXGroup {
          * @public
          * @type {number}
          * @name height
-         * @memberOf me.TMXGroup
+         * @memberof me.TMXGroup
          */
         this.height = data.height || 0;
 
@@ -47,7 +46,7 @@ export default class TMXGroup {
          * @public
          * @type {string}
          * @name tintcolor
-         * @memberOf me.TMXGroup
+         * @memberof me.TMXGroup
          */
         this.tintcolor = data.tintcolor;
 
@@ -56,7 +55,7 @@ export default class TMXGroup {
          * @public
          * @type {number}
          * @name z
-         * @memberOf me.TMXGroup
+         * @memberof me.TMXGroup
          */
         this.z = z;
 
@@ -66,7 +65,7 @@ export default class TMXGroup {
          * @public
          * @type {object[]}
          * @name name
-         * @memberOf me.TMXGroup
+         * @memberof me.TMXGroup
          */
         this.objects = [];