melonjs 10.2.3 → 10.3.0

package/src/system/event.js

@@ -3,7 +3,7 @@ import EventEmitter from "eventemitter3";
 /**
  * an event system based on nodeJS EventEmitter interface
  * @namespace event
- * @memberOf me
+ * @memberof me
  */
 
 // internal instance of the event emiter
@@ -15,7 +15,7 @@ var eventEmitter = new EventEmitter();
  * @constant
  * @type {string}
  * @name BOOT
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const BOOT = "me.boot";
@@ -27,7 +27,7 @@ export const BOOT = "me.boot";
  * @constant
  * @type {string}
  * @name STATE_PAUSE
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const STATE_PAUSE = "me.state.onPause";
@@ -39,7 +39,7 @@ export const STATE_PAUSE = "me.state.onPause";
  * @constant
  * @type {string}
  * @name STATE_RESUME
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const STATE_RESUME = "me.state.onResume";
@@ -51,7 +51,7 @@ export const STATE_RESUME = "me.state.onResume";
  * @constant
  * @type {string}
  * @name STATE_STOP
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const STATE_STOP = "me.state.onStop";
@@ -63,7 +63,7 @@ export const STATE_STOP = "me.state.onStop";
  * @constant
  * @type {string}
  * @name STATE_RESTART
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const STATE_RESTART = "me.state.onRestart";
@@ -75,7 +75,7 @@ export const STATE_RESTART = "me.state.onRestart";
  * @constant
  * @type {string}
  * @name VIDEO_INIT
- * @memberOf me.event
+ * @memberof me.event
  * @see me.video.init
  * @see me.event.on
  */
@@ -88,7 +88,7 @@ export const VIDEO_INIT = "me.video.onInit";
  * @constant
  * @type {string}
  * @name GAME_INIT
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const GAME_INIT = "me.game.onInit";
@@ -100,7 +100,7 @@ export const GAME_INIT = "me.game.onInit";
  * @constant
  * @type {string}
  * @name GAME_RESET
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const GAME_RESET = "me.game.onReset";
@@ -112,7 +112,7 @@ export const GAME_RESET = "me.game.onReset";
  * @constant
  * @type {string}
  * @name GAME_BEFORE_UPDATE
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const GAME_BEFORE_UPDATE = "me.game.beforeUpdate";
@@ -124,7 +124,7 @@ export const GAME_BEFORE_UPDATE = "me.game.beforeUpdate";
  * @constant
  * @type {string}
  * @name GAME_AFTER_UPDATE
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const GAME_AFTER_UPDATE = "me.game.afterUpdate";
@@ -136,7 +136,7 @@ export const GAME_AFTER_UPDATE = "me.game.afterUpdate";
  * @constant
  * @type {string}
  * @name GAME_UPDATE
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const GAME_UPDATE = "me.game.onUpdate";
@@ -148,7 +148,7 @@ export const GAME_UPDATE = "me.game.onUpdate";
  * @constant
  * @type {string}
  * @name GAME_BEFORE_DRAW
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const GAME_BEFORE_DRAW = "me.game.beforeDraw";
@@ -160,7 +160,7 @@ export const GAME_BEFORE_DRAW = "me.game.beforeDraw";
  * @constant
  * @type {string}
  * @name GAME_AFTER_DRAW
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const GAME_AFTER_DRAW = "me.game.afterDraw";
@@ -172,7 +172,7 @@ export const GAME_AFTER_DRAW = "me.game.afterDraw";
  * @constant
  * @type {string}
  * @name LEVEL_LOADED
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const LEVEL_LOADED = "me.game.onLevelLoaded";
@@ -184,7 +184,7 @@ export const LEVEL_LOADED = "me.game.onLevelLoaded";
  * @constant
  * @type {string}
  * @name LOADER_COMPLETE
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const LOADER_COMPLETE = "me.loader.onload";
@@ -196,7 +196,7 @@ export const LOADER_COMPLETE = "me.loader.onload";
  * @constant
  * @type {string}
  * @name LOADER_PROGRESS
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const LOADER_PROGRESS = "me.loader.onProgress";
@@ -213,7 +213,7 @@ export const LOADER_PROGRESS = "me.loader.onProgress";
  * @constant
  * @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
@@ -239,7 +239,7 @@ export const KEYDOWN = "me.input.keydown";
  * @constant
  * @type {string}
  * @name KEYUP
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  * @example
  * me.event.on(me.event.KEYUP, (action, keyCode) => {
@@ -263,7 +263,7 @@ export const KEYUP = "me.input.keyup";
  * @constant
  * @type {string}
  * @name GAMEPAD_CONNECTED
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const GAMEPAD_CONNECTED = "gamepad.connected";
@@ -275,7 +275,7 @@ export const GAMEPAD_CONNECTED = "gamepad.connected";
  * @constant
  * @type {string}
  * @name GAMEPAD_DISCONNECTED
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const GAMEPAD_DISCONNECTED = "gamepad.disconnected";
@@ -291,7 +291,7 @@ export const GAMEPAD_DISCONNECTED = "gamepad.disconnected";
  * @constant
  * @type {string}
  * @name GAMEPAD_UPDATE
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const GAMEPAD_UPDATE = "gamepad.update";
@@ -303,11 +303,23 @@ export const GAMEPAD_UPDATE = "gamepad.update";
  * @constant
  * @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:
@@ -317,7 +329,7 @@ export const POINTERMOVE = "me.event.pointermove";
  * @constant
  * @type {string}
  * @name DRAGSTART
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const DRAGSTART = "me.game.dragstart";
@@ -331,7 +343,7 @@ export const DRAGSTART = "me.game.dragstart";
  * @constant
  * @type {string}
  * @name DRAGEND
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const DRAGEND = "me.game.dragend";
@@ -343,7 +355,7 @@ export const DRAGEND = "me.game.dragend";
  * @constant
  * @type {string}
  * @name WINDOW_ONRESIZE
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const WINDOW_ONRESIZE = "window.onresize";
@@ -357,7 +369,7 @@ export const WINDOW_ONRESIZE = "window.onresize";
  * @constant
  * @type {string}
  * @name CANVAS_ONRESIZE
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const CANVAS_ONRESIZE = "canvas.onresize";
@@ -371,7 +383,7 @@ export const CANVAS_ONRESIZE = "canvas.onresize";
  * @constant
  * @type {string}
  * @name VIEWPORT_ONRESIZE
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const VIEWPORT_ONRESIZE = "viewport.onresize";
@@ -383,7 +395,7 @@ export const VIEWPORT_ONRESIZE = "viewport.onresize";
  * @constant
  * @type {string}
  * @name WINDOW_ONORIENTATION_CHANGE
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const WINDOW_ONORIENTATION_CHANGE = "window.orientationchange";
@@ -395,7 +407,7 @@ export const WINDOW_ONORIENTATION_CHANGE = "window.orientationchange";
  * @constant
  * @type {string}
  * @name WINDOW_ONSCROLL
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const WINDOW_ONSCROLL = "window.onscroll";
@@ -407,7 +419,7 @@ export const WINDOW_ONSCROLL = "window.onscroll";
  * @constant
  * @type {string}
  * @name VIEWPORT_ONCHANGE
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const VIEWPORT_ONCHANGE = "viewport.onchange";
@@ -419,7 +431,7 @@ export const VIEWPORT_ONCHANGE = "viewport.onchange";
  * @constant
  * @type {string}
  * @name WEBGL_ONCONTEXT_LOST
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const WEBGL_ONCONTEXT_LOST = "renderer.webglcontextlost";
@@ -431,7 +443,7 @@ export const WEBGL_ONCONTEXT_LOST = "renderer.webglcontextlost";
  * @constant
  * @type {string}
  * @name WEBGL_ONCONTEXT_RESTORED
- * @memberOf me.event
+ * @memberof me.event
  * @see me.event.on
  */
 export const WEBGL_ONCONTEXT_RESTORED = "renderer.webglcontextrestored";

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 = {

package/src/system/save.js

@@ -30,7 +30,7 @@ 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
@@ -65,7 +65,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 me.save
      * @function
      * @param {object} props key and corresponding values
      * @example
@@ -119,7 +119,7 @@ var save = {
     /**
      * Remove a key from localStorage
      * @name remove
-     * @memberOf me.save
+     * @memberof me.save
      * @function
      * @param {string} key key to be removed
      * @example

package/src/system/timer.js

@@ -88,7 +88,7 @@ event.on(event.BOOT, () => {
 /**
  * a Timer class to manage timing related function (FPS, Game Tick, Time...)
  * @namespace me.timer
- * @memberOf me
+ * @memberof me
  */
 var timer = {
 
@@ -102,7 +102,7 @@ var timer = {
          * @see me.timer.interpolation
          * @type {number}
          * @name tick
-         * @memberOf me.timer
+         * @memberof me.timer
          */
         tick : 1.0,
 
@@ -112,7 +112,7 @@ var timer = {
          * @public
          * @type {number}
          * @name fps
-         * @memberOf me.timer
+         * @memberof me.timer
          */
         fps : 0,
 
@@ -123,7 +123,7 @@ var timer = {
          * @type {number}
          * @name maxfps
          * @default 60
-         * @memberOf me.timer
+         * @memberof me.timer
          */
         maxfps : 60,
 
@@ -133,14 +133,14 @@ var timer = {
          * @type {boolean}
          * @default false
          * @name interpolation
-         * @memberOf me.timer
+         * @memberof me.timer
          */
         interpolation : false,
 
         /**
          * reset time (e.g. usefull in case of pause)
          * @name reset
-         * @memberOf me.timer
+         * @memberof me.timer
          * @ignore
          * @function
          */
@@ -159,7 +159,7 @@ 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 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.
@@ -188,7 +188,7 @@ var timer = {
         /**
          * Calls a function continously at the specified interval.  See setTimeout to call function a single time.
          * @name setInterval
-         * @memberOf me.timer
+         * @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.
@@ -217,7 +217,7 @@ var timer = {
         /**
          * Clears the delay set by me.timer.setTimeout().
          * @name clearTimeout
-         * @memberOf me.timer
+         * @memberof me.timer
          * @function
          * @param {number} timeoutID ID of the timeout to be cleared
          */
@@ -228,7 +228,7 @@ var timer = {
         /**
          * Clears the Interval set by me.timer.setInterval().
          * @name clearInterval
-         * @memberOf me.timer
+         * @memberof me.timer
          * @function
          * @param {number} intervalID ID of the interval to be cleared
          */
@@ -240,7 +240,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 me.timer
          * @returns {number}
          * @function
          */
@@ -251,7 +251,7 @@ var timer = {
         /**
          * Return elapsed time in milliseconds since the last update
          * @name getDelta
-         * @memberOf me.timer
+         * @memberof me.timer
          * @returns {number}
          * @function
          */
@@ -263,7 +263,7 @@ var timer = {
          * compute the actual frame time and fps rate
          * @name computeFPS
          * @ignore
-         * @memberOf me.timer
+         * @memberof me.timer
          * @function
          */
         countFPS() {

package/src/text/bitmaptext.js

@@ -35,9 +35,8 @@ var measureTextHeight = function(font) {
  * @classdesc
  * a bitmap font object
  * @class BitmapText
- * @extends me.Renderable
- * @memberOf me
- * @constructor
+ * @augments me.Renderable
+ * @memberof me
  * @param {number} x position of the text object
  * @param {number} y position of the text object
  * @param {object} settings the text configuration
@@ -80,7 +79,7 @@ class BitmapText extends Renderable {
          * @type {string}
          * @default "left"
          * @name textAlign
-         * @memberOf me.BitmapText
+         * @memberof me.BitmapText
          */
         this.textAlign = settings.textAlign || "left";
 
@@ -91,7 +90,7 @@ class BitmapText extends Renderable {
          * @type {string}
          * @default "top"
          * @name textBaseline
-         * @memberOf me.BitmapText
+         * @memberof me.BitmapText
          */
         this.textBaseline = settings.textBaseline || "top";
 
@@ -102,7 +101,7 @@ class BitmapText extends Renderable {
          * @type {number}
          * @default 1.0
          * @name lineHeight
-         * @memberOf me.BitmapText
+         * @memberof me.BitmapText
          */
         this.lineHeight = settings.lineHeight || 1.0;
 
@@ -111,7 +110,7 @@ class BitmapText extends Renderable {
          * @private
          * @type {string[]}
          * @name _text
-         * @memberOf me.BitmapText
+         * @memberof me.BitmapText
          */
         this._text = [];
 
@@ -166,7 +165,7 @@ class BitmapText extends Renderable {
     /**
      * change the font settings
      * @name set
-     * @memberOf me.BitmapText.prototype
+     * @memberof me.BitmapText.prototype
      * @function
      * @param {string} textAlign ("left", "center", "right")
      * @param {number} [scale]
@@ -186,7 +185,7 @@ class BitmapText extends Renderable {
     /**
      * change the text to be displayed
      * @name setText
-     * @memberOf me.BitmapText.prototype
+     * @memberof me.BitmapText.prototype
      * @function
      * @param {number|string|string[]} value a string, or an array of strings
      * @returns {me.BitmapText} this object for chaining
@@ -214,7 +213,7 @@ class BitmapText extends Renderable {
      * @type {me.Color}
      * @name fillStyle
      * @see me.Renderable#tint
-     * @memberOf me.BitmapText
+     * @memberof me.BitmapText
      */
     get fillStyle() {
         return this.tint;
@@ -226,7 +225,7 @@ class BitmapText extends Renderable {
     /**
      * change the font display size
      * @name resize
-     * @memberOf me.BitmapText.prototype
+     * @memberof me.BitmapText.prototype
      * @function
      * @param {number} scale ratio
      * @returns {me.BitmapText} this object for chaining
@@ -242,7 +241,7 @@ class BitmapText extends Renderable {
     /**
      * measure the given text size in pixels
      * @name measureText
-     * @memberOf me.BitmapText.prototype
+     * @memberof me.BitmapText.prototype
      * @function
      * @param {string} [text]
      * @param {me.Rect} [ret] a object in which to store the text metrics
@@ -277,7 +276,7 @@ class BitmapText extends Renderable {
     /**
      * draw the bitmap font
      * @name draw
-     * @memberOf me.BitmapText.prototype
+     * @memberof me.BitmapText.prototype
      * @function
      * @param {me.CanvasRenderer|me.WebGLRenderer} renderer Reference to the destination renderer instance
      * @param {string} [text]

package/src/text/bitmaptextdata.js

@@ -20,7 +20,7 @@ function getValueFromPair(string, pattern) {
  * Gets the first glyph in the map that is not a space character
  * @ignore
  * @name _getFirstGlyph
- * @memberOf me.BitmapTextData
+ * @memberof me.BitmapTextData
  * @function
  * @param {object} glyphs the map of glyphs, each key is a char code
  * @returns {me.Glyph}
@@ -39,7 +39,7 @@ function getFirstGlyph(glyphs) {
  * Creates a glyph to use for the space character
  * @ignore
  * @name createSpaceGlyph
- * @memberOf me.BitmapTextData
+ * @memberof me.BitmapTextData
  * @function
  * @param {object} glyphs the map of glyphs, each key is a char code
  */
@@ -59,10 +59,9 @@ function createSpaceGlyph(glyphs) {
 /**
  * Class for storing relevant data from the font file.
  * @class me.BitmapTextData
- * @memberOf me
+ * @memberof me
  * @ignore
  * @param data {string} - The bitmap font data pulled from the resource loader using me.loader.getBinary()
- * @constructor
  */
 class BitmapTextData {
 
@@ -89,7 +88,7 @@ class BitmapTextData {
          * The map of glyphs, each key is a char code.
          * @name glyphs
          * @type {object}
-         * @memberOf me.BitmapTextData
+         * @memberof me.BitmapTextData
          */
         this.glyphs = {};
 
@@ -100,7 +99,7 @@ class BitmapTextData {
     /**
      * This parses the font data text and builds a map of glyphs containing the data for each character
      * @name parse
-     * @memberOf me.BitmapTextData
+     * @memberof me.BitmapTextData
      * @function
      * @param {string} fontData
      */