melonjs 10.1.1 → 10.2.3

package/src/shapes/rectangle.js

@@ -8,10 +8,10 @@ import Polygon from "./poly.js";
  * @extends me.Polygon
  * @memberOf me
  * @constructor
- * @param {Number} x position of the Rectangle
- * @param {Number} y position of the Rectangle
- * @param {Number} w width of the rectangle
- * @param {Number} h height of the rectangle
+ * @param {number} x position of the Rectangle
+ * @param {number} y position of the Rectangle
+ * @param {number} w width of the rectangle
+ * @param {number} h height of the rectangle
  */
 
 class Rect extends Polygon {
@@ -37,11 +37,11 @@ class Rect extends Polygon {
      * @name setShape
      * @memberOf me.Rect.prototype
      * @function
-     * @param {Number} x position of the Rectangle
-     * @param {Number} y position of the Rectangle
-     * @param {Number|Array} w|points width of the rectangle, or an array of vector defining the rectangle
-     * @param {Number} [h] height of the rectangle, if a numeral width parameter is specified
-     * @return {me.Rect} this rectangle
+     * @param {number} x position of the Rectangle
+     * @param {number} y position of the Rectangle
+     * @param {number|me.Vector2d[]} w width of the rectangle, or an array of vector defining the rectangle
+     * @param {number} [h] height of the rectangle, if a numeral width parameter is specified
+     * @returns {me.Rect} this rectangle
      */
     setShape(x, y, w, h) {
         var points = w; // assume w is an array by default
@@ -64,14 +64,10 @@ class Rect extends Polygon {
     /**
      * left coordinate of the Rectangle
      * @public
-     * @type {Number}
+     * @type {number}
      * @name left
      * @memberOf me.Rect
      */
-
-    /**
-     * @ignore
-     */
     get left() {
         return this.pos.x;
     }
@@ -79,14 +75,10 @@ class Rect extends Polygon {
     /**
      * right coordinate of the Rectangle
      * @public
-     * @type {Number}
+     * @type {number}
      * @name right
      * @memberOf me.Rect
      */
-
-    /**
-     * @ignore
-     */
     get right() {
         var w = this.width;
         return (this.pos.x + w) || w;
@@ -95,14 +87,10 @@ class Rect extends Polygon {
     /**
      * top coordinate of the Rectangle
      * @public
-     * @type {Number}
+     * @type {number}
      * @name top
      * @memberOf me.Rect
      */
-
-    /**
-     * @ignore
-     */
     get top() {
         return this.pos.y;
     }
@@ -110,14 +98,10 @@ class Rect extends Polygon {
     /**
      * bottom coordinate of the Rectangle
      * @public
-     * @type {Number}
+     * @type {number}
      * @name bottom
      * @memberOf me.Rect
      */
-
-    /**
-     * @ignore
-     */
     get bottom() {
         var h = this.height;
         return (this.pos.y + h) || h;
@@ -126,20 +110,13 @@ class Rect extends Polygon {
     /**
      * width of the Rectangle
      * @public
-     * @type {Number}
+     * @type {number}
      * @name width
      * @memberOf me.Rect
      */
-
-    /**
-     * @ignore
-     */
     get width() {
         return this.points[2].x;
     }
-    /**
-     * @ignore
-     */
     set width(value) {
         this.points[1].x = this.points[2].x = value;
         this.recalc();
@@ -149,20 +126,13 @@ class Rect extends Polygon {
     /**
      * height of the Rectangle
      * @public
-     * @type {Number}
+     * @type {number}
      * @name height
      * @memberOf me.Rect
      */
-
-    /**
-     * @ignore
-     */
     get height() {
         return this.points[2].y;
     }
-    /**
-     * @ignore
-     */
     set height(value) {
         this.points[2].y = this.points[3].y = value;
         this.recalc();
@@ -172,14 +142,10 @@ class Rect extends Polygon {
     /**
      * absolute center of this rectangle on the horizontal axis
      * @public
-     * @type {Number}
+     * @type {number}
      * @name centerX
      * @memberOf me.Rect
      */
-
-    /**
-     * @ignore
-     */
     get centerX() {
         if (isFinite(this.width)) {
             return this.pos.x + (this.width / 2);
@@ -187,10 +153,6 @@ class Rect extends Polygon {
             return this.width;
         }
     }
-
-    /**
-     * @ignore
-     */
     set centerX (value) {
         this.pos.x = value - (this.width / 2);
     }
@@ -198,14 +160,10 @@ class Rect extends Polygon {
     /**
      * absolute center of this rectangle on the vertical axis
      * @public
-     * @type {Number}
+     * @type {number}
      * @name centerY
      * @memberOf me.Rect
      */
-
-    /**
-     * @ignore
-     */
     get centerY() {
         if (isFinite(this.height)) {
             return this.pos.y + (this.height / 2);
@@ -213,10 +171,6 @@ class Rect extends Polygon {
             return this.height;
         }
     }
-
-    /**
-     * @ignore
-     */
     set centerY(value) {
         this.pos.y = value - (this.height / 2);
     }
@@ -226,9 +180,9 @@ class Rect extends Polygon {
      * @name resize
      * @memberOf me.Rect.prototype
      * @function
-     * @param {Number} w new width of the rectangle
-     * @param {Number} h new height of the rectangle
-     * @return {me.Rect} this rectangle
+     * @param {number} w new width of the rectangle
+     * @param {number} h new height of the rectangle
+     * @returns {me.Rect} this rectangle
      */
     resize(w, h) {
         this.width = w;
@@ -241,9 +195,9 @@ class Rect extends Polygon {
      * @name scale
      * @memberOf me.Rect.prototype
      * @function
-     * @param {Number} x a number representing the abscissa of the scaling vector.
-     * @param {Number} [y=x] a number representing the ordinate of the scaling vector.
-     * @return {me.Rect} this rectangle
+     * @param {number} x a number representing the abscissa of the scaling vector.
+     * @param {number} [y=x] a number representing the ordinate of the scaling vector.
+     * @returns {me.Rect} this rectangle
      */
     scale(x, y = x) {
         this.width *= x;
@@ -256,7 +210,7 @@ class Rect extends Polygon {
      * @name clone
      * @memberOf me.Rect.prototype
      * @function
-     * @return {me.Rect} new rectangle
+     * @returns {me.Rect} new rectangle
      */
     clone() {
         return new Rect(this.pos.x, this.pos.y, this.width, this.height);
@@ -268,7 +222,7 @@ class Rect extends Polygon {
      * @memberOf me.Rect.prototype
      * @function
      * @param {me.Rect} rect Source rectangle
-     * @return {me.Rect} new rectangle
+     * @returns {me.Rect} new rectangle
      */
     copy(rect) {
         return this.setShape(rect.pos.x, rect.pos.y, rect.width, rect.height);
@@ -280,15 +234,15 @@ class Rect extends Polygon {
      * @memberOf me.Rect.prototype
      * @function
      * @param {me.Rect} rect other rectangle to union with
-     * @return {me.Rect} the union(ed) rectangle
+     * @returns {me.Rect} the union(ed) rectangle
      */
-    union(/** {me.Rect} */ r) {
-        var x1 = Math.min(this.left, r.left);
-        var y1 = Math.min(this.top, r.top);
+    union(rect) {
+        var x1 = Math.min(this.left, rect.left);
+        var y1 = Math.min(this.top, rect.top);
 
         this.resize(
-            Math.max(this.right, r.right) - x1,
-            Math.max(this.bottom, r.bottom) - y1
+            Math.max(this.right, rect.right) - x1,
+            Math.max(this.bottom, rect.bottom) - y1
         );
 
         this.pos.set(x1, y1);
@@ -302,14 +256,14 @@ class Rect extends Polygon {
      * @memberOf me.Rect.prototype
      * @function
      * @param  {me.Rect} rect
-     * @return {boolean} true if overlaps
+     * @returns {boolean} true if overlaps
      */
-    overlaps(r) {
+    overlaps(rect) {
         return (
-            this.left < r.right &&
-            r.left < this.right &&
-            this.top < r.bottom &&
-            r.top < this.bottom
+            this.left < rect.right &&
+            rect.left < this.right &&
+            this.top < rect.bottom &&
+            rect.top < this.bottom
         );
     }
 
@@ -319,7 +273,7 @@ class Rect extends Polygon {
      * @memberOf me.Rect.prototype
      * @function
      * @param {me.Rect} rect
-     * @return {boolean} true if contains
+     * @returns {boolean} true if contains
      */
 
     /**
@@ -327,9 +281,9 @@ class Rect extends Polygon {
      * @name contains
      * @memberOf me.Rect.prototype
      * @function
-     * @param  {Number} x x coordinate
-     * @param  {Number} y y coordinate
-     * @return {boolean} true if contains
+     * @param  {number} x x coordinate
+     * @param  {number} y y coordinate
+     * @returns {boolean} true if contains
      */
 
     /**
@@ -338,7 +292,7 @@ class Rect extends Polygon {
      * @memberOf me.Rect
      * @function
      * @param {me.Vector2d} point
-     * @return {boolean} true if contains
+     * @returns {boolean} true if contains
      */
     contains() {
         var arg0 = arguments[0];
@@ -374,14 +328,14 @@ class Rect extends Polygon {
      * @memberOf me.Rect.prototype
      * @function
      * @param  {me.Rect} rect
-     * @return {boolean} true if equals
+     * @returns {boolean} true if equals
      */
-    equals(r) {
+    equals(rect) {
         return (
-            r.left === this.left &&
-            r.right === this.right &&
-            r.top === this.top &&
-            r.bottom === this.bottom
+            rect.left === this.left &&
+            rect.right === this.right &&
+            rect.top === this.top &&
+            rect.bottom === this.bottom
         );
     }
 
@@ -390,7 +344,7 @@ class Rect extends Polygon {
      * @name isFinite
      * @memberOf me.Rect.prototype
      * @function
-     * @return {boolean} false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
+     * @returns {boolean} false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
      */
     isFinite() {
         return (isFinite(this.pos.x) && isFinite(this.pos.y) && isFinite(this.width) && isFinite(this.height));
@@ -401,7 +355,7 @@ class Rect extends Polygon {
      * @name toPolygon
      * @memberOf me.Rect.prototype
      * @function
-     * @return {me.Polygon} a new Polygon that represents this rectangle.
+     * @returns {me.Polygon} a new Polygon that represents this rectangle.
      */
     toPolygon() {
         return new Polygon(

package/src/state/stage.js

@@ -19,8 +19,8 @@ var default_settings = {
  * @extends me.Object
  * @memberOf me
  * @constructor
- * @param {Object} [options] The stage` parameters
- * @param {Boolean} [options.cameras=[new me.Camera2d()]] a list of cameras (experimental)
+ * @param {object} [options] The stage` parameters
+ * @param {me.Camera2d[]} [options.cameras=[new me.Camera2d()]] a list of cameras (experimental)
  * @param {Function} [options.onResetEvent] called by the state manager when reseting the object
  * @param {Function} [options.onDestroyEvent] called by the state manager before switching to another state
  * @see me.state
@@ -47,7 +47,7 @@ class Stage {
          * @public
          * @name settings
          * @memberOf me.Stage
-         * @enum {Object}
+         * @type {object}
          */
         this.settings = Object.assign(default_settings, settings || {});
     }
@@ -57,7 +57,7 @@ class Stage {
      * @ignore
      */
     reset() {
-        
+
         // add all defined cameras
         this.settings.cameras.forEach((camera) => {
             this.cameras.set(camera.name, camera);
@@ -87,9 +87,9 @@ class Stage {
      * @memberOf me.Stage
      * @ignore
      * @function
-     * @param {Number} dt time since the last update in milliseconds.
-     * @return false
-     **/
+     * @param {number} dt time since the last update in milliseconds.
+     * @returns {boolean}
+     */
     update(dt) {
         // update all objects (and pass the elapsed time since last frame)
         var isDirty = game.world.update(dt);
@@ -139,7 +139,7 @@ class Stage {
      * @name onResetEvent
      * @memberOf me.Stage
      * @function
-     * @param {} [arguments...] optional arguments passed when switching state
+     * @param {object} [...arguments] optional arguments passed when switching state
      * @see me.state#change
      */
     onResetEvent() {

package/src/state/state.js

@@ -4,7 +4,7 @@ import * as event from "./../system/event.js";
 import timer from "./../system/timer.js";
 import * as game from "./../game.js";
 import Stage from "./../state/stage.js";
-import defaultLoadingScreen from "./../loader/loadingscreen.js";
+import DefaultLoadingScreen from "./../loader/loadingscreen.js";
 
 
 // current state
@@ -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) {
@@ -137,7 +137,7 @@ function _switchState(state) {
 // initialize me.state on system boot
 event.on(event.BOOT, () => {
     // set the built-in loading stage
-    state.set(state.LOADING, defaultLoadingScreen);
+    state.set(state.LOADING, new DefaultLoadingScreen());
     // set and enable the default stage
     state.set(state.DEFAULT, new Stage());
     // enable by default as soon as the display is initialized
@@ -255,15 +255,16 @@ var 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();
             }
 
@@ -281,9 +282,9 @@ var 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
@@ -307,9 +308,9 @@ var 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();
@@ -335,9 +336,9 @@ var 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();
@@ -360,7 +361,7 @@ var 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;
@@ -372,7 +373,7 @@ var 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;
@@ -384,9 +385,9 @@ var 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() {
@@ -444,7 +445,7 @@ var state = {
      * @memberOf me.state
      * @public
      * @function
-     * @return {me.Stage}
+     * @returns {me.Stage}
      */
     current() {
         if (typeof _stages[_state] !== "undefined") {
@@ -458,9 +459,9 @@ var 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") {
@@ -475,8 +476,8 @@ var 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;
@@ -488,9 +489,9 @@ var 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);
             }
         }
     },
@@ -545,7 +544,8 @@ var 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;