melonjs 10.3.0 → 10.5.1

package/src/text/bitmaptext.js

@@ -34,40 +34,37 @@ var measureTextHeight = function(font) {
 /**
  * @classdesc
  * a bitmap font object
- * @class BitmapText
- * @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
- * @example
- * // Use me.loader.preload or me.loader.load to load assets
- * me.loader.preload([
- *     { name: "arial", type: "binary" src: "data/font/arial.fnt" },
- *     { name: "arial", type: "image" src: "data/font/arial.png" },
- * ])
- * // Then create an instance of your bitmap font:
- * var myFont = new me.BitmapText(x, y, {font:"arial", text:"Hello"});
- * // two possibilities for using "myFont"
- * // either call the draw function from your Renderable draw function
- * myFont.draw(renderer, "Hello!", 0, 0);
- * // or just add it to the word container
- * me.game.world.addChild(myFont);
+ * @augments Renderable
  */
-
 class BitmapText extends Renderable {
-
-    /** @ignore */
+    /**
+     * @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 {Color|string} [settings.fillStyle] a CSS color value used to tint the bitmapText (@see 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 {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
+     * @example
+     * // Use me.loader.preload or me.loader.load to load assets
+     * me.loader.preload([
+     *     { name: "arial", type: "binary" src: "data/font/arial.fnt" },
+     *     { name: "arial", type: "image" src: "data/font/arial.png" },
+     * ])
+     * // Then create an instance of your bitmap font:
+     * var myFont = new me.BitmapText(x, y, {font:"arial", text:"Hello"});
+     * // two possibilities for using "myFont"
+     * // either call the draw function from your Renderable draw function
+     * myFont.draw(renderer, "Hello!", 0, 0);
+     * // or just add it to the word container
+     * me.game.world.addChild(myFont);
+     */
     constructor(x, y, settings) {
         // call the parent constructor
         super(x, y, settings.width || 0, settings.height || 0);
@@ -79,7 +76,7 @@ class BitmapText extends Renderable {
          * @type {string}
          * @default "left"
          * @name textAlign
-         * @memberof me.BitmapText
+         * @memberof BitmapText
          */
         this.textAlign = settings.textAlign || "left";
 
@@ -90,7 +87,7 @@ class BitmapText extends Renderable {
          * @type {string}
          * @default "top"
          * @name textBaseline
-         * @memberof me.BitmapText
+         * @memberof BitmapText
          */
         this.textBaseline = settings.textBaseline || "top";
 
@@ -101,27 +98,33 @@ class BitmapText extends Renderable {
          * @type {number}
          * @default 1.0
          * @name lineHeight
-         * @memberof me.BitmapText
+         * @memberof BitmapText
          */
         this.lineHeight = settings.lineHeight || 1.0;
 
         /**
          * the text to be displayed
          * @private
-         * @type {string[]}
-         * @name _text
-         * @memberof me.BitmapText
          */
         this._text = [];
 
-        /** @ignore */
-        // scaled font size;
+        /**
+         * scaled font size
+         * @private
+         */
         this.fontScale = pool.pull("Vector2d", 1.0, 1.0);
 
-        // get the corresponding image
+        /**
+         * font image
+         * @private
+         */
         this.fontImage = (typeof settings.font === "object") ? settings.font : loader.getImage(settings.font);
 
         if (typeof settings.fontData !== "string") {
+            /**
+             * font data
+             * @private
+             */
             // use settings.font to retreive the data from the loader
             this.fontData = pool.pull("BitmapTextData", loader.getBinary(settings.font));
         } else {
@@ -165,11 +168,11 @@ class BitmapText extends Renderable {
     /**
      * change the font settings
      * @name set
-     * @memberof me.BitmapText.prototype
+     * @memberof BitmapText.prototype
      * @function
      * @param {string} textAlign ("left", "center", "right")
      * @param {number} [scale]
-     * @returns {me.BitmapText} this object for chaining
+     * @returns {BitmapText} this object for chaining
      */
     set(textAlign, scale) {
         this.textAlign = textAlign;
@@ -185,10 +188,10 @@ class BitmapText extends Renderable {
     /**
      * change the text to be displayed
      * @name setText
-     * @memberof me.BitmapText.prototype
+     * @memberof BitmapText.prototype
      * @function
      * @param {number|string|string[]} value a string, or an array of strings
-     * @returns {me.BitmapText} this object for chaining
+     * @returns {BitmapText} this object for chaining
      */
     setText(value) {
         if (typeof value === "undefined") {
@@ -210,10 +213,10 @@ class BitmapText extends Renderable {
     /**
      * defines the color used to tint the bitmap text
      * @public
-     * @type {me.Color}
+     * @type {Color}
      * @name fillStyle
-     * @see me.Renderable#tint
-     * @memberof me.BitmapText
+     * @see Renderable#tint
+     * @memberof BitmapText
      */
     get fillStyle() {
         return this.tint;
@@ -225,10 +228,10 @@ class BitmapText extends Renderable {
     /**
      * change the font display size
      * @name resize
-     * @memberof me.BitmapText.prototype
+     * @memberof BitmapText.prototype
      * @function
      * @param {number} scale ratio
-     * @returns {me.BitmapText} this object for chaining
+     * @returns {BitmapText} this object for chaining
      */
     resize(scale) {
         this.fontScale.set(scale, scale);
@@ -241,10 +244,10 @@ class BitmapText extends Renderable {
     /**
      * measure the given text size in pixels
      * @name measureText
-     * @memberof me.BitmapText.prototype
+     * @memberof BitmapText.prototype
      * @function
      * @param {string} [text]
-     * @param {me.Rect} [ret] a object in which to store the text metrics
+     * @param {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
      */
     measureText(text, ret) {
@@ -276,9 +279,9 @@ class BitmapText extends Renderable {
     /**
      * draw the bitmap font
      * @name draw
-     * @memberof me.BitmapText.prototype
+     * @memberof BitmapText.prototype
      * @function
-     * @param {me.CanvasRenderer|me.WebGLRenderer} renderer Reference to the destination renderer instance
+     * @param {CanvasRenderer|WebGLRenderer} renderer Reference to the destination renderer instance
      * @param {string} [text]
      * @param {number} [x]
      * @param {number} [y]

package/src/text/bitmaptextdata.js

@@ -20,10 +20,10 @@ function getValueFromPair(string, pattern) {
  * Gets the first glyph in the map that is not a space character
  * @ignore
  * @name _getFirstGlyph
- * @memberof me.BitmapTextData
+ * @memberof BitmapTextData
  * @function
  * @param {object} glyphs the map of glyphs, each key is a char code
- * @returns {me.Glyph}
+ * @returns {Glyph}
  */
 function getFirstGlyph(glyphs) {
     var keys = Object.keys(glyphs);
@@ -39,7 +39,7 @@ function getFirstGlyph(glyphs) {
  * Creates a glyph to use for the space character
  * @ignore
  * @name createSpaceGlyph
- * @memberof me.BitmapTextData
+ * @memberof BitmapTextData
  * @function
  * @param {object} glyphs the map of glyphs, each key is a char code
  */
@@ -58,15 +58,15 @@ function createSpaceGlyph(glyphs) {
 
 /**
  * Class for storing relevant data from the font file.
- * @class me.BitmapTextData
- * @memberof me
  * @ignore
- * @param data {string} - The bitmap font data pulled from the resource loader using me.loader.getBinary()
  */
 class BitmapTextData {
 
-    constructor(...args) {
-        this.onResetEvent(...args);
+   /**
+    * @param {string} data - The bitmap font data pulled from the resource loader using me.loader.getBinary()
+    */
+    constructor(data) {
+        this.onResetEvent(data);
     }
 
     /**
@@ -88,7 +88,7 @@ class BitmapTextData {
          * The map of glyphs, each key is a char code.
          * @name glyphs
          * @type {object}
-         * @memberof me.BitmapTextData
+         * @memberof BitmapTextData
          */
         this.glyphs = {};
 
@@ -99,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 BitmapTextData
      * @function
      * @param {string} fontData
      */

package/src/text/glyph.js

@@ -8,6 +8,9 @@ var PAGE_SIZE = 1 << LOG2_PAGE_SIZE;
  * @ignore
  */
 class Glyph {
+    /**
+     * @ignore
+     */
     constructor() {
         this.id = 0;
         this.x = 0;

package/src/text/text.js

@@ -37,29 +37,27 @@ var setContextStyle = function(context, font, stroke = false) {
 /**
  * @classdesc
  * a generic system font object.
- * @class Text
- * @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} settings.font a CSS family font name
- * @param {number|string} settings.size size, or size + suffix (px, em, pt)
- * @param {me.Color|string} [settings.fillStyle="#000000"] a CSS color value
- * @param {me.Color|string} [settings.strokeStyle="#000000"] a CSS color value
- * @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 {boolean} [settings.offScreenCanvas=false] whether to draw the font to an individual "cache" texture first
- * @param {(string|string[])} [settings.text=""] a string, or an array of strings
- * @example
- * var font = new me.Text(0, 0, {font: "Arial", size: 8, fillStyle: this.color});
+ * @augments Renderable
  */
 class Text extends Renderable {
-
-    /** @ignore */
+    /**
+     * @param {number} x position of the text object
+     * @param {number} y position of the text object
+     * @param {object} settings the text configuration
+     * @param {string} settings.font a CSS family font name
+     * @param {number|string} settings.size size, or size + suffix (px, em, pt)
+     * @param {Color|string} [settings.fillStyle="#000000"] a CSS color value
+     * @param {Color|string} [settings.strokeStyle="#000000"] a CSS color value
+     * @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 {Vector2d} [settings.anchorPoint={x:0.0, y:0.0}] anchor point to draw the text at
+     * @param {boolean} [settings.offScreenCanvas=false] whether to draw the font to an individual "cache" texture first
+     * @param {(string|string[])} [settings.text=""] a string, or an array of strings
+     * @example
+     * var font = new me.Text(0, 0, {font: "Arial", size: 8, fillStyle: this.color});
+     */
     constructor(x, y, settings) {
         // call the parent constructor
         super(x, y, settings.width || 0, settings.height || 0);
@@ -72,9 +70,9 @@ class Text extends Renderable {
         /**
          * defines the color used to draw the font.<br>
          * @public
-         * @type {me.Color}
+         * @type {Color}
          * @default black
-         * @name me.Text#fillStyle
+         * @name Text#fillStyle
          */
         if (typeof settings.fillStyle !== "undefined") {
             if (settings.fillStyle instanceof Color) {
@@ -90,9 +88,9 @@ class Text extends Renderable {
         /**
          * defines the color used to draw the font stroke.<br>
          * @public
-         * @type {me.Color}
+         * @type {Color}
          * @default black
-         * @name me.Text#strokeStyle
+         * @name Text#strokeStyle
          */
          if (typeof settings.strokeStyle !== "undefined") {
              if (settings.strokeStyle instanceof Color) {
@@ -110,7 +108,7 @@ class Text extends Renderable {
          * @public
          * @type {number}
          * @default 1
-         * @name me.Text#lineWidth
+         * @name Text#lineWidth
          */
         this.lineWidth = settings.lineWidth || 1;
 
@@ -120,7 +118,7 @@ class Text extends Renderable {
          * @public
          * @type {string}
          * @default "left"
-         * @name me.Text#textAlign
+         * @name Text#textAlign
          */
         this.textAlign = settings.textAlign || "left";
 
@@ -130,7 +128,7 @@ class Text extends Renderable {
          * @public
          * @type {string}
          * @default "top"
-         * @name me.Text#textBaseline
+         * @name Text#textBaseline
          */
         this.textBaseline = settings.textBaseline || "top";
 
@@ -140,7 +138,7 @@ class Text extends Renderable {
          * @public
          * @type {number}
          * @default 1.0
-         * @name me.Text#lineHeight
+         * @name Text#lineHeight
          */
         this.lineHeight = settings.lineHeight || 1.0;
 
@@ -151,16 +149,13 @@ class Text extends Renderable {
          * @public
          * @type {boolean}
          * @default false
-         * @name me.Text#offScreenCanvas
+         * @name Text#offScreenCanvas
          */
         this.offScreenCanvas = false;
 
         /**
          * the text to be displayed
          * @private
-         * @type {string[]}
-         * @name _text
-         * @memberof me.Text
          */
         this._text = [];
 
@@ -170,7 +165,7 @@ class Text extends Renderable {
          * @type {number}
          * @name fontSize
          * @default 10
-         * @memberof me.Text
+         * @memberof Text
          */
         this.fontSize = 10;
 
@@ -226,9 +221,9 @@ class Text extends Renderable {
     /**
      * make the font bold
      * @name bold
-     * @memberof me.Text.prototype
+     * @memberof Text.prototype
      * @function
-     * @returns {me.Text} this object for chaining
+     * @returns {Text} this object for chaining
      */
     bold() {
         this.font = "bold " + this.font;
@@ -239,9 +234,9 @@ class Text extends Renderable {
     /**
      * make the font italic
      * @name italic
-     * @memberof me.Text.prototype
+     * @memberof Text.prototype
      * @function
-     * @returns {me.Text} this object for chaining
+     * @returns {Text} this object for chaining
      */
     italic() {
         this.font = "italic " + this.font;
@@ -252,11 +247,11 @@ class Text extends Renderable {
     /**
      * set the font family and size
      * @name setFont
-     * @memberof me.Text.prototype
+     * @memberof Text.prototype
      * @function
      * @param {string} font a CSS font name
      * @param {number|string} [size=10] size in px, or size + suffix (px, em, pt)
-     * @returns {me.Text} this object for chaining
+     * @returns {Text} this object for chaining
      * @example
      * font.setFont("Arial", 20);
      * font.setFont("Arial", "1.5em");
@@ -296,10 +291,10 @@ class Text extends Renderable {
     /**
      * change the text to be displayed
      * @name setText
-     * @memberof me.Text.prototype
+     * @memberof Text.prototype
      * @function
      * @param {number|string|string[]} value a string, or an array of strings
-     * @returns {me.Text} this object for chaining
+     * @returns {Text} this object for chaining
      */
     setText(value = "") {
         if (this._text.toString() !== value.toString()) {
@@ -317,11 +312,11 @@ class Text extends Renderable {
     /**
      * measure the given text size in pixels
      * @name measureText
-     * @memberof me.Text.prototype
+     * @memberof Text.prototype
      * @function
-     * @param {me.CanvasRenderer|me.WebGLRenderer} [renderer] reference to the active renderer
+     * @param {CanvasRenderer|WebGLRenderer} [renderer] reference to the active renderer
      * @param {string} [text] the text to be measured
-     * @param {me.Rect|me.Bounds} [ret] a object in which to store the text metrics
+     * @param {Rect|Bounds} [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
      */
     measureText(renderer, text, ret) {
@@ -406,9 +401,9 @@ class Text extends Renderable {
     /**
      * draw a text at the specified coord
      * @name draw
-     * @memberof me.Text.prototype
+     * @memberof Text.prototype
      * @function
-     * @param {me.CanvasRenderer|me.WebGLRenderer} renderer Reference to the destination renderer instance
+     * @param {CanvasRenderer|WebGLRenderer} renderer Reference to the destination renderer instance
      * @param {string} [text]
      * @param {number} [x]
      * @param {number} [y]
@@ -472,9 +467,9 @@ class Text extends Renderable {
      * by the `lineWidth` and `fillStroke` properties. <br>
      * Note : using drawStroke is not recommended for performance reasons
      * @name drawStroke
-     * @memberof me.Text.prototype
+     * @memberof Text.prototype
      * @function
-     * @param {me.CanvasRenderer|me.WebGLRenderer} renderer Reference to the destination renderer instance
+     * @param {CanvasRenderer|WebGLRenderer} renderer Reference to the destination renderer instance
      * @param {string} text
      * @param {number} x
      * @param {number} y

package/src/tweens/easing.js

@@ -44,7 +44,7 @@
  * @constant
  * @enum {Function}
  * @name Easing
- * @memberof me.Tween
+ * @memberof Tween
  */
 export let Easing = {
 

package/src/tweens/interpolation.js

@@ -14,7 +14,7 @@
  * @constant
  * @enum {Function}
  * @name Interpolation
- * @memberof me.Tween
+ * @memberof Tween
  */
 export let Interpolation = {
     /** @ignore */