melonjs 10.2.0 → 10.3.0

package/src/state/state.js

@@ -74,7 +74,7 @@ function _pauseRunLoop() {
 
 /**
  * this is only called when using requestAnimFrame stuff
- * @param {Number} time current timestamp in milliseconds
+ * @param {number} time current timestamp in milliseconds
  * @ignore
  */
 function _renderFrame(time) {
@@ -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,18 +252,19 @@ var state = {
     /**
      * Stop the current screen object.
      * @name stop
-     * @memberOf me.state
+     * @memberof me.state
      * @public
      * @function
-     * @param {Boolean} pauseTrack pause current track on screen stop.
+     * @param {boolean} [pauseTrack=false] pause current track on screen stop.
      */
-    stop(music) {
+    stop(pauseTrack=false) {
         // only stop when we are not loading stuff
         if ((_state !== this.LOADING) && this.isRunning()) {
             // stop the main loop
             _stopRunLoop();
+
             // current music stop
-            if (music === true) {
+            if (pauseTrack === true) {
                 pauseTrack();
             }
 
@@ -278,12 +279,12 @@ var state = {
     /**
      * pause the current screen object
      * @name pause
-     * @memberOf me.state
+     * @memberof me.state
      * @public
      * @function
-     * @param {Boolean} pauseTrack pause current track on screen pause
+     * @param {boolean} [music=false] pause current music track on screen pause
      */
-    pause(music) {
+    pause(music=false) {
         // only pause when we are not loading stuff
         if ((_state !== this.LOADING) && !this.isPaused()) {
             // stop the main loop
@@ -304,12 +305,12 @@ var state = {
     /**
      * Restart the screen object from a full stop.
      * @name restart
-     * @memberOf me.state
+     * @memberof me.state
      * @public
      * @function
-     * @param {Boolean} resumeTrack resume current track on screen resume
+     * @param {boolean} [music=false] resume current music track on screen resume
      */
-    restart(music) {
+    restart(music=false) {
         if (!this.isRunning()) {
             // restart the main loop
             _startRunLoop();
@@ -332,12 +333,12 @@ var state = {
     /**
      * resume the screen object
      * @name resume
-     * @memberOf me.state
+     * @memberof me.state
      * @public
      * @function
-     * @param {Boolean} resumeTrack resume current track on screen resume
+     * @param {boolean} [music=false] resume current music track on screen resume
      */
-    resume(music) {
+    resume(music=false) {
         if (this.isPaused()) {
             // resume the main loop
             _resumeRunLoop();
@@ -357,10 +358,10 @@ var state = {
     /**
      * return the running state of the state manager
      * @name isRunning
-     * @memberOf me.state
+     * @memberof me.state
      * @public
      * @function
-     * @return {Boolean} true if a "process is running"
+     * @returns {boolean} true if a "process is running"
      */
     isRunning() {
         return _animFrameId !== -1;
@@ -369,10 +370,10 @@ var state = {
     /**
      * Return the pause state of the state manager
      * @name isPaused
-     * @memberOf me.state
+     * @memberof me.state
      * @public
      * @function
-     * @return {Boolean} true if the game is paused
+     * @returns {boolean} true if the game is paused
      */
     isPaused() {
         return _isPaused;
@@ -381,12 +382,12 @@ 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)
+     * @param {number} state State ID (see constants)
      * @param {me.Stage} stage Instantiated Stage to associate with state ID
-     * @param {Boolean} [start = false] if true the state will be changed immediately after adding it.
+     * @param {boolean} [start = false] if true the state will be changed immediately after adding it.
      * @example
      * class MenuButton extends me.GUI_Object {
      *     onClick() {
@@ -441,10 +442,10 @@ 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
-     * @return {me.Stage}
+     * @returns {me.Stage}
      */
     current() {
         if (typeof _stages[_state] !== "undefined") {
@@ -455,12 +456,12 @@ 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)
-     * @param {me.Color|String} color a CSS color value
-     * @param {Number} [duration=1000] expressed in milliseconds
+     * @param {string} effect (only "fade" is supported for now)
+     * @param {me.Color|string} color a CSS color value
+     * @param {number} [duration=1000] expressed in milliseconds
      */
     transition(effect, color, duration) {
         if (effect === "fade") {
@@ -472,11 +473,11 @@ 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)
-     * @param {Boolean} enable
+     * @param {number} state State ID (see constants)
+     * @param {boolean} enable
      */
     setTransition(state, enable) {
         _stages[state].transition = enable;
@@ -485,12 +486,12 @@ var state = {
     /**
      * change the game/app state
      * @name change
-     * @memberOf me.state
+     * @memberof me.state
      * @public
      * @function
-     * @param {Number} state State ID (see constants)
-     * @param {Boolean} forceChange if true the state will be changed immediately
-     * @param {} [arguments...] extra arguments to be passed to the reset functions
+     * @param {number} state State ID (see constants)
+     * @param {boolean} forceChange if true the state will be changed immediately
+     * @param {object} [...arguments] extra arguments to be passed to the reset functions
      * @example
      * // The onResetEvent method on the play screen will receive two args:
      * // "level_1" and the number 3
@@ -502,39 +503,37 @@ var state = {
             throw new Error("Undefined Stage for state '" + state + "'");
         }
 
-        if (this.isCurrent(state)) {
-            // do nothing if already the current state
-            return;
-        }
+        // do nothing if already the current state
+        if (!this.isCurrent(state)) {
+            _extraArgs = null;
+            if (arguments.length > 1) {
+                // store extra arguments if any
+                _extraArgs = Array.prototype.slice.call(arguments, 1);
+            }
+            // if fading effect
+            if (_fade.duration && _stages[state].transition) {
+                /** @ignore */
+                _onSwitchComplete = function() {
+                    game.viewport.fadeOut(_fade.color, _fade.duration);
+                };
+                game.viewport.fadeIn(
+                    _fade.color,
+                    _fade.duration,
+                    function () {
+                        fctUtil.defer(_switchState, this, state);
+                    }
+                );
 
-        _extraArgs = null;
-        if (arguments.length > 1) {
-            // store extra arguments if any
-            _extraArgs = Array.prototype.slice.call(arguments, 1);
-        }
-        // if fading effect
-        if (_fade.duration && _stages[state].transition) {
-            /** @ignore */
-            _onSwitchComplete = function() {
-                game.viewport.fadeOut(_fade.color, _fade.duration);
-            };
-            game.viewport.fadeIn(
-                _fade.color,
-                _fade.duration,
-                function () {
+            }
+            // else just switch without any effects
+            else {
+                // wait for the last frame to be
+                // "finished" before switching
+                if (forceChange === true) {
+                    _switchState(state);
+                } else {
                     fctUtil.defer(_switchState, this, state);
                 }
-            );
-
-        }
-        // else just switch without any effects
-        else {
-            // wait for the last frame to be
-            // "finished" before switching
-            if (forceChange === true) {
-                _switchState(state);
-            } else {
-                fctUtil.defer(_switchState, this, state);
             }
         }
     },
@@ -542,10 +541,11 @@ 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)
+     * @param {number} state State ID (see constants)
+     * @returns {boolean} true if the specified state is the current one
      */
     isCurrent(state) {
         return _state === state;