melonjs 10.2.2 → 10.4.0

package/src/system/event.js

@@ -3,7 +3,6 @@ import EventEmitter from "eventemitter3";
 /**
  * an event system based on nodeJS EventEmitter interface
  * @namespace event
- * @memberOf me
  */
 
 // internal instance of the event emiter
@@ -15,8 +14,8 @@ var eventEmitter = new EventEmitter();
  * @constant
  * @type {string}
  * @name BOOT
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const BOOT = "me.boot";
 
@@ -27,8 +26,8 @@ export const BOOT = "me.boot";
  * @constant
  * @type {string}
  * @name STATE_PAUSE
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const STATE_PAUSE = "me.state.onPause";
 
@@ -39,8 +38,8 @@ export const STATE_PAUSE = "me.state.onPause";
  * @constant
  * @type {string}
  * @name STATE_RESUME
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const STATE_RESUME = "me.state.onResume";
 
@@ -51,8 +50,8 @@ export const STATE_RESUME = "me.state.onResume";
  * @constant
  * @type {string}
  * @name STATE_STOP
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const STATE_STOP = "me.state.onStop";
 
@@ -63,8 +62,8 @@ export const STATE_STOP = "me.state.onStop";
  * @constant
  * @type {string}
  * @name STATE_RESTART
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const STATE_RESTART = "me.state.onRestart";
 
@@ -75,9 +74,9 @@ export const STATE_RESTART = "me.state.onRestart";
  * @constant
  * @type {string}
  * @name VIDEO_INIT
- * @memberOf me.event
- * @see me.video.init
- * @see me.event.on
+ * @memberof event
+ * @see video.init
+ * @see event.on
  */
 export const VIDEO_INIT = "me.video.onInit";
 
@@ -88,8 +87,8 @@ export const VIDEO_INIT = "me.video.onInit";
  * @constant
  * @type {string}
  * @name GAME_INIT
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const GAME_INIT = "me.game.onInit";
 
@@ -100,8 +99,8 @@ export const GAME_INIT = "me.game.onInit";
  * @constant
  * @type {string}
  * @name GAME_RESET
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const GAME_RESET = "me.game.onReset";
 
@@ -112,8 +111,8 @@ export const GAME_RESET = "me.game.onReset";
  * @constant
  * @type {string}
  * @name GAME_BEFORE_UPDATE
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const GAME_BEFORE_UPDATE = "me.game.beforeUpdate";
 
@@ -124,8 +123,8 @@ export const GAME_BEFORE_UPDATE = "me.game.beforeUpdate";
  * @constant
  * @type {string}
  * @name GAME_AFTER_UPDATE
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const GAME_AFTER_UPDATE = "me.game.afterUpdate";
 
@@ -136,8 +135,8 @@ export const GAME_AFTER_UPDATE = "me.game.afterUpdate";
  * @constant
  * @type {string}
  * @name GAME_UPDATE
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const GAME_UPDATE = "me.game.onUpdate";
 
@@ -148,8 +147,8 @@ export const GAME_UPDATE = "me.game.onUpdate";
  * @constant
  * @type {string}
  * @name GAME_BEFORE_DRAW
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const GAME_BEFORE_DRAW = "me.game.beforeDraw";
 
@@ -160,8 +159,8 @@ export const GAME_BEFORE_DRAW = "me.game.beforeDraw";
  * @constant
  * @type {string}
  * @name GAME_AFTER_DRAW
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const GAME_AFTER_DRAW = "me.game.afterDraw";
 
@@ -172,8 +171,8 @@ export const GAME_AFTER_DRAW = "me.game.afterDraw";
  * @constant
  * @type {string}
  * @name LEVEL_LOADED
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const LEVEL_LOADED = "me.game.onLevelLoaded";
 
@@ -184,8 +183,8 @@ export const LEVEL_LOADED = "me.game.onLevelLoaded";
  * @constant
  * @type {string}
  * @name LOADER_COMPLETE
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const LOADER_COMPLETE = "me.loader.onload";
 
@@ -196,8 +195,8 @@ export const LOADER_COMPLETE = "me.loader.onload";
  * @constant
  * @type {string}
  * @name LOADER_PROGRESS
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const LOADER_PROGRESS = "me.loader.onProgress";
 
@@ -213,8 +212,8 @@ export const LOADER_PROGRESS = "me.loader.onProgress";
  * @constant
  * @type {string}
  * @name KEYDOWN
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  * @example
  * me.input.bindKey(me.input.KEY.X, "jump", true); // Edge-triggered
  * me.input.bindKey(me.input.KEY.Z, "shoot"); // Level-triggered
@@ -239,8 +238,8 @@ export const KEYDOWN = "me.input.keydown";
  * @constant
  * @type {string}
  * @name KEYUP
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  * @example
  * me.event.on(me.event.KEYUP, (action, keyCode) => {
  *   // Checking unbound keys
@@ -263,8 +262,8 @@ export const KEYUP = "me.input.keyup";
  * @constant
  * @type {string}
  * @name GAMEPAD_CONNECTED
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const GAMEPAD_CONNECTED = "gamepad.connected";
 
@@ -275,8 +274,8 @@ export const GAMEPAD_CONNECTED = "gamepad.connected";
  * @constant
  * @type {string}
  * @name GAMEPAD_DISCONNECTED
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const GAMEPAD_DISCONNECTED = "gamepad.disconnected";
 
@@ -291,8 +290,8 @@ export const GAMEPAD_DISCONNECTED = "gamepad.disconnected";
  * @constant
  * @type {string}
  * @name GAMEPAD_UPDATE
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const GAMEPAD_UPDATE = "gamepad.update";
 
@@ -303,11 +302,23 @@ export const GAMEPAD_UPDATE = "gamepad.update";
  * @constant
  * @type {string}
  * @name POINTERMOVE
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see 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 event
+ * @see event.on
+ */
+export const POINTERLOCKCHANGE = "me.event.pointerlockChange";
+
 /**
  * Event for dragstart events on a Draggable entity <br>
  * Data passed:
@@ -317,8 +328,8 @@ export const POINTERMOVE = "me.event.pointermove";
  * @constant
  * @type {string}
  * @name DRAGSTART
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const DRAGSTART = "me.game.dragstart";
 
@@ -331,8 +342,8 @@ export const DRAGSTART = "me.game.dragstart";
  * @constant
  * @type {string}
  * @name DRAGEND
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const DRAGEND = "me.game.dragend";
 
@@ -343,8 +354,8 @@ export const DRAGEND = "me.game.dragend";
  * @constant
  * @type {string}
  * @name WINDOW_ONRESIZE
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const WINDOW_ONRESIZE = "window.onresize";
 
@@ -357,8 +368,8 @@ export const WINDOW_ONRESIZE = "window.onresize";
  * @constant
  * @type {string}
  * @name CANVAS_ONRESIZE
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const CANVAS_ONRESIZE = "canvas.onresize";
 
@@ -371,8 +382,8 @@ export const CANVAS_ONRESIZE = "canvas.onresize";
  * @constant
  * @type {string}
  * @name VIEWPORT_ONRESIZE
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const VIEWPORT_ONRESIZE = "viewport.onresize";
 
@@ -383,8 +394,8 @@ export const VIEWPORT_ONRESIZE = "viewport.onresize";
  * @constant
  * @type {string}
  * @name WINDOW_ONORIENTATION_CHANGE
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const WINDOW_ONORIENTATION_CHANGE = "window.orientationchange";
 
@@ -395,8 +406,8 @@ export const WINDOW_ONORIENTATION_CHANGE = "window.orientationchange";
  * @constant
  * @type {string}
  * @name WINDOW_ONSCROLL
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const WINDOW_ONSCROLL = "window.onscroll";
 
@@ -407,8 +418,8 @@ export const WINDOW_ONSCROLL = "window.onscroll";
  * @constant
  * @type {string}
  * @name VIEWPORT_ONCHANGE
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const VIEWPORT_ONCHANGE = "viewport.onchange";
 
@@ -419,8 +430,8 @@ export const VIEWPORT_ONCHANGE = "viewport.onchange";
  * @constant
  * @type {string}
  * @name WEBGL_ONCONTEXT_LOST
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const WEBGL_ONCONTEXT_LOST = "renderer.webglcontextlost";
 
@@ -431,14 +442,14 @@ export const WEBGL_ONCONTEXT_LOST = "renderer.webglcontextlost";
  * @constant
  * @type {string}
  * @name WEBGL_ONCONTEXT_RESTORED
- * @memberOf me.event
- * @see me.event.on
+ * @memberof event
+ * @see event.on
  */
 export const WEBGL_ONCONTEXT_RESTORED = "renderer.webglcontextrestored";
 
 /**
  * calls each of the listeners registered for a given event.
- * @function me.event.emit
+ * @function event.emit
  * @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.
@@ -451,7 +462,7 @@ export function emit(eventName, ...args) {
 
 /**
  * Add a listener for a given event.
- * @function me.event.on
+ * @function event.on
  * @param {string|symbol} eventName The event name.
  * @param {Function} listener The listener function.
  * @param {*} [context=this] The context to invoke the listener with.
@@ -466,7 +477,7 @@ export function on(eventName, listener, context) {
 
 /**
  * Add a one-time listener for a given event.
- * @function me.event.once
+ * @function event.once
  * @param {string|symbol} eventName The event name.
  * @param {Function} listener The listener function.
  * @param {*} [context=this] The context to invoke the listener with.
@@ -481,7 +492,7 @@ export function once(eventName, listener, context) {
 
 /**
  * remove the given listener for a given event.
- * @function me.event.off
+ * @function event.off
  * @param {string|symbol} eventName The event name.
  * @param {Function} listener The listener function.
  * @returns {EventEmitter} `this`.

package/src/system/pooling.js

@@ -12,8 +12,7 @@ var instance_counter = 0;
  * which means, that on level loading the engine will try to instantiate every object
  * 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
+ * @namespace pool
  */
 
 var pool = {
@@ -22,7 +21,7 @@ var pool = {
      * register an object to the pool. <br>
      * 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
+     * @function pool.register
      * @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
@@ -50,8 +49,8 @@ var pool = {
 
     /**
      * Pull a new instance of the requested object (if added into the object pool)
-     * @function me.pool.pull
-     * @param {string} name as used in {@link me.pool.register}
+     * @function pool.pull
+     * @param {string} name as used in {@link pool.register}
      * @param {object} [...arguments] arguments to be passed when instantiating/reinitializing the object
      * @returns {object} the instance of the requested object
      * @example
@@ -107,7 +106,7 @@ var pool = {
      * purge the object pool from any inactive object <br>
      * Object pooling must be enabled for this function to work<br>
      * note: this will trigger the garbage collector
-     * @function me.pool.purge
+     * @function pool.purge
      */
     purge() {
         for (var className in objectClass) {
@@ -121,9 +120,9 @@ var pool = {
     /**
      * Push back an object instance into the object pool <br>
      * Object pooling for the object class must be enabled,
-     * and object must have been instantiated using {@link me.pool#pull},
+     * and object must have been instantiated using {@link pool#pull},
      * otherwise this function won't work
-     * @function me.pool.push
+     * @function pool.push
      * @throws will throw an error if the object cannot be recycled
      * @param {object} obj instance to be recycled
      * @param {boolean} [throwOnError=true] throw an exception if the object cannot be recycled
@@ -147,7 +146,7 @@ var pool = {
 
     /**
      * Check if an object with the provided name is registered
-     * @function me.pool.exists
+     * @function pool.exists
      * @param {string} name of the registered object class
      * @returns {boolean} true if the classname is registered
      */
@@ -158,8 +157,8 @@ var pool = {
     /**
      * Check if an object is poolable
      * (was properly registered with the recycling feature enable)
-     * @function me.pool.poolable
-     * @see me.pool.register
+     * @function pool.poolable
+     * @see pool.register
      * @param {object} obj object to be checked
      * @returns {boolean} true if the object is poolable
      * @example
@@ -178,7 +177,7 @@ var pool = {
 
     /**
      * returns the amount of object instance currently in the pool
-     * @function me.pool.getInstanceCount
+     * @function pool.getInstanceCount
      * @returns {number} amount of object instance
      */
     getInstanceCount() {

package/src/system/save.js

@@ -29,8 +29,7 @@ import * as event from "./../system/event.js";
  *
  * // Remove "lives" from localStorage
  * me.save.remove("lives");
- * @namespace me.save
- * @memberOf me
+ * @namespace save
  */
 
  // Variable to hold the object data
@@ -65,7 +64,7 @@ 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 save
      * @function
      * @param {object} props key and corresponding values
      * @example
@@ -119,7 +118,7 @@ var save = {
     /**
      * Remove a key from localStorage
      * @name remove
-     * @memberOf me.save
+     * @memberof save
      * @function
      * @param {string} key key to be removed
      * @example

package/src/system/timer.js

@@ -87,22 +87,21 @@ event.on(event.BOOT, () => {
 
 /**
  * a Timer class to manage timing related function (FPS, Game Tick, Time...)
- * @namespace me.timer
- * @memberOf me
+ * @namespace timer
  */
 var timer = {
 
         /**
          * Last game tick value.<br/>
          * Use this value to scale velocities during frame drops due to slow
-         * hardware or when setting an FPS limit. (See {@link me.timer.maxfps})
+         * hardware or when setting an FPS limit. (See {@link timer.maxfps})
          * This feature is disabled by default. Enable me.timer.interpolation to
          * use it.
          * @public
-         * @see me.timer.interpolation
+         * @see timer.interpolation
          * @type {number}
          * @name tick
-         * @memberOf me.timer
+         * @memberof timer
          */
         tick : 1.0,
 
@@ -112,35 +111,35 @@ var timer = {
          * @public
          * @type {number}
          * @name fps
-         * @memberOf me.timer
+         * @memberof timer
          */
         fps : 0,
 
         /**
          * Set the maximum target display frame per second
          * @public
-         * @see me.timer.tick
+         * @see timer.tick
          * @type {number}
          * @name maxfps
          * @default 60
-         * @memberOf me.timer
+         * @memberof timer
          */
         maxfps : 60,
 
         /**
          * Enable/disable frame interpolation
-         * @see me.timer.tick
+         * @see timer.tick
          * @type {boolean}
          * @default false
          * @name interpolation
-         * @memberOf me.timer
+         * @memberof timer
          */
         interpolation : false,
 
         /**
          * reset time (e.g. usefull in case of pause)
          * @name reset
-         * @memberOf me.timer
+         * @memberof timer
          * @ignore
          * @function
          */
@@ -159,11 +158,11 @@ var timer = {
         /**
          * Calls a function once after a specified delay. See me.timer.setInterval to repeativly call a function.
          * @name setTimeout
-         * @memberOf me.timer
+         * @memberof 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 {object} [args] optional parameters which are passed through to the function specified by fn once the timer expires.
+         * @param {...*} 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
@@ -188,11 +187,11 @@ var timer = {
         /**
          * Calls a function continously at the specified interval.  See setTimeout to call function a single time.
          * @name setInterval
-         * @memberOf me.timer
+         * @memberof 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 {object} [args] optional parameters which are passed through to the function specified by fn once the timer expires.
+         * @param {...*} 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
@@ -217,7 +216,7 @@ var timer = {
         /**
          * Clears the delay set by me.timer.setTimeout().
          * @name clearTimeout
-         * @memberOf me.timer
+         * @memberof timer
          * @function
          * @param {number} timeoutID ID of the timeout to be cleared
          */
@@ -228,7 +227,7 @@ var timer = {
         /**
          * Clears the Interval set by me.timer.setInterval().
          * @name clearInterval
-         * @memberOf me.timer
+         * @memberof timer
          * @function
          * @param {number} intervalID ID of the interval to be cleared
          */
@@ -240,7 +239,7 @@ var timer = {
          * Return the current timestamp in milliseconds <br>
          * since the game has started or since linux epoch (based on browser support for High Resolution Timer)
          * @name getTime
-         * @memberOf me.timer
+         * @memberof timer
          * @returns {number}
          * @function
          */
@@ -251,7 +250,7 @@ var timer = {
         /**
          * Return elapsed time in milliseconds since the last update
          * @name getDelta
-         * @memberOf me.timer
+         * @memberof timer
          * @returns {number}
          * @function
          */
@@ -263,7 +262,7 @@ var timer = {
          * compute the actual frame time and fps rate
          * @name computeFPS
          * @ignore
-         * @memberOf me.timer
+         * @memberof timer
          * @function
          */
         countFPS() {