melonjs 10.1.1 → 10.2.3

package/src/math/vector2.js

@@ -7,8 +7,8 @@ import pool from "./../system/pooling.js";
  * @class Vector2d
  * @memberOf me
  * @constructor
- * @param {Number} [x=0] x value of the vector
- * @param {Number} [y=0] y value of the vector
+ * @param {number} [x=0] x value of the vector
+ * @param {number} [y=0] y value of the vector
  */
 class Vector2d {
 
@@ -27,7 +27,8 @@ class Vector2d {
     }
 
     /**
-     * @ignore */
+     * @ignore
+     */
     _set(x, y) {
         this.x = x;
         this.y = y;
@@ -39,9 +40,9 @@ class Vector2d {
      * @name set
      * @memberOf me.Vector2d
      * @function
-     * @param {Number} x
-     * @param {Number} y
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @param {number} x
+     * @param {number} y
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     set(x, y) {
         if (x !== +x || y !== +y) {
@@ -53,7 +54,7 @@ class Vector2d {
         /**
          * x value of the vector
          * @public
-         * @type Number
+         * @type {number}
          * @name x
          * @memberOf me.Vector2d
          */
@@ -62,7 +63,7 @@ class Vector2d {
         /**
          * y value of the vector
          * @public
-         * @type Number
+         * @type {number}
          * @name y
          * @memberOf me.Vector2d
          */
@@ -76,7 +77,7 @@ class Vector2d {
      * @name setZero
      * @memberOf me.Vector2d
      * @function
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     setZero() {
         return this.set(0, 0);
@@ -88,7 +89,7 @@ class Vector2d {
      * @memberOf me.Vector2d
      * @function
      * @param {me.Vector2d} v
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     setV(v) {
         return this._set(v.x, v.y);
@@ -100,7 +101,7 @@ class Vector2d {
      * @memberOf me.Vector2d
      * @function
      * @param {me.Vector2d} v
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     add(v) {
         return this._set(this.x + v.x, this.y + v.y);
@@ -112,7 +113,7 @@ class Vector2d {
      * @memberOf me.Vector2d
      * @function
      * @param {me.Vector2d} v
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     sub(v) {
         return this._set(this.x - v.x, this.y - v.y);
@@ -123,9 +124,9 @@ class Vector2d {
      * @name scale
      * @memberOf me.Vector2d
      * @function
-     * @param {Number} x
-     * @param {Number} [y=x]
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @param {number} x
+     * @param {number} [y=x]
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     scale(x, y) {
         return this._set(this.x * x, this.y * (typeof (y) !== "undefined" ? y : x));
@@ -136,7 +137,7 @@ class Vector2d {
      * @name toIso
      * @memberOf me.Vector2d
      * @function
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     toIso() {
         return this._set(this.x - this.y, (this.x + this.y) * 0.5);
@@ -147,7 +148,7 @@ class Vector2d {
      * @name to2d
      * @memberOf me.Vector2d
      * @function
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     to2d() {
         return this._set(this.y + this.x / 2, this.y - this.x / 2);
@@ -159,7 +160,7 @@ class Vector2d {
      * @memberOf me.Vector2d
      * @function
      * @param {me.Vector2d} v
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     scaleV(v) {
         return this._set(this.x * v.x, this.y * v.y);
@@ -170,8 +171,8 @@ class Vector2d {
      * @name div
      * @memberOf me.Vector2d
      * @function
-     * @param {Number} value
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @param {number} n the value to divide the vector by
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     div(n) {
         return this._set(this.x / n, this.y / n);
@@ -182,7 +183,7 @@ class Vector2d {
      * @name abs
      * @memberOf me.Vector2d
      * @function
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     abs() {
         return this._set((this.x < 0) ? -this.x : this.x, (this.y < 0) ? -this.y : this.y);
@@ -193,9 +194,9 @@ class Vector2d {
      * @name clamp
      * @memberOf me.Vector2d
      * @function
-     * @param {Number} low
-     * @param {Number} high
-     * @return {me.Vector2d} new me.Vector2d
+     * @param {number} low
+     * @param {number} high
+     * @returns {me.Vector2d} new me.Vector2d
      */
     clamp(low, high) {
         return new Vector2d(clamp(this.x, low, high), clamp(this.y, low, high));
@@ -206,9 +207,9 @@ class Vector2d {
      * @name clampSelf
      * @memberOf me.Vector2d
      * @function
-     * @param {Number} low
-     * @param {Number} high
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @param {number} low
+     * @param {number} high
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     clampSelf(low, high) {
         return this._set(clamp(this.x, low, high), clamp(this.y, low, high));
@@ -220,7 +221,7 @@ class Vector2d {
      * @memberOf me.Vector2d
      * @function
      * @param {me.Vector2d} v
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     minV(v) {
         return this._set((this.x < v.x) ? this.x : v.x, (this.y < v.y) ? this.y : v.y);
@@ -232,7 +233,7 @@ class Vector2d {
      * @memberOf me.Vector2d
      * @function
      * @param {me.Vector2d} v
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     maxV(v) {
         return this._set((this.x > v.x) ? this.x : v.x, (this.y > v.y) ? this.y : v.y);
@@ -243,7 +244,7 @@ class Vector2d {
      * @name floor
      * @memberOf me.Vector2d
      * @function
-     * @return {me.Vector2d} new me.Vector2d
+     * @returns {me.Vector2d} new me.Vector2d
      */
     floor() {
         return new Vector2d(Math.floor(this.x), Math.floor(this.y));
@@ -254,7 +255,7 @@ class Vector2d {
      * @name floorSelf
      * @memberOf me.Vector2d
      * @function
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     floorSelf() {
         return this._set(Math.floor(this.x), Math.floor(this.y));
@@ -265,7 +266,7 @@ class Vector2d {
      * @name ceil
      * @memberOf me.Vector2d
      * @function
-     * @return {me.Vector2d} new me.Vector2d
+     * @returns {me.Vector2d} new me.Vector2d
      */
     ceil() {
         return new Vector2d(Math.ceil(this.x), Math.ceil(this.y));
@@ -276,7 +277,7 @@ class Vector2d {
      * @name ceilSelf
      * @memberOf me.Vector2d
      * @function
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     ceilSelf() {
         return this._set(Math.ceil(this.x), Math.ceil(this.y));
@@ -287,7 +288,7 @@ class Vector2d {
      * @name negate
      * @memberOf me.Vector2d
      * @function
-     * @return {me.Vector2d} new me.Vector2d
+     * @returns {me.Vector2d} new me.Vector2d
      */
     negate() {
         return new Vector2d(-this.x, -this.y);
@@ -298,7 +299,7 @@ class Vector2d {
      * @name negateSelf
      * @memberOf me.Vector2d
      * @function
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     negateSelf() {
         return this._set(-this.x, -this.y);
@@ -310,7 +311,7 @@ class Vector2d {
      * @memberOf me.Vector2d
      * @function
      * @param {me.Vector2d} v
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     copy(v) {
         return this._set(v.x, v.y);
@@ -322,16 +323,16 @@ class Vector2d {
      * @memberOf me.Vector2d
      * @function
      * @param {me.Vector2d} v
-     * @return {Boolean}
+     * @returns {boolean}
      */
     /**
      * return true if this vector is equal to the given values
      * @name equals
      * @memberOf me.Vector2d
      * @function
-     * @param {Number} x
-     * @param {Number} y
-     * @return {Boolean}
+     * @param {number} x
+     * @param {number} y
+     * @returns {boolean}
      */
     equals() {
         var _x, _y;
@@ -352,7 +353,7 @@ class Vector2d {
      * @name normalize
      * @memberOf me.Vector2d
      * @function
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     normalize() {
         return this.div(this.length() || 1);
@@ -364,7 +365,7 @@ class Vector2d {
      * @name perp
      * @memberOf me.Vector2d
      * @function
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     perp() {
         return this._set(this.y, -this.x);
@@ -377,7 +378,7 @@ class Vector2d {
      * @function
      * @param {number} angle The angle to rotate (in radians)
      * @param {me.Vector2d|me.ObservableVector2d} [v] an optional point to rotate around
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     rotate(angle, v) {
         var cx = 0;
@@ -403,19 +404,19 @@ class Vector2d {
      * @memberOf me.Vector2d
      * @function
      * @param {me.Vector2d} v
-     * @return {Number} The dot product.
+     * @returns {number} The dot product.
      */
     dotProduct(v) {
         return this.x * v.x + this.y * v.y;
     }
 
    /**
-     * return the square length of this vector
-     * @name length2
-     * @memberOf me.Vector2d
-     * @function
-     * @return {Number} The length^2 of this vector.
-     */
+    * return the square length of this vector
+    * @name length2
+    * @memberOf me.Vector2d
+    * @function
+    * @returns {number} The length^2 of this vector.
+    */
     length2() {
         return this.dotProduct(this);
     }
@@ -425,7 +426,7 @@ class Vector2d {
      * @name length
      * @memberOf me.Vector2d
      * @function
-     * @return {Number} the length of this vector
+     * @returns {number} the length of this vector
      */
     length() {
         return Math.sqrt(this.length2());
@@ -437,8 +438,8 @@ class Vector2d {
      * @memberOf me.Vector2d
      * @function
      * @param {me.Vector2d} v
-     * @param {Number} alpha distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @param {number} alpha distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     lerp(v, alpha) {
         this.x += ( v.x - this.x ) * alpha;
@@ -452,7 +453,7 @@ class Vector2d {
      * @memberOf me.Vector2d
      * @function
      * @param {me.Vector2d} v
-     * @return {Number}
+     * @returns {number}
      */
     distance(v) {
         var dx = this.x - v.x, dy = this.y - v.y;
@@ -465,7 +466,7 @@ class Vector2d {
      * @memberOf me.Vector2d
      * @function
      * @param {me.Vector2d} v
-     * @return {Number} angle in radians
+     * @returns {number} angle in radians
      */
     angle(v) {
         return Math.acos(clamp(this.dotProduct(v) / (this.length() * v.length()), -1, 1));
@@ -477,7 +478,7 @@ class Vector2d {
      * @memberOf me.Vector2d
      * @function
      * @param {me.Vector2d} v The vector to project onto.
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     project(v) {
         return this.scale(this.dotProduct(v) / v.length2());
@@ -490,7 +491,7 @@ class Vector2d {
      * @memberOf me.Vector2d
      * @function
      * @param {me.Vector2d} v The unit vector to project onto.
-     * @return {me.Vector2d} Reference to this object for method chaining
+     * @returns {me.Vector2d} Reference to this object for method chaining
      */
     projectN(v) {
         return this.scale(this.dotProduct(v));
@@ -501,7 +502,7 @@ class Vector2d {
      * @name clone
      * @memberOf me.Vector2d
      * @function
-     * @return {me.Vector2d} new me.Vector2d
+     * @returns {me.Vector2d} new me.Vector2d
      */
     clone() {
         return pool.pull("Vector2d", this.x, this.y);
@@ -512,7 +513,7 @@ class Vector2d {
      * @name toString
      * @memberOf me.Vector2d
      * @function
-     * @return {String}
+     * @returns {string}
      */
     toString() {
         return "x:" + this.x + ",y:" + this.y;