melonjs 10.2.1 → 10.2.2

package/src/system/event.js

@@ -1,10 +1,10 @@
 import EventEmitter from "eventemitter3";
 
 /**
-* an event system based on nodeJS EventEmitter interface
-* @namespace event
-* @memberOf me
-*/
+ * an event system based on nodeJS EventEmitter interface
+ * @namespace event
+ * @memberOf me
+ */
 
 // internal instance of the event emiter
 var eventEmitter = new EventEmitter();
@@ -13,7 +13,7 @@ var eventEmitter = new EventEmitter();
  * event when the system is booting
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name BOOT
  * @memberOf me.event
  * @see me.event.on
@@ -25,7 +25,7 @@ export const BOOT = "me.boot";
  * Data passed : none <br>
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name STATE_PAUSE
  * @memberOf me.event
  * @see me.event.on
@@ -34,10 +34,10 @@ export const STATE_PAUSE = "me.state.onPause";
 
 /**
  * event for when the game is resumed <br>
- * Data passed : {Number} time in ms the game was paused
+ * Data passed : {number} time in ms the game was paused
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name STATE_RESUME
  * @memberOf me.event
  * @see me.event.on
@@ -49,7 +49,7 @@ export const STATE_RESUME = "me.state.onResume";
  * Data passed : none <br>
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name STATE_STOP
  * @memberOf me.event
  * @see me.event.on
@@ -58,10 +58,10 @@ export const STATE_STOP = "me.state.onStop";
 
 /**
  * event for when the game is restarted <br>
- * Data passed : {Number} time in ms the game was stopped
+ * Data passed : {number} time in ms the game was stopped
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name STATE_RESTART
  * @memberOf me.event
  * @see me.event.on
@@ -73,7 +73,7 @@ export const STATE_RESTART = "me.state.onRestart";
  * Data passed : none <br>
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name VIDEO_INIT
  * @memberOf me.event
  * @see me.video.init
@@ -86,7 +86,7 @@ export const VIDEO_INIT = "me.video.onInit";
  * Data passed : none <br>
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name GAME_INIT
  * @memberOf me.event
  * @see me.event.on
@@ -98,7 +98,7 @@ export const GAME_INIT = "me.game.onInit";
  * Data passed : none <br>
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name GAME_RESET
  * @memberOf me.event
  * @see me.event.on
@@ -107,10 +107,10 @@ export const GAME_RESET = "me.game.onReset";
 
 /**
  * event for when the engine is about to start a new game loop
- * Data passed : {Number} time the current time stamp
+ * Data passed : {number} time the current time stamp
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name GAME_BEFORE_UPDATE
  * @memberOf me.event
  * @see me.event.on
@@ -119,10 +119,10 @@ export const GAME_BEFORE_UPDATE = "me.game.beforeUpdate";
 
 /**
  * event for the end of the update loop
- * Data passed : {Number} time the current time stamp
+ * Data passed : {number} time the current time stamp
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name GAME_AFTER_UPDATE
  * @memberOf me.event
  * @see me.event.on
@@ -131,10 +131,10 @@ export const GAME_AFTER_UPDATE = "me.game.afterUpdate";
 
 /**
  * Event for when the game is updated (will be impacted by frame skip, frame interpolation and pause/resume state) <br>
- * Data passed : {Number} time the current time stamp
+ * Data passed : {number} time the current time stamp
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name GAME_UPDATE
  * @memberOf me.event
  * @see me.event.on
@@ -143,10 +143,10 @@ export const GAME_UPDATE = "me.game.onUpdate";
 
 /**
  * Event for the end of the draw loop
- * Data passed : {Number} time the current time stamp
+ * Data passed : {number} time the current time stamp
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name GAME_BEFORE_DRAW
  * @memberOf me.event
  * @see me.event.on
@@ -155,10 +155,10 @@ export const GAME_BEFORE_DRAW = "me.game.beforeDraw";
 
 /**
  * Event for the start of the draw loop
- * Data passed : {Number} time the current time stamp
+ * Data passed : {number} time the current time stamp
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name GAME_AFTER_DRAW
  * @memberOf me.event
  * @see me.event.on
@@ -167,10 +167,10 @@ export const GAME_AFTER_DRAW = "me.game.afterDraw";
 
 /**
  * Event for when a level is loaded <br>
- * Data passed : {String} Level Name
+ * Data passed : {string} Level Name
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name LEVEL_LOADED
  * @memberOf me.event
  * @see me.event.on
@@ -182,7 +182,7 @@ export const LEVEL_LOADED = "me.game.onLevelLoaded";
  * Data passed : none <br>
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name LOADER_COMPLETE
  * @memberOf me.event
  * @see me.event.on
@@ -191,10 +191,10 @@ export const LOADER_COMPLETE = "me.loader.onload";
 
 /**
  * Event for displaying a load progress indicator <br>
- * Data passed : {Number} [0 .. 1], {Resource} resource object<br>
+ * Data passed : {number} [0 .. 1], {Resource} resource object<br>
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name LOADER_PROGRESS
  * @memberOf me.event
  * @see me.event.on
@@ -203,15 +203,15 @@ export const LOADER_PROGRESS = "me.loader.onProgress";
 
 /**
  * Event for pressing a binded key <br>
- * Data passed : {String} user-defined action, {Number} keyCode,
- * {Boolean} edge state <br>
+ * Data passed : {string} user-defined action, {number} keyCode,
+ * {boolean} edge state <br>
  * Edge-state is for detecting "locked" key bindings. When a locked key
  * is pressed and held, the first event will have the third argument
  * set true. Subsequent events will continue firing with the third
  * argument set false.
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name KEYDOWN
  * @memberOf me.event
  * @see me.event.on
@@ -234,10 +234,10 @@ export const KEYDOWN = "me.input.keydown";
 
 /**
  * Event for releasing a binded key <br>
- * Data passed : {String} user-defined action, {Number} keyCode
+ * Data passed : {string} user-defined action, {number} keyCode
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name KEYUP
  * @memberOf me.event
  * @see me.event.on
@@ -258,10 +258,10 @@ export const KEYUP = "me.input.keyup";
 
 /**
  * Event for when a gamepad is connected <br>
- * Data passed : {Object} gamepad object
+ * Data passed : {object} gamepad object
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name GAMEPAD_CONNECTED
  * @memberOf me.event
  * @see me.event.on
@@ -270,10 +270,10 @@ export const GAMEPAD_CONNECTED = "gamepad.connected";
 
 /**
  * Event for when a gamepad is disconnected <br>
- * Data passed : {Object} gamepad object
+ * Data passed : {object} gamepad object
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name GAMEPAD_DISCONNECTED
  * @memberOf me.event
  * @see me.event.on
@@ -282,14 +282,14 @@ export const GAMEPAD_DISCONNECTED = "gamepad.disconnected";
 
 /**
  * Event for when gamepad button/axis state is updated <br>
- * Data passed : {Number} index <br>
- * Data passed : {String} type : "axes" or "buttons" <br>
- * Data passed : {Number} button <br>
- * Data passed : {Number} current.value <br>
- * Data passed : {Boolean} current.pressed
+ * Data passed : {number} index <br>
+ * Data passed : {string} type : "axes" or "buttons" <br>
+ * Data passed : {number} button <br>
+ * Data passed : {number} current.value <br>
+ * Data passed : {boolean} current.pressed
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name GAMEPAD_UPDATE
  * @memberOf me.event
  * @see me.event.on
@@ -301,7 +301,7 @@ export const GAMEPAD_UPDATE = "gamepad.update";
  * Data passed : {me.Pointer} a Pointer object
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name POINTERMOVE
  * @memberOf me.event
  * @see me.event.on
@@ -311,11 +311,11 @@ export const POINTERMOVE = "me.event.pointermove";
 /**
  * Event for dragstart events on a Draggable entity <br>
  * Data passed:
- * {Object} the drag event <br>
- * {Object} the Draggable entity
+ * {object} the drag event <br>
+ * {object} the Draggable entity
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name DRAGSTART
  * @memberOf me.event
  * @see me.event.on
@@ -325,11 +325,11 @@ export const DRAGSTART = "me.game.dragstart";
 /**
  * Event for dragend events on a Draggable entity <br>
  * Data passed:
- * {Object} the drag event <br>
- * {Object} the Draggable entity
+ * {object} the drag event <br>
+ * {object} the Draggable entity
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name DRAGEND
  * @memberOf me.event
  * @see me.event.on
@@ -341,7 +341,7 @@ export const DRAGEND = "me.game.dragend";
  * Data passed : {Event} Event object
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name WINDOW_ONRESIZE
  * @memberOf me.event
  * @see me.event.on
@@ -351,11 +351,11 @@ export const WINDOW_ONRESIZE = "window.onresize";
 /**
  * Event for when the canvas is resized <br>
  * (this usually follows a WINDOW_ONRESIZE event).<br>
- * Data passed : {Number} canvas width <br>
- * Data passed : {Number} canvas height
+ * Data passed : {number} canvas width <br>
+ * Data passed : {number} canvas height
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name CANVAS_ONRESIZE
  * @memberOf me.event
  * @see me.event.on
@@ -365,11 +365,11 @@ export const CANVAS_ONRESIZE = "canvas.onresize";
 /**
  * Event for when the viewport is resized <br>
  * (this usually follows a WINDOW_ONRESIZE event, when using the `flex` scaling mode is used and after the viewport was updated).<br>
- * Data passed : {Number} viewport width <br>
- * Data passed : {Number} viewport height
+ * Data passed : {number} viewport width <br>
+ * Data passed : {number} viewport height
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name VIEWPORT_ONRESIZE
  * @memberOf me.event
  * @see me.event.on
@@ -381,7 +381,7 @@ export const VIEWPORT_ONRESIZE = "viewport.onresize";
  * Data passed : {Event} Event object <br>
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name WINDOW_ONORIENTATION_CHANGE
  * @memberOf me.event
  * @see me.event.on
@@ -393,7 +393,7 @@ export const WINDOW_ONORIENTATION_CHANGE = "window.orientationchange";
  * Data passed : {Event} Event object
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name WINDOW_ONSCROLL
  * @memberOf me.event
  * @see me.event.on
@@ -405,7 +405,7 @@ export const WINDOW_ONSCROLL = "window.onscroll";
  * Data passed : {me.Vector2d} viewport position vector
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name VIEWPORT_ONCHANGE
  * @memberOf me.event
  * @see me.event.on
@@ -417,7 +417,7 @@ export const VIEWPORT_ONCHANGE = "viewport.onchange";
  * Data passed : {me.WebGLRenderer} the current webgl renderer instance`
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name WEBGL_ONCONTEXT_LOST
  * @memberOf me.event
  * @see me.event.on
@@ -429,7 +429,7 @@ export const WEBGL_ONCONTEXT_LOST = "renderer.webglcontextlost";
  * Data passed : {me.WebGLRenderer} the current webgl renderer instance`
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name WEBGL_ONCONTEXT_RESTORED
  * @memberOf me.event
  * @see me.event.on
@@ -439,9 +439,9 @@ export const WEBGL_ONCONTEXT_RESTORED = "renderer.webglcontextrestored";
 /**
  * calls each of the listeners registered for a given event.
  * @function me.event.emit
- * @param {(String|Symbol)} event The event name.
- * @param {...*} arguments arguments to be passed to all listeners
- * @return true if the event had listeners, false otherwise.
+ * @param {string|symbol} eventName The event name.
+ * @param {object} [...arguments] arguments to be passed to all listeners
+ * @returns {boolean} true if the event had listeners, false otherwise.
  * @example
  * me.event.emit("event-name", a, b, c);
  */
@@ -452,8 +452,8 @@ export function emit(eventName, ...args) {
 /**
  * Add a listener for a given event.
  * @function me.event.on
- * @param {(String|Symbol)} event The event name.
- * @param {Function} fn The listener function.
+ * @param {string|symbol} eventName The event name.
+ * @param {Function} listener The listener function.
  * @param {*} [context=this] The context to invoke the listener with.
  * @returns {EventEmitter} `this`.
  * @public
@@ -467,8 +467,8 @@ export function on(eventName, listener, context) {
 /**
  * Add a one-time listener for a given event.
  * @function me.event.once
- * @param {(String|Symbol)} event The event name.
- * @param {Function} fn The listener function.
+ * @param {string|symbol} eventName The event name.
+ * @param {Function} listener The listener function.
  * @param {*} [context=this] The context to invoke the listener with.
  * @returns {EventEmitter} `this`.
  * @public
@@ -482,8 +482,8 @@ export function once(eventName, listener, context) {
 /**
  * remove the given listener for a given event.
  * @function me.event.off
- * @param {(String|Symbol)} event The event name.
- * @param {Function} fn The listener function.
+ * @param {string|symbol} eventName The event name.
+ * @param {Function} listener The listener function.
  * @returns {EventEmitter} `this`.
  * @public
  * @example

package/src/system/pooling.js

@@ -23,9 +23,9 @@ var pool = {
      * Pooling must be set to true if more than one such objects will be created. <br>
      * (Note: for an object to be poolable, it must implements a `onResetEvent` method)
      * @function me.pool.register
-     * @param {String} className as defined in the Name field of the Object Properties (in Tiled)
-     * @param {Object} class corresponding Class to be instantiated
-     * @param {Boolean} [recycling=false] enables object recycling for the specified class
+     * @param {string} className as defined in the Name field of the Object Properties (in Tiled)
+     * @param {object} classObj corresponding Class to be instantiated
+     * @param {boolean} [recycling=false] enables object recycling for the specified class
      * @example
      * // implement CherryEntity
      * class CherryEntity extends Spritesheet {
@@ -51,9 +51,9 @@ var pool = {
     /**
      * Pull a new instance of the requested object (if added into the object pool)
      * @function me.pool.pull
-     * @param {String} className as used in {@link me.pool.register}
-     * @param {} [arguments...] arguments to be passed when instantiating/reinitializing the object
-     * @return {Object} the instance of the requested object
+     * @param {string} name as used in {@link me.pool.register}
+     * @param {object} [...arguments] arguments to be passed when instantiating/reinitializing the object
+     * @returns {object} the instance of the requested object
      * @example
      * me.pool.register("bullet", BulletEntity, true);
      * me.pool.register("enemy", EnemyEntity, true);
@@ -125,9 +125,9 @@ var pool = {
      * otherwise this function won't work
      * @function me.pool.push
      * @throws will throw an error if the object cannot be recycled
-     * @param {Object} instance to be recycled
-     * @param {Boolean} [throwOnError=true] throw an exception if the object cannot be recycled
-     * @return {Boolean} true if the object was successfully recycled in the object pool
+     * @param {object} obj instance to be recycled
+     * @param {boolean} [throwOnError=true] throw an exception if the object cannot be recycled
+     * @returns {boolean} true if the object was successfully recycled in the object pool
      */
     push(obj, throwOnError = true) {
         if (!this.poolable(obj)) {
@@ -148,8 +148,8 @@ var pool = {
     /**
      * Check if an object with the provided name is registered
      * @function me.pool.exists
-     * @param {String} name of the registered object class
-     * @return {Boolean} true if the classname is registered
+     * @param {string} name of the registered object class
+     * @returns {boolean} true if the classname is registered
      */
     exists(name) {
         return name in objectClass;
@@ -160,8 +160,8 @@ var pool = {
      * (was properly registered with the recycling feature enable)
      * @function me.pool.poolable
      * @see me.pool.register
-     * @param {Object} object
-     * @return {Boolean} true if the object is poolable
+     * @param {object} obj object to be checked
+     * @returns {boolean} true if the object is poolable
      * @example
      * if (!me.pool.poolable(myCherryEntity)) {
      *     // object was not properly registered
@@ -179,7 +179,7 @@ var pool = {
     /**
      * returns the amount of object instance currently in the pool
      * @function me.pool.getInstanceCount
-     * @return {Number} amount of object instance
+     * @returns {number} amount of object instance
      */
     getInstanceCount() {
         return instance_counter;

package/src/system/save.js

@@ -36,7 +36,10 @@ import * as event from "./../system/event.js";
  // Variable to hold the object data
  var data = {};
 
- // a function to check if the given key is a reserved word
+ /**
+  * a function to check if the given key is a reserved word
+  * @ignore
+  */
  function isReserved(key) {
      return (key === "add" || key === "remove");
  }
@@ -64,7 +67,7 @@ var save = {
      * @name add
      * @memberOf me.save
      * @function
-     * @param {Object} props key and corresponding values
+     * @param {object} props key and corresponding values
      * @example
      * // Initialize "score" and "lives" with default values
      * me.save.add({ score : 0, lives : 3 });
@@ -118,7 +121,7 @@ var save = {
      * @name remove
      * @memberOf me.save
      * @function
-     * @param {String} key key to be removed
+     * @param {string} key key to be removed
      * @example
      * // Remove the "score" key from localStorage
      * me.save.remove("score");

package/src/system/timer.js

@@ -100,7 +100,7 @@ var timer = {
          * use it.
          * @public
          * @see me.timer.interpolation
-         * @type {Number}
+         * @type {number}
          * @name tick
          * @memberOf me.timer
          */
@@ -110,7 +110,7 @@ var timer = {
          * Last measured fps rate.<br/>
          * This feature is disabled by default, unless the debugPanel is enabled/visible
          * @public
-         * @type {Number}
+         * @type {number}
          * @name fps
          * @memberOf me.timer
          */
@@ -120,7 +120,7 @@ var timer = {
          * Set the maximum target display frame per second
          * @public
          * @see me.timer.tick
-         * @type {Number}
+         * @type {number}
          * @name maxfps
          * @default 60
          * @memberOf me.timer
@@ -130,7 +130,7 @@ var timer = {
         /**
          * Enable/disable frame interpolation
          * @see me.timer.tick
-         * @type {Boolean}
+         * @type {boolean}
          * @default false
          * @name interpolation
          * @memberOf me.timer
@@ -161,10 +161,10 @@ var timer = {
          * @name setTimeout
          * @memberOf me.timer
          * @param {Function} fn the function you want to execute after delay milliseconds.
-         * @param {Number} delay the number of milliseconds (thousandths of a second) that the function call should be delayed by.
-         * @param {Boolean} [pauseable=true] respects the pause state of the engine.
-         * @param {...*} [param] optional parameters which are passed through to the function specified by fn once the timer expires.
-         * @return {Number} The numerical ID of the timer, which can be used later with me.timer.clearTimeout().
+         * @param {number} delay the number of milliseconds (thousandths of a second) that the function call should be delayed by.
+         * @param {boolean} [pauseable=true] respects the pause state of the engine.
+         * @param {object} [args] optional parameters which are passed through to the function specified by fn once the timer expires.
+         * @returns {number} The numerical ID of the timer, which can be used later with me.timer.clearTimeout().
          * @function
          * @example
          * // set a timer to call "myFunction" after 1000ms
@@ -172,7 +172,7 @@ var timer = {
          * // set a timer to call "myFunction" after 1000ms (respecting the pause state) and passing param1 and param2
          * me.timer.setTimeout(myFunction, 1000, true, param1, param2);
          */
-        setTimeout(fn, delay, pauseable) {
+        setTimeout(fn, delay, pauseable, ...args) {
             timers.push({
                 fn : fn,
                 delay : delay,
@@ -180,7 +180,7 @@ var timer = {
                 repeat : false,
                 timerId : ++timerId,
                 pauseable : pauseable === true || true,
-                args : arguments.length > 3 ? Array.prototype.slice.call(arguments, 3) : undefined
+                args : args
             });
             return timerId;
         },
@@ -190,10 +190,10 @@ var timer = {
          * @name setInterval
          * @memberOf me.timer
          * @param {Function} fn the function to execute
-         * @param {Number} delay the number of milliseconds (thousandths of a second) on how often to execute the function
-         * @param {Boolean} [pauseable=true] respects the pause state of the engine.
-         * @param {...*} [param] optional parameters which are passed through to the function specified by fn once the timer expires.
-         * @return {Number} The numerical ID of the timer, which can be used later with me.timer.clearInterval().
+         * @param {number} delay the number of milliseconds (thousandths of a second) on how often to execute the function
+         * @param {boolean} [pauseable=true] respects the pause state of the engine.
+         * @param {object} [args] optional parameters which are passed through to the function specified by fn once the timer expires.
+         * @returns {number} The numerical ID of the timer, which can be used later with me.timer.clearInterval().
          * @function
          * @example
          * // set a timer to call "myFunction" every 1000ms
@@ -201,7 +201,7 @@ var timer = {
          * // set a timer to call "myFunction" every 1000ms (respecting the pause state) and passing param1 and param2
          * me.timer.setInterval(myFunction, 1000, true, param1, param2);
          */
-        setInterval(fn, delay, pauseable) {
+        setInterval(fn, delay, pauseable, ...args) {
             timers.push({
                 fn : fn,
                 delay : delay,
@@ -209,7 +209,7 @@ var timer = {
                 repeat : true,
                 timerId : ++timerId,
                 pauseable : pauseable === true || true,
-                args : arguments.length > 3 ? Array.prototype.slice.call(arguments, 3) : undefined
+                args : args
             });
             return timerId;
         },
@@ -219,7 +219,7 @@ var timer = {
          * @name clearTimeout
          * @memberOf me.timer
          * @function
-         * @param {Number} timeoutID ID of the timeout to be cleared
+         * @param {number} timeoutID ID of the timeout to be cleared
          */
         clearTimeout(timeoutID) {
             utils.function.defer(clearTimer, this, timeoutID);
@@ -230,7 +230,7 @@ var timer = {
          * @name clearInterval
          * @memberOf me.timer
          * @function
-         * @param {Number} intervalID ID of the interval to be cleared
+         * @param {number} intervalID ID of the interval to be cleared
          */
         clearInterval(intervalID) {
             utils.function.defer(clearTimer, this, intervalID);
@@ -241,7 +241,7 @@ var timer = {
          * since the game has started or since linux epoch (based on browser support for High Resolution Timer)
          * @name getTime
          * @memberOf me.timer
-         * @return {Number}
+         * @returns {number}
          * @function
          */
         getTime() {
@@ -252,7 +252,7 @@ var timer = {
          * Return elapsed time in milliseconds since the last update
          * @name getDelta
          * @memberOf me.timer
-         * @return {Number}
+         * @returns {number}
          * @function
          */
         getDelta() {