melonjs 10.2.3 → 10.3.0

package/src/state/state.js

@@ -150,7 +150,7 @@ event.on(event.BOOT, () => {
 /**
  * a State Manager (state machine)
  * @namespace state
- * @memberOf me
+ * @memberof me
  */
 
 var state = {
@@ -159,7 +159,7 @@ var state = {
      * default state ID for Loading Stage
      * @constant
      * @name LOADING
-     * @memberOf me.state
+     * @memberof me.state
      */
     LOADING : 0,
 
@@ -167,7 +167,7 @@ var state = {
      * default state ID for Menu Stage
      * @constant
      * @name MENU
-     * @memberOf me.state
+     * @memberof me.state
      */
     MENU : 1,
 
@@ -175,7 +175,7 @@ var state = {
      * default state ID for "Ready" Stage
      * @constant
      * @name READY
-     * @memberOf me.state
+     * @memberof me.state
      */
     READY : 2,
 
@@ -183,7 +183,7 @@ var state = {
      * default state ID for Play Stage
      * @constant
      * @name PLAY
-     * @memberOf me.state
+     * @memberof me.state
      */
     PLAY : 3,
 
@@ -191,7 +191,7 @@ var state = {
      * default state ID for Game Over Stage
      * @constant
      * @name GAMEOVER
-     * @memberOf me.state
+     * @memberof me.state
      */
     GAMEOVER : 4,
 
@@ -199,7 +199,7 @@ var state = {
      * default state ID for Game End Stage
      * @constant
      * @name GAME_END
-     * @memberOf me.state
+     * @memberof me.state
      */
     GAME_END : 5,
 
@@ -207,7 +207,7 @@ var state = {
      * default state ID for High Score Stage
      * @constant
      * @name SCORE
-     * @memberOf me.state
+     * @memberof me.state
      */
     SCORE : 6,
 
@@ -215,7 +215,7 @@ var state = {
      * default state ID for Credits Stage
      * @constant
      * @name CREDITS
-     * @memberOf me.state
+     * @memberof me.state
      */
     CREDITS : 7,
 
@@ -223,7 +223,7 @@ var state = {
      * default state ID for Settings Stage
      * @constant
      * @name SETTINGS
-     * @memberOf me.state
+     * @memberof me.state
      */
     SETTINGS : 8,
 
@@ -232,7 +232,7 @@ var state = {
      * (the default stage is the one running as soon as melonJS is started)
      * @constant
      * @name SETTINGS
-     * @memberOf me.state
+     * @memberof me.state
      */
     DEFAULT : 9,
 
@@ -240,7 +240,7 @@ var state = {
      * default state ID for user defined constants<br>
      * @constant
      * @name USER
-     * @memberOf me.state
+     * @memberof me.state
      * @example
      * var STATE_INFO = me.state.USER + 0;
      * var STATE_WARN = me.state.USER + 1;
@@ -252,7 +252,7 @@ var state = {
     /**
      * Stop the current screen object.
      * @name stop
-     * @memberOf me.state
+     * @memberof me.state
      * @public
      * @function
      * @param {boolean} [pauseTrack=false] pause current track on screen stop.
@@ -279,7 +279,7 @@ var state = {
     /**
      * pause the current screen object
      * @name pause
-     * @memberOf me.state
+     * @memberof me.state
      * @public
      * @function
      * @param {boolean} [music=false] pause current music track on screen pause
@@ -305,7 +305,7 @@ var state = {
     /**
      * Restart the screen object from a full stop.
      * @name restart
-     * @memberOf me.state
+     * @memberof me.state
      * @public
      * @function
      * @param {boolean} [music=false] resume current music track on screen resume
@@ -333,7 +333,7 @@ var state = {
     /**
      * resume the screen object
      * @name resume
-     * @memberOf me.state
+     * @memberof me.state
      * @public
      * @function
      * @param {boolean} [music=false] resume current music track on screen resume
@@ -358,7 +358,7 @@ var state = {
     /**
      * return the running state of the state manager
      * @name isRunning
-     * @memberOf me.state
+     * @memberof me.state
      * @public
      * @function
      * @returns {boolean} true if a "process is running"
@@ -370,7 +370,7 @@ var state = {
     /**
      * Return the pause state of the state manager
      * @name isPaused
-     * @memberOf me.state
+     * @memberof me.state
      * @public
      * @function
      * @returns {boolean} true if the game is paused
@@ -382,7 +382,7 @@ var state = {
     /**
      * associate the specified state with a Stage
      * @name set
-     * @memberOf me.state
+     * @memberof me.state
      * @public
      * @function
      * @param {number} state State ID (see constants)
@@ -442,7 +442,7 @@ var state = {
      * return a reference to the current screen object<br>
      * useful to call a object specific method
      * @name current
-     * @memberOf me.state
+     * @memberof me.state
      * @public
      * @function
      * @returns {me.Stage}
@@ -456,7 +456,7 @@ var state = {
     /**
      * specify a global transition effect
      * @name transition
-     * @memberOf me.state
+     * @memberof me.state
      * @public
      * @function
      * @param {string} effect (only "fade" is supported for now)
@@ -473,7 +473,7 @@ var state = {
     /**
      * enable/disable transition for a specific state (by default enabled for all)
      * @name setTransition
-     * @memberOf me.state
+     * @memberof me.state
      * @public
      * @function
      * @param {number} state State ID (see constants)
@@ -486,7 +486,7 @@ var state = {
     /**
      * change the game/app state
      * @name change
-     * @memberOf me.state
+     * @memberof me.state
      * @public
      * @function
      * @param {number} state State ID (see constants)
@@ -541,7 +541,7 @@ var state = {
     /**
      * return true if the specified state is the current one
      * @name isCurrent
-     * @memberOf me.state
+     * @memberof me.state
      * @public
      * @function
      * @param {number} state State ID (see constants)

package/src/system/device.js

@@ -8,7 +8,7 @@ import * as event from "./../system/event.js";
 /**
  * The device capabilities and specific events
  * @namespace me.device
- * @memberOf me
+ * @memberof me
  */
 
 // private properties
@@ -131,12 +131,8 @@ function _checkCapabilities() {
     // Modern browsers support "wheel", Webkit and IE support at least "mousewheel
     device.wheel = ("onwheel" in document.createElement("div"));
 
-    // pointerlock detection
-    device.hasPointerLockSupport = prefixed("pointerLockElement", document);
-
-    if (device.hasPointerLockSupport) {
-        document.exitPointerLock = prefixed("exitPointerLock", document);
-    }
+    // pointerlock detection (pointerLockElement can be null when the feature is supported)
+    device.hasPointerLockSupport = typeof document.pointerLockElement !== "undefined";
 
     // device orientation and motion detection
     device.hasDeviceOrientation = !!window.DeviceOrientationEvent;
@@ -257,7 +253,7 @@ let device = {
      * @type {string}
      * @readonly
      * @name ua
-     * @memberOf me.device
+     * @memberof me.device
      */
     ua : navigator.userAgent,
 
@@ -267,7 +263,7 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name localStorage
-     * @memberOf me.device
+     * @memberof me.device
      */
     localStorage : false,
 
@@ -276,7 +272,7 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name hasAccelerometer
-     * @memberOf me.device
+     * @memberof me.device
      */
     hasAccelerometer : false,
 
@@ -285,7 +281,7 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name hasDeviceOrientation
-     * @memberOf me.device
+     * @memberof me.device
      */
     hasDeviceOrientation : false,
 
@@ -295,7 +291,7 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name ScreenOrientation
-     * @memberOf me.device
+     * @memberof me.device
      */
     ScreenOrientation : false,
 
@@ -304,7 +300,7 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name hasFullscreenSupport
-     * @memberOf me.device
+     * @memberof me.device
      */
     hasFullscreenSupport : false,
 
@@ -313,7 +309,7 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name hasPointerLockSupport
-     * @memberOf me.device
+     * @memberof me.device
      */
     hasPointerLockSupport : false,
 
@@ -322,7 +318,7 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name hasWebAudio
-     * @memberOf me.device
+     * @memberof me.device
      */
     hasWebAudio : false,
 
@@ -331,7 +327,7 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name nativeBase64
-     * @memberOf me.device
+     * @memberof me.device
      */
     nativeBase64 : (typeof(window.atob) === "function"),
 
@@ -340,7 +336,7 @@ let device = {
      * @type {number}
      * @readonly
      * @name maxTouchPoints
-     * @memberOf me.device
+     * @memberof me.device
      * @example
      * if (me.device.maxTouchPoints > 1) {
      *     // device supports multi-touch
@@ -353,7 +349,7 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name touch
-     * @memberOf me.device
+     * @memberof me.device
      */
     touch : false,
 
@@ -362,7 +358,7 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name wheel
-     * @memberOf me.device
+     * @memberof me.device
      */
     wheel : false,
 
@@ -372,7 +368,7 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name isMobile
-     * @memberOf me.device
+     * @memberof me.device
      */
     isMobile : false,
 
@@ -381,7 +377,7 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name iOS
-     * @memberOf me.device
+     * @memberof me.device
      */
     iOS : false,
 
@@ -390,7 +386,7 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name android
-     * @memberOf me.device
+     * @memberof me.device
      */
     android : false,
 
@@ -399,7 +395,7 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name android2
-     * @memberOf me.device
+     * @memberof me.device
      */
     android2 : false,
 
@@ -408,7 +404,7 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name linux
-     * @memberOf me.device
+     * @memberof me.device
      */
     linux : false,
 
@@ -418,7 +414,7 @@ let device = {
     * @readonly
     * @see http://impactjs.com/ejecta
     * @name ejecta
-    * @memberOf me.device
+    * @memberof me.device
     */
     ejecta : false,
 
@@ -427,7 +423,7 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name isWeixin
-     * @memberOf me.device
+     * @memberof me.device
      */
      isWeixin : false,
 
@@ -436,7 +432,7 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name chromeOS
-     * @memberOf me.device
+     * @memberof me.device
      */
     chromeOS : false,
 
@@ -445,7 +441,7 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name wp
-     * @memberOf me.device
+     * @memberof me.device
      */
     wp : false,
 
@@ -454,7 +450,7 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name BlackBerry
-     * @memberOf me.device
+     * @memberof me.device
      */
     BlackBerry : false,
 
@@ -463,7 +459,7 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name Kindle
-     * @memberOf me.device
+     * @memberof me.device
      */
     Kindle : false,
 
@@ -474,7 +470,7 @@ let device = {
      * @readonly
      * @name accelerationX
      * @see me.device.watchAccelerometer
-     * @memberOf me.device
+     * @memberof me.device
      */
     accelerationX : 0,
 
@@ -485,7 +481,7 @@ let device = {
      * @readonly
      * @name accelerationY
      * @see me.device.watchAccelerometer
-     * @memberOf me.device
+     * @memberof me.device
      */
     accelerationY : 0,
 
@@ -496,7 +492,7 @@ let device = {
      * @readonly
      * @name accelerationZ
      * @see me.device.watchAccelerometer
-     * @memberOf me.device
+     * @memberof me.device
      */
     accelerationZ : 0,
 
@@ -507,7 +503,7 @@ let device = {
      * @readonly
      * @name gamma
      * @see me.device.watchDeviceOrientation
-     * @memberOf me.device
+     * @memberof me.device
      */
     gamma : 0,
 
@@ -518,7 +514,7 @@ let device = {
      * @readonly
      * @name beta
      * @see me.device.watchDeviceOrientation
-     * @memberOf me.device
+     * @memberof me.device
      */
     beta: 0,
 
@@ -530,7 +526,7 @@ let device = {
      * @readonly
      * @name alpha
      * @see me.device.watchDeviceOrientation
-     * @memberOf me.device
+     * @memberof me.device
      */
     alpha : 0,
 
@@ -542,7 +538,7 @@ let device = {
      * @readonly
      * @see http://www.w3schools.com/tags/ref_language_codes.asp
      * @name language
-     * @memberOf me.device
+     * @memberof me.device
      */
     language : navigator.language || navigator.browserLanguage || navigator.userLanguage || "en",
 
@@ -550,7 +546,7 @@ let device = {
      * Specify whether to pause the game when losing focus
      * @type {boolean}
      * @default true
-     * @memberOf me.device
+     * @memberof me.device
      */
     pauseOnBlur : true,
 
@@ -558,7 +554,7 @@ let device = {
      * Specify whether to unpause the game when gaining focus
      * @type {boolean}
      * @default true
-     * @memberOf me.device
+     * @memberof me.device
      */
     resumeOnFocus : true,
 
@@ -566,7 +562,7 @@ let device = {
      * Specify whether to automatically bring the window to the front
      * @type {boolean}
      * @default true
-     * @memberOf me.device
+     * @memberof me.device
      */
     autoFocus : true,
 
@@ -575,7 +571,7 @@ let device = {
      * The engine restarts on focus if this is enabled.
      * @type {boolean}
      * @default false
-     * @memberOf me.device
+     * @memberof me.device
      */
     stopOnBlur : false,
 
@@ -584,7 +580,7 @@ let device = {
      * @type {boolean}
      * @readonly
      * @name OffScreenCanvas
-     * @memberOf me.device
+     * @memberof me.device
      */
     OffscreenCanvas : false,
 
@@ -974,58 +970,6 @@ let device = {
         this.alpha = e.alpha;
     },
 
-    /**
-     * Enters pointer lock, requesting it from the user first. Works on supported devices & browsers
-     * Must be called in a click event or an event that requires user interaction.
-     * If you need to run handle events for errors or change of the pointer lock, see below.
-     * @function me.device.turnOnPointerLock
-     * @example
-     * document.addEventListener("pointerlockchange", pointerlockchange, false);
-     * document.addEventListener("mozpointerlockchange", pointerlockchange, false);
-     * document.addEventListener("webkitpointerlockchange", pointerlockchange, false);
-     *
-     * document.addEventListener("pointerlockerror", pointerlockerror, false);
-     * document.addEventListener("mozpointerlockerror", pointerlockerror, false);
-     * document.addEventListener("webkitpointerlockerror", pointerlockerror, false);
-     */
-    turnOnPointerLock() {
-        if (this.hasPointerLockSupport) {
-            var element = getParent();
-            if (this.ua.match(/Firefox/i)) {
-                var fullscreenchange = function() {
-                    if ((prefixed("fullscreenElement", document) ||
-                        document.mozFullScreenElement) === element) {
-
-                        document.removeEventListener("fullscreenchange", fullscreenchange);
-                        document.removeEventListener("mozfullscreenchange", fullscreenchange);
-                        element.requestPointerLock = prefixed("requestPointerLock", element);
-                        element.requestPointerLock();
-                    }
-                };
-
-                document.addEventListener("fullscreenchange", fullscreenchange, false);
-                document.addEventListener("mozfullscreenchange", fullscreenchange, false);
-
-                this.requestFullscreen();
-
-            }
-            else {
-                element.requestPointerLock();
-            }
-        }
-    },
-
-    /**
-     * Exits pointer lock. Works on supported devices & browsers
-     * @function me.device.turnOffPointerLock
-     * @function
-     */
-    turnOffPointerLock() {
-        if (this.hasPointerLockSupport) {
-            document.exitPointerLock();
-        }
-    },
-
     /**
      * Enable monitor of the device accelerator to detect the amount of physical force of acceleration the device is receiving.
      * (one some device a first user gesture will be required before calling this function)
@@ -1153,7 +1097,7 @@ let device = {
 /**
  * Ratio of the resolution in physical pixels to the resolution in CSS pixels for the current display device.
  * @name devicePixelRatio
- * @memberOf me.device
+ * @memberof me.device
  * @public
  * @type {number}
  * @readonly
@@ -1171,7 +1115,7 @@ Object.defineProperty(device, "devicePixelRatio", {
 /**
  * Returns true if the browser/device is in full screen mode.
  * @name isFullscreen
- * @memberOf me.device
+ * @memberof me.device
  * @public
  * @type {boolean}
  * @readonly
@@ -1194,7 +1138,7 @@ Object.defineProperty(device, "isFullscreen", {
 /**
  * Returns true if the browser/device has audio capabilities.
  * @name sound
- * @memberOf me.device
+ * @memberof me.device
  * @public
  * @type {boolean}
  * @readonly