melonjs 10.2.0 → 10.3.0

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,9 +13,9 @@ var eventEmitter = new EventEmitter();
  * event when the system is booting
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name BOOT
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const BOOT = "me.boot";
@@ -25,21 +25,21 @@ export const BOOT = "me.boot";
  * Data passed : none <br>
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name STATE_PAUSE
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 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
+ * @memberof me.event
  * @see me.event.on
  */
 export const STATE_RESUME = "me.state.onResume";
@@ -49,21 +49,21 @@ export const STATE_RESUME = "me.state.onResume";
  * Data passed : none <br>
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name STATE_STOP
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 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
+ * @memberof me.event
  * @see me.event.on
  */
 export const STATE_RESTART = "me.state.onRestart";
@@ -73,9 +73,9 @@ export const STATE_RESTART = "me.state.onRestart";
  * Data passed : none <br>
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name VIDEO_INIT
- * @memberOf me.event
+ * @memberof me.event
  * @see me.video.init
  * @see me.event.on
  */
@@ -86,9 +86,9 @@ export const VIDEO_INIT = "me.video.onInit";
  * Data passed : none <br>
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name GAME_INIT
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const GAME_INIT = "me.game.onInit";
@@ -98,81 +98,81 @@ export const GAME_INIT = "me.game.onInit";
  * Data passed : none <br>
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name GAME_RESET
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 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
+ * @memberof me.event
  * @see me.event.on
  */
 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
+ * @memberof me.event
  * @see me.event.on
  */
 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
+ * @memberof me.event
  * @see me.event.on
  */
 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
+ * @memberof me.event
  * @see me.event.on
  */
 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
+ * @memberof me.event
  * @see me.event.on
  */
 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
+ * @memberof me.event
  * @see me.event.on
  */
 export const LEVEL_LOADED = "me.game.onLevelLoaded";
@@ -182,38 +182,38 @@ export const LEVEL_LOADED = "me.game.onLevelLoaded";
  * Data passed : none <br>
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name LOADER_COMPLETE
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 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
+ * @memberof me.event
  * @see me.event.on
  */
 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
+ * @memberof me.event
  * @see me.event.on
  * @example
  * me.input.bindKey(me.input.KEY.X, "jump", true); // Edge-triggered
@@ -234,12 +234,12 @@ 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
+ * @memberof me.event
  * @see me.event.on
  * @example
  * me.event.on(me.event.KEYUP, (action, keyCode) => {
@@ -258,40 +258,40 @@ 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
+ * @memberof me.event
  * @see me.event.on
  */
 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
+ * @memberof me.event
  * @see me.event.on
  */
 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
+ * @memberof me.event
  * @see me.event.on
  */
 export const GAMEPAD_UPDATE = "gamepad.update";
@@ -301,23 +301,35 @@ export const GAMEPAD_UPDATE = "gamepad.update";
  * Data passed : {me.Pointer} a Pointer object
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name POINTERMOVE
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const POINTERMOVE = "me.event.pointermove";
 
+/**
+ * Event for onPointerLockChange event <br>
+ * Data passed : {boolean} pointer lock status (true/false)
+ * @public
+ * @constant
+ * @type {string}
+ * @name POINTERLOCKCHANGE
+ * @memberof me.event
+ * @see me.event.on
+ */
+export const POINTERLOCKCHANGE = "me.event.pointerlockChange";
+
 /**
  * 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
+ * @memberof me.event
  * @see me.event.on
  */
 export const DRAGSTART = "me.game.dragstart";
@@ -325,13 +337,13 @@ 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
+ * @memberof me.event
  * @see me.event.on
  */
 export const DRAGEND = "me.game.dragend";
@@ -341,9 +353,9 @@ export const DRAGEND = "me.game.dragend";
  * Data passed : {Event} Event object
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name WINDOW_ONRESIZE
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const WINDOW_ONRESIZE = "window.onresize";
@@ -351,13 +363,13 @@ 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
+ * @memberof me.event
  * @see me.event.on
  */
 export const CANVAS_ONRESIZE = "canvas.onresize";
@@ -365,13 +377,13 @@ 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
+ * @memberof me.event
  * @see me.event.on
  */
 export const VIEWPORT_ONRESIZE = "viewport.onresize";
@@ -381,9 +393,9 @@ 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
+ * @memberof me.event
  * @see me.event.on
  */
 export const WINDOW_ONORIENTATION_CHANGE = "window.orientationchange";
@@ -393,9 +405,9 @@ export const WINDOW_ONORIENTATION_CHANGE = "window.orientationchange";
  * Data passed : {Event} Event object
  * @public
  * @constant
- * @type String
+ * @type {string}
  * @name WINDOW_ONSCROLL
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const WINDOW_ONSCROLL = "window.onscroll";
@@ -405,9 +417,9 @@ 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
+ * @memberof me.event
  * @see me.event.on
  */
 export const VIEWPORT_ONCHANGE = "viewport.onchange";
@@ -417,9 +429,9 @@ 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
+ * @memberof me.event
  * @see me.event.on
  */
 export const WEBGL_ONCONTEXT_LOST = "renderer.webglcontextlost";
@@ -429,9 +441,9 @@ 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
+ * @memberof me.event
  * @see me.event.on
  */
 export const WEBGL_ONCONTEXT_RESTORED = "renderer.webglcontextrestored";
@@ -439,9 +451,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 +464,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 +479,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 +494,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

@@ -13,7 +13,7 @@ var instance_counter = 0;
  * found in the map, based on the user defined name in each Object Properties<br>
  * <img src="images/object_properties.png"/><br>
  * @namespace me.pool
- * @memberOf me
+ * @memberof me
  */
 
 var pool = {
@@ -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

@@ -30,13 +30,16 @@ import * as event from "./../system/event.js";
  * // Remove "lives" from localStorage
  * me.save.remove("lives");
  * @namespace me.save
- * @memberOf me
+ * @memberof me
  */
 
  // 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");
  }
@@ -62,9 +65,9 @@ var save = {
     /**
      * Add new keys to localStorage and set them to the given default values if they do not exist
      * @name add
-     * @memberOf me.save
+     * @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 });
@@ -116,9 +119,9 @@ var save = {
     /**
      * Remove a key from localStorage
      * @name remove
-     * @memberOf me.save
+     * @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");