melonjs 14.0.1 → 14.1.0

package/src/math/math.js

@@ -84,7 +84,7 @@ export function nextPowerOfTwo(val) {
  * @public
  * @memberof Math
  * @name degToRad
- * @param {number} angle angle in degrees
+ * @param {number} angle - angle in degrees
  * @returns {number} corresponding angle in radians
  * @example
  * // convert a specific angle
@@ -99,7 +99,7 @@ export function degToRad(angle) {
  * @public
  * @memberof Math
  * @name radToDeg
- * @param {number} radians angle in radians
+ * @param {number} radians - angle in radians
  * @returns {number} corresponding angle in degrees
  * @example
  * // convert a specific angle
@@ -114,9 +114,9 @@ export function radToDeg(radians) {
  * @public
  * @memberof Math
  * @name clamp
- * @param {number} val the value to clamp
- * @param {number} low lower limit
- * @param {number} high higher limit
+ * @param {number} val - the value to clamp
+ * @param {number} low - lower limit
+ * @param {number} high - higher limit
  * @returns {number} clamped value
  */
 export function clamp(val, low, high) {
@@ -128,8 +128,8 @@ export function clamp(val, low, high) {
  * @public
  * @memberof Math
  * @name random
- * @param {number} min minimum value.
- * @param {number} max maximum value.
+ * @param {number} min - minimum value.
+ * @param {number} max - maximum value.
  * @returns {number} random value
  * @example
  * // Print a random number; one of 5, 6, 7, 8, 9
@@ -144,8 +144,8 @@ export function random(min, max) {
  * @public
  * @memberof Math
  * @name randomFloat
- * @param {number} min minimum value.
- * @param {number} max maximum value.
+ * @param {number} min - minimum value.
+ * @param {number} max - maximum value.
  * @returns {number} random value
  * @example
  * // Print a random number; one of 5, 6, 7, 8, 9
@@ -160,8 +160,8 @@ export function randomFloat(min, max) {
  * @public
  * @memberof Math
  * @name weightedRandom
- * @param {number} min minimum value.
- * @param {number} max maximum value.
+ * @param {number} min - minimum value.
+ * @param {number} max - maximum value.
  * @returns {number} random value
  * @example
  * // Print a random number; one of 5, 6, 7, 8, 9
@@ -176,8 +176,8 @@ export function weightedRandom(min, max) {
  * @public
  * @memberof Math
  * @name round
- * @param {number} num value to be rounded.
- * @param {number} [dec=0] number of decimal digit to be rounded to.
+ * @param {number} num - value to be rounded.
+ * @param {number} [dec=0] - number of decimal digit to be rounded to.
  * @returns {number} rounded value
  * @example
  * // round a specific value to 2 digits
@@ -194,9 +194,9 @@ export function round(num, dec = 0) {
  * @public
  * @memberof Math
  * @name toBeCloseTo
- * @param {number} expected value to be compared with.
- * @param {number} actual actual value to compare
- * @param {number} [precision=2] float precision for the comparison
+ * @param {number} expected - value to be compared with.
+ * @param {number} actual - actual value to compare
+ * @param {number} [precision=2] - float precision for the comparison
  * @returns {boolean} if close to
  * @example
  * // test if the given value is close to 10

package/src/math/matrix2.js

@@ -9,7 +9,7 @@ import Matrix3d from "./matrix3.js";
  */
 class Matrix2d {
     /**
-     * @param {(Matrix2d|Matrix3d|...number)} args an instance of me.Matrix2d or me.Matrix3d to copy from, or individual matrix components (See {@link Matrix2d.setTransform}). If not arguments are given, the matrix will be set to Identity.
+     * @param {(Matrix2d|Matrix3d|...number)} args - an instance of me.Matrix2d or me.Matrix3d to copy from, or individual matrix components (See {@link Matrix2d.setTransform}). If not arguments are given, the matrix will be set to Identity.
      */
     constructor(...args) {
         this.onResetEvent(...args);
@@ -126,7 +126,7 @@ class Matrix2d {
      * Copies over the values from another me.Matrix2d.
      * @name copy
      * @memberof Matrix2d
-     * @param {Matrix2d} m the matrix object to copy from
+     * @param {Matrix2d} m - the matrix object to copy from
      * @returns {Matrix2d} Reference to this object for method chaining
      */
     copy(m) {
@@ -138,7 +138,7 @@ class Matrix2d {
      * Copies over the upper-left 3x3 values from the given me.Matrix3d
      * @name fromMat3d
      * @memberof Matrix2d
-     * @param {Matrix3d} m the matrix object to copy from
+     * @param {Matrix3d} m - the matrix object to copy from
      * @returns {Matrix2d} Reference to this object for method chaining
      */
     fromMat3d(m) {
@@ -162,7 +162,7 @@ class Matrix2d {
      * multiply both matrix
      * @name multiply
      * @memberof Matrix2d
-     * @param {Matrix2d} m the other matrix
+     * @param {Matrix2d} m - the other matrix
      * @returns {Matrix2d} Reference to this object for method chaining
      */
     multiply(m) {
@@ -249,7 +249,7 @@ class Matrix2d {
     * apply the current transform to the given 2d or 3d vector
     * @name apply
     * @memberof Matrix2d
-    * @param {Vector2d|Vector3d} v the vector object to be transformed
+    * @param {Vector2d|Vector3d} v - the vector object to be transformed
     * @returns {Vector2d|Vector3d} result vector object.
     */
     apply(v) {
@@ -272,7 +272,7 @@ class Matrix2d {
      * apply the inverted current transform to the given 2d vector
      * @name applyInverse
      * @memberof Matrix2d
-     * @param {Vector2d} v the vector object to be transformed
+     * @param {Vector2d} v - the vector object to be transformed
      * @returns {Vector2d} result vector object.
      */
     applyInverse(v) {
@@ -292,8 +292,8 @@ class Matrix2d {
      * scale the matrix
      * @name scale
      * @memberof Matrix2d
-     * @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.
+     * @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 {Matrix2d} Reference to this object for method chaining
      */
     scale(x, y) {
@@ -313,7 +313,7 @@ class Matrix2d {
      * adds a 2D scaling transformation.
      * @name scaleV
      * @memberof Matrix2d
-     * @param {Vector2d} v scaling vector
+     * @param {Vector2d} v - scaling vector
      * @returns {Matrix2d} Reference to this object for method chaining
      */
     scaleV(v) {
@@ -324,7 +324,7 @@ class Matrix2d {
      * specifies a 2D scale operation using the [sx, 1] scaling vector
      * @name scaleX
      * @memberof Matrix2d
-     * @param {number} x x scaling vector
+     * @param {number} x - x scaling vector
      * @returns {Matrix2d} Reference to this object for method chaining
      */
     scaleX(x) {
@@ -335,7 +335,7 @@ class Matrix2d {
      * specifies a 2D scale operation using the [1,sy] scaling vector
      * @name scaleY
      * @memberof Matrix2d
-     * @param {number} y y scaling vector
+     * @param {number} y - y scaling vector
      * @returns {Matrix2d} Reference to this object for method chaining
      */
     scaleY(y) {
@@ -346,7 +346,7 @@ class Matrix2d {
      * rotate the matrix (counter-clockwise) by the specified angle (in radians).
      * @name rotate
      * @memberof Matrix2d
-     * @param {number} angle Rotation angle in radians.
+     * @param {number} angle - Rotation angle in radians.
      * @returns {Matrix2d} Reference to this object for method chaining
      */
     rotate(angle) {
@@ -377,15 +377,15 @@ class Matrix2d {
      * @name translate
      * @memberof Matrix2d
      * @method
-     * @param {number} x the x coordindates to translate the matrix by
-     * @param {number} y the y coordindates to translate the matrix by
+     * @param {number} x - the x coordindates to translate the matrix by
+     * @param {number} y - the y coordindates to translate the matrix by
      * @returns {Matrix2d} Reference to this object for method chaining
      */
     /**
      * translate the matrix by a vector on the horizontal and vertical axis
      * @name translateV
      * @memberof Matrix2d
-     * @param {Vector2d} v the vector to translate the matrix by
+     * @param {Vector2d} v - the vector to translate the matrix by
      * @returns {Matrix2d} Reference to this object for method chaining
      */
     translate() {
@@ -434,7 +434,7 @@ class Matrix2d {
      * return true if the two matrices are identical
      * @name equals
      * @memberof Matrix2d
-     * @param {Matrix2d} m the other matrix
+     * @param {Matrix2d} m - the other matrix
      * @returns {boolean} true if both are equals
      */
     equals(m) {

package/src/math/matrix3.js

@@ -7,7 +7,7 @@ import { EPSILON } from "./math.js";
  */
 class Matrix3d {
     /**
-     * @param {(Matrix3d|...number)} args An instance of me.Matrix3d to copy from, or individual Matrix components (See {@link Matrix3d.setTransform}). If not arguments are given, the matrix will be set to Identity.
+     * @param {(Matrix3d|...number)} args - An instance of me.Matrix3d to copy from, or individual Matrix components (See {@link Matrix3d.setTransform}). If not arguments are given, the matrix will be set to Identity.
      */
     constructor(...args) {
         this.onResetEvent(...args);
@@ -131,7 +131,7 @@ class Matrix3d {
      * Copies over the values from another me.Matrix3d.
      * @name copy
      * @memberof Matrix3d
-     * @param {Matrix3d} m the matrix object to copy from
+     * @param {Matrix3d} m - the matrix object to copy from
      * @returns {Matrix3d} Reference to this object for method chaining
      */
     copy(m) {
@@ -143,7 +143,7 @@ class Matrix3d {
      * Copies over the upper-left 2x2 values from the given me.Matrix2d
      * @name fromMat2d
      * @memberof Matrix3d
-     * @param {Matrix2d} m the matrix object to copy from
+     * @param {Matrix2d} m - the matrix object to copy from
      * @returns {Matrix2d} Reference to this object for method chaining
      */
     fromMat2d(m) {
@@ -161,7 +161,7 @@ class Matrix3d {
      * multiply both matrix
      * @name multiply
      * @memberof Matrix3d
-     * @param {Matrix3d} m Other matrix
+     * @param {Matrix3d} m - Other matrix
      * @returns {Matrix3d} Reference to this object for method chaining
      */
     multiply(m) {
@@ -306,7 +306,7 @@ class Matrix3d {
      * apply the current transform to the given 2d or 3d vector
      * @name apply
      * @memberof Matrix3d
-     * @param {Vector2d|Vector3d} v the vector object to be transformed
+     * @param {Vector2d|Vector3d} v - the vector object to be transformed
      * @returns {Vector2d|Vector3d} result vector object.
      */
      apply(v) {
@@ -331,7 +331,7 @@ class Matrix3d {
       * apply the inverted current transform to the given 2d or 3d vector
       * @name applyInverse
       * @memberof Matrix3d
-      * @param {Vector2d|Vector3d} v the vector object to be transformed
+      * @param {Vector2d|Vector3d} v - the vector object to be transformed
       * @returns {Vector2d|Vector3d} result vector object.
       */
      applyInverse(v) {
@@ -351,12 +351,12 @@ class Matrix3d {
      * <img src="images/glOrtho.gif"/><br>
      * @name ortho
      * @memberof Matrix3d
-     * @param {number} left farthest left on the x-axis
-     * @param {number} right farthest right on the x-axis
-     * @param {number} bottom farthest down on the y-axis
-     * @param {number} top farthest up on the y-axis
-     * @param {number} near distance to the near clipping plane along the -Z axis
-     * @param {number} far distance to the far clipping plane along the -Z axis
+     * @param {number} left - farthest left on the x-axis
+     * @param {number} right - farthest right on the x-axis
+     * @param {number} bottom - farthest down on the y-axis
+     * @param {number} top - farthest up on the y-axis
+     * @param {number} near - distance to the near clipping plane along the -Z axis
+     * @param {number} far - distance to the far clipping plane along the -Z axis
      * @returns {Matrix3d} Reference to this object for method chaining
      */
     ortho(left, right, bottom, top, near, far) {
@@ -389,9 +389,9 @@ class Matrix3d {
      * scale the matrix
      * @name scale
      * @memberof Matrix3d
-     * @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.
-     * @param {number} [z=0] a number representing the depth vector
+     * @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.
+     * @param {number} [z=0] - a number representing the depth vector
      * @returns {Matrix3d} Reference to this object for method chaining
      */
     scale(x, y, z) {
@@ -422,7 +422,7 @@ class Matrix3d {
      * adds a 2D scaling transformation.
      * @name scaleV
      * @memberof Matrix3d
-     * @param {Vector2d|Vector3d} v scaling vector
+     * @param {Vector2d|Vector3d} v - scaling vector
      * @returns {Matrix3d} Reference to this object for method chaining
      */
     scaleV(v) {
@@ -433,7 +433,7 @@ class Matrix3d {
      * specifies a 2D scale operation using the [sx, 1] scaling vector
      * @name scaleX
      * @memberof Matrix3d
-     * @param {number} x x scaling vector
+     * @param {number} x - x scaling vector
      * @returns {Matrix3d} Reference to this object for method chaining
      */
     scaleX(x) {
@@ -444,7 +444,7 @@ class Matrix3d {
      * specifies a 2D scale operation using the [1,sy] scaling vector
      * @name scaleY
      * @memberof Matrix3d
-     * @param {number} y y scaling vector
+     * @param {number} y - y scaling vector
      * @returns {Matrix3d} Reference to this object for method chaining
      */
     scaleY(y) {
@@ -455,8 +455,8 @@ class Matrix3d {
      * rotate this matrix (counter-clockwise) by the specified angle (in radians).
      * @name rotate
      * @memberof Matrix3d
-     * @param {number} angle Rotation angle in radians.
-     * @param {Vector3d} v the axis to rotate around
+     * @param {number} angle - Rotation angle in radians.
+     * @param {Vector3d} v - the axis to rotate around
      * @returns {Matrix3d} Reference to this object for method chaining
      */
     rotate(angle, v) {
@@ -535,16 +535,16 @@ class Matrix3d {
      * @name translate
      * @memberof Matrix3d
      * @method
-     * @param {number} x a number representing the abscissa of the vector.
-     * @param {number} [y=x] a number representing the ordinate of the vector.
-     * @param {number} [z=0] a number representing the depth of the vector
+     * @param {number} x - a number representing the abscissa of the vector.
+     * @param {number} [y=x] - a number representing the ordinate of the vector.
+     * @param {number} [z=0] - a number representing the depth of the vector
      * @returns {Matrix3d} Reference to this object for method chaining
      */
     /**
      * translate the matrix by a vector on the horizontal and vertical axis
      * @name translateV
      * @memberof Matrix3d
-     * @param {Vector2d|Vector3d} v the vector to translate the matrix by
+     * @param {Vector2d|Vector3d} v - the vector to translate the matrix by
      * @returns {Matrix3d} Reference to this object for method chaining
      */
     translate() {
@@ -604,7 +604,7 @@ class Matrix3d {
      * return true if the two matrices are identical
      * @name equals
      * @memberof Matrix3d
-     * @param {Matrix3d} m the other matrix
+     * @param {Matrix3d} m - the other matrix
      * @returns {boolean} true if both are equals
      */
     equals(m) {

package/src/math/observable_vector2.js

@@ -9,11 +9,11 @@ import {clamp} from "./math.js";
  */
 class ObservableVector2d extends Vector2d {
     /**
-     * @param {number} x x value of the vector
-     * @param {number} y y value of the vector
-     * @param {object} settings additional required parameters
-     * @param {Function} settings.onUpdate the callback to be executed when the vector is changed
-     * @param {Function} [settings.scope] the value to use as this when calling onUpdate
+     * @param {number} x - x value of the vector
+     * @param {number} y - y value of the vector
+     * @param {object} settings - additional required parameters
+     * @param {Function} settings.onUpdate - the callback to be executed when the vector is changed
+     * @param {Function} [settings.scope] - the value to use as this when calling onUpdate
      */
     constructor(x = 0, y = 0, settings) {
         super(x, y);
@@ -97,8 +97,8 @@ class ObservableVector2d extends Vector2d {
      * set the vector value without triggering the callback
      * @name setMuted
      * @memberof ObservableVector2d
-     * @param {number} x x value of the vector
-     * @param {number} y y value of the vector
+     * @param {number} x - x value of the vector
+     * @param {number} y - y value of the vector
      * @returns {ObservableVector2d} Reference to this object for method chaining
      */
     setMuted(x, y) {
@@ -111,8 +111,8 @@ class ObservableVector2d extends Vector2d {
      * set the callback to be executed when the vector is changed
      * @name setCallback
      * @memberof ObservableVector2d
-     * @param {Function} fn callback
-     * @param {Function} [scope=null] scope
+     * @param {Function} fn - callback
+     * @param {Function} [scope=null] - scope
      * @returns {ObservableVector2d} Reference to this object for method chaining
      */
     setCallback(fn, scope = null) {
@@ -175,7 +175,7 @@ class ObservableVector2d extends Vector2d {
      * Divide this vector values by the passed value
      * @name div
      * @memberof ObservableVector2d
-     * @param {number} n the value to divide the vector by
+     * @param {number} n - the value to divide the vector by
      * @returns {ObservableVector2d} Reference to this object for method chaining
      */
     div(n) {
@@ -335,8 +335,8 @@ class ObservableVector2d extends Vector2d {
      * Rotate this vector (counter-clockwise) by the specified angle (in radians).
      * @name rotate
      * @memberof ObservableVector2d
-     * @param {number} angle The angle to rotate (in radians)
-     * @param {Vector2d|ObservableVector2d} [v] an optional point to rotate around
+     * @param {number} angle - The angle to rotate (in radians)
+     * @param {Vector2d|ObservableVector2d} [v] - an optional point to rotate around
      * @returns {ObservableVector2d} Reference to this object for method chaining
      */
     rotate(angle, v) {
@@ -384,7 +384,7 @@ class ObservableVector2d extends Vector2d {
      * @name lerp
      * @memberof ObservableVector2d
      * @param {Vector2d|ObservableVector2d} v
-     * @param {number} alpha distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
+     * @param {number} alpha - distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
      * @returns {ObservableVector2d} Reference to this object for method chaining
      */
     lerp(v, alpha) {
@@ -399,7 +399,7 @@ class ObservableVector2d extends Vector2d {
      * @name moveTowards
      * @memberof ObservableVector2d
      * @param {Vector2d|ObservableVector2d} target
-     * @param {number} step the maximum step per iteration (Negative values will push the vector away from the target)
+     * @param {number} step - the maximum step per iteration (Negative values will push the vector away from the target)
      * @returns {ObservableVector2d} Reference to this object for method chaining
      */
      moveTowards(target, step) {

package/src/math/observable_vector3.js

@@ -9,12 +9,12 @@ import pool from "./../system/pooling.js";
  */
 class ObservableVector3d extends Vector3d {
     /**
-     * @param {number} x x value of the vector
-     * @param {number} y y value of the vector
-     * @param {number} z z value of the vector
-     * @param {object} settings additional required parameters
-     * @param {Function} settings.onUpdate the callback to be executed when the vector is changed
-     * @param {object} [settings.scope] the value to use as this when calling onUpdate
+     * @param {number} x - x value of the vector
+     * @param {number} y - y value of the vector
+     * @param {number} z - z value of the vector
+     * @param {object} settings - additional required parameters
+     * @param {Function} settings.onUpdate - the callback to be executed when the vector is changed
+     * @param {object} [settings.scope] - the value to use as this when calling onUpdate
      */
     constructor(x = 0, y = 0, z = 0, settings) {
         super(x, y, z);
@@ -124,9 +124,9 @@ class ObservableVector3d extends Vector3d {
      * set the vector value without triggering the callback
      * @name setMuted
      * @memberof ObservableVector3d
-     * @param {number} x x value of the vector
-     * @param {number} y y value of the vector
-     * @param {number} [z=0] z value of the vector
+     * @param {number} x - x value of the vector
+     * @param {number} y - y value of the vector
+     * @param {number} [z=0] - z value of the vector
      * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     setMuted(x, y, z) {
@@ -140,8 +140,8 @@ class ObservableVector3d extends Vector3d {
      * set the callback to be executed when the vector is changed
      * @name setCallback
      * @memberof ObservableVector3d
-     * @param {Function} fn callback
-     * @param {Function} [scope=null] scope
+     * @param {Function} fn - callback
+     * @param {Function} [scope=null] - scope
      * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     setCallback(fn, scope = null) {
@@ -206,7 +206,7 @@ class ObservableVector3d extends Vector3d {
      * Divide this vector values by the passed value
      * @name div
      * @memberof ObservableVector3d
-     * @param {number} n the value to divide the vector by
+     * @param {number} n - the value to divide the vector by
      * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     div(n) {
@@ -404,8 +404,8 @@ class ObservableVector3d extends Vector3d {
      * Rotate this vector (counter-clockwise) by the specified angle (in radians).
      * @name rotate
      * @memberof ObservableVector3d
-     * @param {number} angle The angle to rotate (in radians)
-     * @param {Vector2d|ObservableVector2d} [v] an optional point to rotate around (on the same z axis)
+     * @param {number} angle - The angle to rotate (in radians)
+     * @param {Vector2d|ObservableVector2d} [v] - an optional point to rotate around (on the same z axis)
      * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     rotate(angle, v) {
@@ -461,7 +461,7 @@ class ObservableVector3d extends Vector3d {
      * @name lerp
      * @memberof ObservableVector3d
      * @param {Vector3d|ObservableVector3d} v
-     * @param {number} alpha distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
+     * @param {number} alpha - distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
      * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     lerp(v, alpha) {
@@ -477,7 +477,7 @@ class ObservableVector3d extends Vector3d {
      * @name moveTowards
      * @memberof ObservableVector3d
      * @param {Vector2d|ObservableVector2d|Vector3d|ObservableVector3d} target
-     * @param {number} step the maximum step per iteration (Negative values will push the vector away from the target)
+     * @param {number} step - the maximum step per iteration (Negative values will push the vector away from the target)
      * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     moveTowards(target, step) {

package/src/math/vector2.js

@@ -7,8 +7,8 @@ import pool from "./../system/pooling.js";
  */
 class Vector2d {
     /**
-     * @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
      */
     constructor(x = 0, y = 0) {
         this.onResetEvent(x, y);
@@ -159,7 +159,7 @@ class Vector2d {
      * Divide this vector values by the passed value
      * @name div
      * @memberof Vector2d
-     * @param {number} n the value to divide the vector by
+     * @param {number} n - the value to divide the vector by
      * @returns {Vector2d} Reference to this object for method chaining
      */
     div(n) {
@@ -348,8 +348,8 @@ class Vector2d {
      * Rotate this vector (counter-clockwise) by the specified angle (in radians).
      * @name rotate
      * @memberof Vector2d
-     * @param {number} angle The angle to rotate (in radians)
-     * @param {Vector2d|ObservableVector2d} [v] an optional point to rotate around
+     * @param {number} angle - The angle to rotate (in radians)
+     * @param {Vector2d|ObservableVector2d} [v] - an optional point to rotate around
      * @returns {Vector2d} Reference to this object for method chaining
      */
     rotate(angle, v) {
@@ -417,7 +417,7 @@ class Vector2d {
      * @name lerp
      * @memberof Vector2d
      * @param {Vector2d} v
-     * @param {number} alpha distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
+     * @param {number} alpha - distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
      * @returns {Vector2d} Reference to this object for method chaining
      */
     lerp(v, alpha) {
@@ -431,7 +431,7 @@ class Vector2d {
      * @name moveTowards
      * @memberof Vector2d
      * @param {Vector2d} target
-     * @param {number} step the maximum step per iteration (Negative values will push the vector away from the target)
+     * @param {number} step - the maximum step per iteration (Negative values will push the vector away from the target)
      * @returns {Vector2d} Reference to this object for method chaining
      */
      moveTowards(target, step) {
@@ -476,7 +476,7 @@ class Vector2d {
      * project this vector on to another vector.
      * @name project
      * @memberof Vector2d
-     * @param {Vector2d} v The vector to project onto.
+     * @param {Vector2d} v - The vector to project onto.
      * @returns {Vector2d} Reference to this object for method chaining
      */
     project(v) {
@@ -488,7 +488,7 @@ class Vector2d {
      * This is slightly more efficient than `project` when dealing with unit vectors.
      * @name projectN
      * @memberof Vector2d
-     * @param {Vector2d} v The unit vector to project onto.
+     * @param {Vector2d} v - The unit vector to project onto.
      * @returns {Vector2d} Reference to this object for method chaining
      */
     projectN(v) {

package/src/math/vector3.js

@@ -7,9 +7,9 @@ import pool from "./../system/pooling.js";
  */
 class Vector3d {
     /**
-     * @param {number} [x=0] x value of the vector
-     * @param {number} [y=0] y value of the vector
-     * @param {number} [z=0] z value of the vector
+     * @param {number} [x=0] - x value of the vector
+     * @param {number} [y=0] - y value of the vector
+     * @param {number} [z=0] - z value of the vector
      */
     constructor(x = 0, y = 0, z = 0) {
         this.onResetEvent(x, y, z);
@@ -174,7 +174,7 @@ class Vector3d {
      * Divide this vector values by the passed value
      * @name div
      * @memberof Vector3d
-     * @param {number} n the value to divide the vector by
+     * @param {number} n - the value to divide the vector by
      * @returns {Vector3d} Reference to this object for method chaining
      */
     div(n) {
@@ -373,8 +373,8 @@ class Vector3d {
      * Rotate this vector (counter-clockwise) by the specified angle (in radians) around the z axis
      * @name rotate
      * @memberof Vector3d
-     * @param {number} angle The angle to rotate (in radians)
-     * @param {Vector2d|ObservableVector2d} [v] an optional point to rotate around (on the same z axis)
+     * @param {number} angle - The angle to rotate (in radians)
+     * @param {Vector2d|ObservableVector2d} [v] - an optional point to rotate around (on the same z axis)
      * @returns {Vector3d} Reference to this object for method chaining
      */
     rotate(angle, v) {
@@ -450,7 +450,7 @@ class Vector3d {
      * @name lerp
      * @memberof Vector3d
      * @param {Vector3d} v
-     * @param {number} alpha distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
+     * @param {number} alpha - distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
      * @returns {Vector3d} Reference to this object for method chaining
      */
     lerp(v, alpha) {
@@ -465,7 +465,7 @@ class Vector3d {
      * @name moveTowards
      * @memberof Vector3d
      * @param {Vector2d|Vector3d} target
-     * @param {number} step the maximum step per iteration (Negative values will push the vector away from the target)
+     * @param {number} step - the maximum step per iteration (Negative values will push the vector away from the target)
      * @returns {Vector3d} Reference to this object for method chaining
      */
     moveTowards(target, step) {
@@ -515,7 +515,7 @@ class Vector3d {
      * project this vector on to another vector.
      * @name project
      * @memberof Vector3d
-     * @param {Vector2d|Vector3d} v The vector to project onto.
+     * @param {Vector2d|Vector3d} v - The vector to project onto.
      * @returns {Vector3d} Reference to this object for method chaining
      */
     project(v) {
@@ -528,7 +528,7 @@ class Vector3d {
      * This is slightly more efficient than `project` when dealing with unit vectors.
      * @name projectN
      * @memberof Vector3d
-     * @param {Vector2d|Vector3d} v The unit vector to project onto.
+     * @param {Vector2d|Vector3d} v - The unit vector to project onto.
      * @returns {Vector3d} Reference to this object for method chaining
      */
     projectN(v) {