melonjs 10.2.0 → 10.3.0

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 = {
 
@@ -100,9 +100,9 @@ var timer = {
          * use it.
          * @public
          * @see me.timer.interpolation
-         * @type {Number}
+         * @type {number}
          * @name tick
-         * @memberOf me.timer
+         * @memberof me.timer
          */
         tick : 1.0,
 
@@ -110,9 +110,9 @@ 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
+         * @memberof me.timer
          */
         fps : 0,
 
@@ -120,27 +120,27 @@ 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
+         * @memberof me.timer
          */
         maxfps : 60,
 
         /**
          * Enable/disable frame interpolation
          * @see me.timer.tick
-         * @type {Boolean}
+         * @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,12 +159,12 @@ 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.
-         * @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;
         },
@@ -188,12 +188,12 @@ 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.
-         * @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;
         },
@@ -217,9 +217,9 @@ 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
+         * @param {number} timeoutID ID of the timeout to be cleared
          */
         clearTimeout(timeoutID) {
             utils.function.defer(clearTimer, this, timeoutID);
@@ -228,9 +228,9 @@ 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
+         * @param {number} intervalID ID of the interval to be cleared
          */
         clearInterval(intervalID) {
             utils.function.defer(clearTimer, this, intervalID);
@@ -240,8 +240,8 @@ 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
-         * @return {Number}
+         * @memberof me.timer
+         * @returns {number}
          * @function
          */
         getTime() {
@@ -251,8 +251,8 @@ var timer = {
         /**
          * Return elapsed time in milliseconds since the last update
          * @name getDelta
-         * @memberOf me.timer
-         * @return {Number}
+         * @memberof me.timer
+         * @returns {number}
          * @function
          */
         getDelta() {
@@ -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,21 +35,21 @@ var measureTextHeight = function(font) {
  * @classdesc
  * a bitmap font object
  * @class BitmapText
- * @extends me.Renderable
- * @memberOf me
- * @constructor
- * @param {Number} [scale=1.0]
- * @param {Object} settings the text configuration
- * @param {String|Image} settings.font a font name to identify the corresponing source image
- * @param {String} [settings.fontData=settings.font] the bitmap font data corresponding name, or the bitmap font data itself
- * @param {Number} [settings.size] size a scaling ratio
- * @param {me.Color|String} [settings.fillStyle] a CSS color value used to tint the bitmapText (@see me.BitmapText.tint)
- * @param {Number} [settings.lineWidth=1] line width, in pixels, when drawing stroke
- * @param {String} [settings.textAlign="left"] horizontal text alignment
- * @param {String} [settings.textBaseline="top"] the text baseline
- * @param {Number} [settings.lineHeight=1.0] line spacing height
+ * @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
+ * @param {string|Image} settings.font a font name to identify the corresponing source image
+ * @param {string} [settings.fontData=settings.font] the bitmap font data corresponding name, or the bitmap font data itself
+ * @param {number} [settings.size] size a scaling ratio
+ * @param {me.Color|string} [settings.fillStyle] a CSS color value used to tint the bitmapText (@see me.BitmapText.tint)
+ * @param {number} [settings.lineWidth=1] line width, in pixels, when drawing stroke
+ * @param {string} [settings.textAlign="left"] horizontal text alignment
+ * @param {string} [settings.textBaseline="top"] the text baseline
+ * @param {number} [settings.lineHeight=1.0] line spacing height
  * @param {me.Vector2d} [settings.anchorPoint={x:0.0, y:0.0}] anchor point to draw the text at
- * @param {(String|String[])} [settings.text] a string, or an array of strings
+ * @param {(string|string[])} [settings.text] a string, or an array of strings
  * @example
  * // Use me.loader.preload or me.loader.load to load assets
  * me.loader.preload([
@@ -76,10 +76,10 @@ class BitmapText extends Renderable {
          * Set the default text alignment (or justification),<br>
          * possible values are "left", "right", and "center".
          * @public
-         * @type String
+         * @type {string}
          * @default "left"
          * @name textAlign
-         * @memberOf me.BitmapText
+         * @memberof me.BitmapText
          */
         this.textAlign = settings.textAlign || "left";
 
@@ -87,10 +87,10 @@ class BitmapText extends Renderable {
          * Set the text baseline (e.g. the Y-coordinate for the draw operation), <br>
          * possible values are "top", "hanging, "middle, "alphabetic, "ideographic, "bottom"<br>
          * @public
-         * @type String
+         * @type {string}
          * @default "top"
          * @name textBaseline
-         * @memberOf me.BitmapText
+         * @memberof me.BitmapText
          */
         this.textBaseline = settings.textBaseline || "top";
 
@@ -98,19 +98,19 @@ class BitmapText extends Renderable {
          * Set the line spacing height (when displaying multi-line strings). <br>
          * Current font height will be multiplied with this value to set the line height.
          * @public
-         * @type Number
+         * @type {number}
          * @default 1.0
          * @name lineHeight
-         * @memberOf me.BitmapText
+         * @memberof me.BitmapText
          */
         this.lineHeight = settings.lineHeight || 1.0;
 
         /**
          * the text to be displayed
          * @private
-         * @type {String[]}
+         * @type {string[]}
          * @name _text
-         * @memberOf me.BitmapText
+         * @memberof me.BitmapText
          */
         this._text = [];
 
@@ -165,11 +165,11 @@ 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]
-     * @return this object for chaining
+     * @param {string} textAlign ("left", "center", "right")
+     * @param {number} [scale]
+     * @returns {me.BitmapText} this object for chaining
      */
     set(textAlign, scale) {
         this.textAlign = textAlign;
@@ -185,10 +185,10 @@ 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
-     * @return this object for chaining
+     * @param {number|string|string[]} value a string, or an array of strings
+     * @returns {me.BitmapText} this object for chaining
      */
     setText(value) {
         if (typeof value === "undefined") {
@@ -213,18 +213,11 @@ class BitmapText extends Renderable {
      * @type {me.Color}
      * @name fillStyle
      * @see me.Renderable#tint
-     * @memberOf me.BitmapText
-     */
-
-    /**
-     * @ignore
+     * @memberof me.BitmapText
      */
     get fillStyle() {
         return this.tint;
     }
-    /**
-     * @ignore
-     */
     set fillStyle(value) {
         this.tint = value;
     }
@@ -232,10 +225,10 @@ class BitmapText extends Renderable {
     /**
      * change the font display size
      * @name resize
-     * @memberOf me.BitmapText.prototype
+     * @memberof me.BitmapText.prototype
      * @function
-     * @param {Number} scale ratio
-     * @return this object for chaining
+     * @param {number} scale ratio
+     * @returns {me.BitmapText} this object for chaining
      */
     resize(scale) {
         this.fontScale.set(scale, scale);
@@ -248,9 +241,9 @@ 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 {string} [text]
      * @param {me.Rect} [ret] a object in which to store the text metrics
      * @returns {TextMetrics} a TextMetrics object with two properties: `width` and `height`, defining the output dimensions
      */
@@ -283,12 +276,12 @@ 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]
-     * @param {Number} [x]
-     * @param {Number} [y]
+     * @param {string} [text]
+     * @param {number} [x]
+     * @param {number} [y]
      */
     draw(renderer, text, x, y) {
         // save the previous global alpha value

package/src/text/bitmaptextdata.js

@@ -5,7 +5,7 @@ var capChars = ["M", "N", "B", "D", "C", "E", "F", "K", "A", "G", "H", "I", "J",
 
 /**
  * Gets the value from a string of pairs.
- * @private
+ * @ignore
  */
 function getValueFromPair(string, pattern) {
     var value = string.match(pattern);
@@ -18,11 +18,11 @@ function getValueFromPair(string, pattern) {
 
 /**
  * Gets the first glyph in the map that is not a space character
- * @private
+ * @ignore
  * @name _getFirstGlyph
- * @memberOf me.BitmapTextData
+ * @memberof me.BitmapTextData
  * @function
- * @param {Object} glyphs the map of glyphs, each key is a char code
+ * @param {object} glyphs the map of glyphs, each key is a char code
  * @returns {me.Glyph}
  */
 function getFirstGlyph(glyphs) {
@@ -37,11 +37,11 @@ function getFirstGlyph(glyphs) {
 
 /**
  * Creates a glyph to use for the space character
- * @private
+ * @ignore
  * @name createSpaceGlyph
- * @memberOf me.BitmapTextData
+ * @memberof me.BitmapTextData
  * @function
- * @param {Object} glyphs the map of glyphs, each key is a char code
+ * @param {object} glyphs the map of glyphs, each key is a char code
  */
 function createSpaceGlyph(glyphs) {
     var spaceCharCode = " ".charCodeAt(0);
@@ -59,10 +59,9 @@ function createSpaceGlyph(glyphs) {
 /**
  * Class for storing relevant data from the font file.
  * @class me.BitmapTextData
- * @memberOf me
- * @private
- * @param data {String} - The bitmap font data pulled from the resource loader using me.loader.getBinary()
- * @constructor
+ * @memberof me
+ * @ignore
+ * @param data {string} - The bitmap font data pulled from the resource loader using me.loader.getBinary()
  */
 class BitmapTextData {
 
@@ -88,8 +87,8 @@ class BitmapTextData {
         /**
          * The map of glyphs, each key is a char code.
          * @name glyphs
-         * @type {Object}
-         * @memberOf me.BitmapTextData
+         * @type {object}
+         * @memberof me.BitmapTextData
          */
         this.glyphs = {};
 
@@ -100,9 +99,9 @@ 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
+     * @param {string} fontData
      */
     parse(fontData) {
         if (!fontData) {