melonjs 10.1.1 → 10.2.3

package/src/math/color.js

@@ -175,10 +175,10 @@ var cssToRGB = new Map();
  * @class Color
  * @memberOf me
  * @constructor
- * @param {Number|Float32Array} [r=0] red component or array of color components
- * @param {Number} [g=0] green component
- * @param {Number} [b=0] blue component
- * @param {Number} [alpha=1.0] alpha value
+ * @param {number|Float32Array} [r=0] red component or array of color components
+ * @param {number} [g=0] green component
+ * @param {number} [b=0] blue component
+ * @param {number} [alpha=1.0] alpha value
  */
 class Color {
 
@@ -203,21 +203,16 @@ class Color {
 
     /**
      * Color Red Component [0 .. 255]
-     * @type Number
+     * @type {number}
      * @name r
      * @readonly
      * @memberOf me.Color
      */
 
-    /**
-     * @ignore
-     */
     get r() {
         return ~~(this.glArray[0] * 255);
     }
-    /**
-     * @ignore
-     */
+
     set r(value) {
         this.glArray[0] = clamp(~~value || 0, 0, 255) / 255.0;
     }
@@ -225,21 +220,16 @@ class Color {
 
     /**
      * Color Green Component [0 .. 255]
-     * @type Number
+     * @type {number}
      * @name g
      * @readonly
      * @memberOf me.Color
      */
 
-    /**
-     * @ignore
-     */
     get g() {
         return ~~(this.glArray[1] * 255);
     }
-    /**
-     * @ignore
-     */
+
     set g(value) {
         this.glArray[1] = clamp(~~value || 0, 0, 255) / 255.0;
     }
@@ -247,41 +237,32 @@ class Color {
 
     /**
      * Color Blue Component [0 .. 255]
-     * @type Number
+     * @type {number}
      * @name b
      * @readonly
      * @memberOf me.Color
      */
-    /**
-     * @ignore
-     */
+
     get b() {
         return ~~(this.glArray[2] * 255);
     }
-    /**
-     * @ignore
-     */
+
     set b(value) {
         this.glArray[2] = clamp(~~value || 0, 0, 255) / 255.0;
     }
 
     /**
      * Color Alpha Component [0.0 .. 1.0]
-     * @type Number
+     * @type {number}
      * @name alpha
      * @readonly
      * @memberOf me.Color
      */
 
-    /**
-     * @ignore
-     */
     get alpha() {
         return this.glArray[3];
     }
-    /**
-     * @ignore
-     */
+
     set alpha(value) {
         this.glArray[3] = typeof(value) === "undefined" ? 1.0 : clamp(+value, 0, 1.0);
     }
@@ -292,11 +273,11 @@ class Color {
      * @name setColor
      * @memberOf me.Color
      * @function
-     * @param {Number} r red component [0 .. 255]
-     * @param {Number} g green component [0 .. 255]
-     * @param {Number} b blue component [0 .. 255]
-     * @param {Number} [alpha=1.0] alpha value [0.0 .. 1.0]
-     * @return {me.Color} Reference to this object for method chaining
+     * @param {number} r red component [0 .. 255]
+     * @param {number} g green component [0 .. 255]
+     * @param {number} b blue component [0 .. 255]
+     * @param {number} [alpha=1.0] alpha value [0.0 .. 1.0]
+     * @returns {me.Color} Reference to this object for method chaining
      */
     setColor(r, g, b, alpha = 1.0) {
         // Private initialization: copy Color value directly
@@ -316,7 +297,7 @@ class Color {
      * @name clone
      * @memberOf me.Color
      * @function
-     * @return {me.Color} Reference to the newly cloned object
+     * @returns {me.Color} Reference to the newly cloned object
      */
     clone() {
         return pool.pull("Color", this);
@@ -327,8 +308,8 @@ class Color {
      * @name copy
      * @memberOf me.Color
      * @function
-     * @param {me.Color|String} color
-     * @return {me.Color} Reference to this object for method chaining
+     * @param {me.Color|string} color
+     * @returns {me.Color} Reference to this object for method chaining
      */
     copy(color) {
         if (color instanceof Color) {
@@ -345,7 +326,7 @@ class Color {
      * @memberOf me.Color
      * @function
      * @param {me.Color} color
-     * @return {me.Color} Reference to this object for method chaining
+     * @returns {me.Color} Reference to this object for method chaining
      */
     add(color) {
         this.glArray[0] = clamp(this.glArray[0] + color.glArray[0], 0, 1);
@@ -361,8 +342,8 @@ class Color {
      * @name darken
      * @memberOf me.Color
      * @function
-     * @param {Number} scale
-     * @return {me.Color} Reference to this object for method chaining
+     * @param {number} scale
+     * @returns {me.Color} Reference to this object for method chaining
      */
     darken(scale) {
         scale = clamp(scale, 0, 1);
@@ -379,8 +360,8 @@ class Color {
      * @memberOf me.Color
      * @function
      * @param {me.Color} color
-     * @param {Number} alpha with alpha = 0 being this color, and alpha = 1 being the given one.
-     * @return {me.Color} Reference to this object for method chaining
+     * @param {number} alpha with alpha = 0 being this color, and alpha = 1 being the given one.
+     * @returns {me.Color} Reference to this object for method chaining
      */
     lerp(color, alpha) {
         alpha = clamp(alpha, 0, 1);
@@ -396,8 +377,8 @@ class Color {
      * @name lighten
      * @memberOf me.Color
      * @function
-     * @param {Number} scale
-     * @return {me.Color} Reference to this object for method chaining
+     * @param {number} scale
+     * @returns {me.Color} Reference to this object for method chaining
      */
     lighten(scale) {
         scale = clamp(scale, 0, 1);
@@ -413,9 +394,9 @@ class Color {
      * @name random
      * @memberOf me.Color
      * @function
-     * @param {Number} [min=0] minimum value for the random range
-     * @param {Number} [max=255] maxmium value for the random range
-     * @return {me.Color} Reference to this object for method chaining
+     * @param {number} [min=0] minimum value for the random range
+     * @param {number} [max=255] maxmium value for the random range
+     * @returns {me.Color} Reference to this object for method chaining
      */
     random(min = 0, max = 255) {
         if (min < 0) {
@@ -440,7 +421,7 @@ class Color {
      * @memberOf me.Color
      * @function
      * @param {me.Color} color
-     * @return {Boolean}
+     * @returns {boolean}
      */
     equals(color) {
         return (
@@ -457,8 +438,8 @@ class Color {
      * @name parseCSS
      * @memberOf me.Color
      * @function
-     * @param {String} color
-     * @return {me.Color} Reference to this object for method chaining
+     * @param {string} cssColor
+     * @returns {me.Color} Reference to this object for method chaining
      */
     parseCSS(cssColor) {
         // TODO : Memoize this function by caching its input
@@ -475,8 +456,8 @@ class Color {
      * @name parseRGB
      * @memberOf me.Color
      * @function
-     * @param {String} color
-     * @return {me.Color} Reference to this object for method chaining
+     * @param {string} rgbColor
+     * @returns {me.Color} Reference to this object for method chaining
      */
     parseRGB(rgbColor) {
         // TODO : Memoize this function by caching its input
@@ -495,9 +476,9 @@ class Color {
      * @name parseHex
      * @memberOf me.Color
      * @function
-     * @param {String} color
+     * @param {string} hexColor
      * @param {boolean} [argb = false] true if format is #ARGB, or #AARRGGBB (as opposed to #RGBA or #RGGBBAA)
-     * @return {me.Color} Reference to this object for method chaining
+     * @returns {me.Color} Reference to this object for method chaining
      */
     parseHex(hexColor, argb = false) {
         // TODO : Memoize this function by caching its input
@@ -555,8 +536,8 @@ class Color {
      * @name toUint32
      * @memberOf me.Color
      * @function
-     * @param {Number} [alpha=1.0] alpha value [0.0 .. 1.0]
-     * @return {Uint32}
+     * @param {number} [alpha=1.0] alpha value [0.0 .. 1.0]
+     * @returns {Uint32}
      */
     toUint32(alpha = this.alpha) {
         var ur = this.r & 0xff;
@@ -572,7 +553,7 @@ class Color {
      * @name toArray
      * @memberOf me.Color
      * @function
-     * @return {Float32Array}
+     * @returns {Float32Array}
      */
     toArray() {
         return this.glArray;
@@ -584,7 +565,7 @@ class Color {
      * @name toHex
      * @memberOf me.Color
      * @function
-     * @return {String}
+     * @returns {string}
      */
     toHex() {
         // TODO : Memoize this function by caching its result until any of
@@ -598,7 +579,7 @@ class Color {
      * @name toHex8
      * @memberOf me.Color
      * @function
-     * @return {String}
+     * @returns {string}
      */
     toHex8() {
         // TODO : Memoize this function by caching its result until any of
@@ -612,7 +593,7 @@ class Color {
      * @name toRGB
      * @memberOf me.Color
      * @function
-     * @return {String}
+     * @returns {string}
      */
     toRGB() {
         // TODO : Memoize this function by caching its result until any of
@@ -630,7 +611,7 @@ class Color {
      * @name toRGBA
      * @memberOf me.Color
      * @function
-     * @return {String}
+     * @returns {string}
      */
     toRGBA() {
         // TODO : Memoize this function by caching its result until any of

package/src/math/math.js

@@ -7,7 +7,7 @@
 /**
  * constant to convert from degrees to radians
  * @public
- * @type {Number}
+ * @type {number}
  * @name DEG_TO_RAD
  * @memberOf me.Math
  */
@@ -16,7 +16,7 @@ export const DEG_TO_RAD = Math.PI / 180.0;
 /**
  * constant to convert from radians to degrees
  * @public
- * @type {Number}
+ * @type {number}
  * @name RAD_TO_DEG
  * @memberOf me.Math
  */
@@ -25,7 +25,7 @@ export const RAD_TO_DEG = 180.0 / Math.PI;
 /**
  * constant equals to 2 times pi
  * @public
- * @type {Number}
+ * @type {number}
  * @name TAU
  * @memberOf me.Math
  */
@@ -34,7 +34,7 @@ export const TAU = Math.PI * 2;
 /**
  * constant equals to half pi
  * @public
- * @type {Number}
+ * @type {number}
  * @name ETA
  * @memberOf me.Math
  */
@@ -43,7 +43,7 @@ export const ETA = Math.PI * 0.5;
 /**
  * the difference between 1 and the smallest floating point number greater than 1
  * @public
- * @type {Number}
+ * @type {number}
  * @name EPSILON
  * @memberOf me.Math
  */
@@ -55,8 +55,8 @@ export const EPSILON = 0.000001;
  * @function
  * @memberOf me.Math
  * @name isPowerOfTwo
- * @param {Number} val
- * @return {boolean}
+ * @param {number} val
+ * @returns {boolean}
  */
 export function isPowerOfTwo(val) {
     return (val & (val - 1)) === 0;
@@ -68,8 +68,8 @@ export function isPowerOfTwo(val) {
  * @function
  * @memberOf me.Math
  * @name nextPowerOfTwo
- * @param {Number} val
- * @return {boolean}
+ * @param {number} val
+ * @returns {boolean}
  */
 export function nextPowerOfTwo(val) {
     val --;
@@ -89,7 +89,7 @@ export function nextPowerOfTwo(val) {
  * @memberOf me.Math
  * @name degToRad
  * @param {number} angle angle in degrees
- * @return {number} corresponding angle in radians
+ * @returns {number} corresponding angle in radians
  * @example
  * // convert a specific angle
  * me.Math.degToRad(60); // return 1.0471...
@@ -105,7 +105,7 @@ export function degToRad(angle) {
  * @memberOf me.Math
  * @name radToDeg
  * @param {number} radians angle in radians
- * @return {number} corresponding angle in degrees
+ * @returns {number} corresponding angle in degrees
  * @example
  * // convert a specific angle
  * me.Math.radToDeg(1.0471975511965976); // return 60
@@ -123,7 +123,7 @@ export function radToDeg(radians) {
  * @param {number} val the value to clamp
  * @param {number} low lower limit
  * @param {number} high higher limit
- * @return {number} clamped value
+ * @returns {number} clamped value
  */
 export function clamp(val, low, high) {
     return val < low ? low : val > high ? high : +val;
@@ -137,7 +137,7 @@ export function clamp(val, low, high) {
  * @name random
  * @param {number} min minimum value.
  * @param {number} max maximum value.
- * @return {number} random value
+ * @returns {number} random value
  * @example
  * // Print a random number; one of 5, 6, 7, 8, 9
  * console.log(me.Math.random(5, 10) );
@@ -154,7 +154,7 @@ export function random(min, max) {
  * @name randomFloat
  * @param {number} min minimum value.
  * @param {number} max maximum value.
- * @return {number} random value
+ * @returns {number} random value
  * @example
  * // Print a random number; one of 5, 6, 7, 8, 9
  * console.log(me.Math.randomFloat(5, 10) );
@@ -171,7 +171,7 @@ export function randomFloat(min, max) {
  * @name weightedRandom
  * @param {number} min minimum value.
  * @param {number} max maximum value.
- * @return {number} random value
+ * @returns {number} random value
  * @example
  * // Print a random number; one of 5, 6, 7, 8, 9
  * console.log(me.Math.weightedRandom(5, 10) );
@@ -188,7 +188,7 @@ export function weightedRandom(min, max) {
  * @name round
  * @param {number} num value to be rounded.
  * @param {number} [dec=0] number of decimal digit to be rounded to.
- * @return {number} rounded value
+ * @returns {number} rounded value
  * @example
  * // round a specific value to 2 digits
  * me.Math.round(10.33333, 2); // return 10.33
@@ -208,7 +208,7 @@ export function round(num, dec = 0) {
  * @param {number} expected value to be compared with.
  * @param {number} actual actual value to compare
  * @param {number} [precision=2] float precision for the comparison
- * @return {boolean} if close to
+ * @returns {boolean} if close to
  * @example
  * // test if the given value is close to 10
  * if (me.Math.toBeCloseTo(10, value)) {

package/src/math/matrix2.js

@@ -10,7 +10,7 @@ import Matrix3d from "./matrix3.js";
  * @memberOf me
  * @constructor
  * @param {me.Matrix2d} [mat2d] An instance of me.Matrix2d to copy from
- * @param {Number[]} [arguments...] Matrix elements. See {@link me.Matrix2d.setTransform}
+ * @param {number[]} [arguments...] Matrix elements. See {@link me.Matrix2d.setTransform}
  */
 
 class Matrix2d {
@@ -45,7 +45,7 @@ class Matrix2d {
     /**
      * tx component of the matrix
      * @public
-     * @type {Number}
+     * @type {number}
      * @readonly
      * @see me.Matrix2d.translate
      * @name tx
@@ -58,7 +58,7 @@ class Matrix2d {
     /**
      * ty component of the matrix
      * @public
-     * @type {Number}
+     * @type {number}
      * @readonly
      * @see me.Matrix2d.translate
      * @name ty
@@ -75,7 +75,7 @@ class Matrix2d {
      * @name identity
      * @memberOf me.Matrix2d
      * @function
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     identity() {
         this.setTransform(
@@ -91,16 +91,16 @@ class Matrix2d {
      * @name setTransform
      * @memberOf me.Matrix2d
      * @function
-     * @param {Number} a
-     * @param {Number} b
-     * @param {Number} c
-     * @param {Number} d
-     * @param {Number} e
-     * @param {Number} f
-     * @param {Number} [g=0]
-     * @param {Number} [h=0]
-     * @param {Number} [i=1]
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @param {number} a
+     * @param {number} b
+     * @param {number} c
+     * @param {number} d
+     * @param {number} e
+     * @param {number} f
+     * @param {number} [g=0]
+     * @param {number} [h=0]
+     * @param {number} [i=1]
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     setTransform() {
         var a = this.val;
@@ -136,10 +136,10 @@ class Matrix2d {
      * @memberOf me.Matrix2d
      * @function
      * @param {me.Matrix2d} m the matrix object to copy from
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
-    copy(b) {
-        this.val.set(b.val);
+    copy(m) {
+        this.val.set(m.val);
         return this;
     }
 
@@ -149,7 +149,7 @@ class Matrix2d {
      * @memberOf me.Matrix2d
      * @function
      * @param {me.Matrix3d} m the matrix object to copy from
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     fromMat3d(m) {
         var b = m.val;
@@ -174,7 +174,7 @@ class Matrix2d {
      * @memberOf me.Matrix2d
      * @function
      * @param {me.Matrix2d} m the other matrix
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     multiply(m) {
         var b = m.val;
@@ -205,7 +205,7 @@ class Matrix2d {
      * @name transpose
      * @memberOf me.Matrix2d
      * @function
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     transpose() {
         var a = this.val,
@@ -228,7 +228,7 @@ class Matrix2d {
      * @name invert
      * @memberOf me.Matrix2d
      * @function
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     invert() {
         var val = this.val;
@@ -263,8 +263,8 @@ class Matrix2d {
     * @name apply
     * @memberOf me.Matrix2d
     * @function
-    * @param {me.Vector2d} vector the vector object to be transformed
-    * @return {me.Vector2d} result vector object.
+    * @param {me.Vector2d} v the vector object to be transformed
+    * @returns {me.Vector2d} result vector object.
     */
     apply(v) {
         var a = this.val,
@@ -282,8 +282,8 @@ class Matrix2d {
      * @name applyInverse
      * @memberOf me.Matrix2d
      * @function
-     * @param {me.Vector2d} vector the vector object to be transformed
-     * @return {me.Vector2d} result vector object.
+     * @param {me.Vector2d} v the vector object to be transformed
+     * @returns {me.Vector2d} result vector object.
      */
     applyInverse(v) {
         var a = this.val,
@@ -303,9 +303,9 @@ class Matrix2d {
      * @name scale
      * @memberOf me.Matrix2d
      * @function
-     * @param {Number} x a number representing the abscissa of the scaling vector.
-     * @param {Number} [y=x] a number representing the ordinate of the scaling vector.
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @param {number} x a number representing the abscissa of the scaling vector.
+     * @param {number} [y=x] a number representing the ordinate of the scaling vector.
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     scale(x, y) {
         var a = this.val,
@@ -325,8 +325,8 @@ class Matrix2d {
      * @name scaleV
      * @memberOf me.Matrix2d
      * @function
-     * @param {me.Vector2d} vector scaling vector
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @param {me.Vector2d} v scaling vector
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     scaleV(v) {
         return this.scale(v.x, v.y);
@@ -337,8 +337,8 @@ class Matrix2d {
      * @name scaleX
      * @memberOf me.Matrix2d
      * @function
-     * @param {Number} x x scaling vector
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @param {number} x x scaling vector
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     scaleX(x) {
         return this.scale(x, 1);
@@ -349,8 +349,8 @@ class Matrix2d {
      * @name scaleY
      * @memberOf me.Matrix2d
      * @function
-     * @param {Number} y y scaling vector
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @param {number} y y scaling vector
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     scaleY(y) {
         return this.scale(1, y);
@@ -361,8 +361,8 @@ class Matrix2d {
      * @name rotate
      * @memberOf me.Matrix2d
      * @function
-     * @param {Number} angle Rotation angle in radians.
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @param {number} angle Rotation angle in radians.
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     rotate(angle) {
         if (angle !== 0) {
@@ -392,9 +392,9 @@ class Matrix2d {
      * @name translate
      * @memberOf me.Matrix2d
      * @function
-     * @param {Number} x the x coordindates to translate the matrix by
-     * @param {Number} y the y coordindates to translate the matrix by
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @param {number} x the x coordindates to translate the matrix by
+     * @param {number} y the y coordindates to translate the matrix by
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     /**
      * translate the matrix by a vector on the horizontal and vertical axis
@@ -402,7 +402,7 @@ class Matrix2d {
      * @memberOf me.Matrix2d
      * @function
      * @param {me.Vector2d} v the vector to translate the matrix by
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     translate() {
         var a = this.val;
@@ -429,8 +429,8 @@ class Matrix2d {
      * @name isIdentity
      * @memberOf me.Matrix2d
      * @function
-     * @return {Boolean}
-     **/
+     * @returns {boolean}
+     */
     isIdentity() {
         var a = this.val;
 
@@ -453,7 +453,7 @@ class Matrix2d {
      * @memberOf me.Matrix2d
      * @function
      * @param {me.Matrix2d} m the other matrix
-     * @return {Boolean} true if both are equals
+     * @returns {boolean} true if both are equals
      */
     equals(m) {
         var b = m.val;
@@ -477,7 +477,7 @@ class Matrix2d {
      * @name clone
      * @memberOf me.Matrix2d
      * @function
-     * @return {me.Matrix2d}
+     * @returns {me.Matrix2d}
      */
     clone() {
         return pool.pull("Matrix2d", this);
@@ -488,7 +488,7 @@ class Matrix2d {
      * @name toArray
      * @memberOf me.Matrix2d
      * @function
-     * @return {Float32Array}
+     * @returns {Float32Array}
      */
     toArray() {
         return this.val;
@@ -499,7 +499,7 @@ class Matrix2d {
      * @name toString
      * @memberOf me.Matrix2d
      * @function
-     * @return {String}
+     * @returns {string}
      */
     toString() {
         var a = this.val;