melonjs 15.2.1 → 15.4.0

package/dist/melonjs.mjs/math/vector3.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.2.1
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license
@@ -12,7 +12,7 @@ import pool from '../system/pooling.js';
  * @classdesc
  * a generic 3D Vector Object
  */
- class Vector3d {
+class Vector3d {
     /**
      * @param {number} [x=0] - x value of the vector
      * @param {number} [y=0] - y value of the vector
@@ -45,8 +45,6 @@ import pool from '../system/pooling.js';
 
     /**
      * set the Vector x and y properties to the given values<br>
-     * @name set
-     * @memberof Vector3d
      * @param {number} x
      * @param {number} y
      * @param {number} [z=0]
@@ -91,8 +89,6 @@ import pool from '../system/pooling.js';
 
     /**
      * set the Vector x and y properties to 0
-     * @name setZero
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     setZero() {
@@ -101,8 +97,6 @@ import pool from '../system/pooling.js';
 
     /**
      * set the Vector x and y properties using the passed vector
-     * @name setV
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -112,8 +106,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Add the passed vector to this vector
-     * @name add
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -123,8 +115,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Substract the passed vector to this vector
-     * @name sub
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -134,8 +124,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Multiply this vector values by the given scalar
-     * @name scale
-     * @memberof Vector3d
      * @param {number} x
      * @param {number} [y=x]
      * @param {number} [z=1]
@@ -147,8 +135,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Multiply this vector values by the passed vector
-     * @name scaleV
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -158,8 +144,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Convert this vector into isometric coordinate space
-     * @name toIso
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     toIso() {
@@ -168,8 +152,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Convert this vector into 2d coordinate space
-     * @name to2d
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     to2d() {
@@ -178,8 +160,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Divide this vector values by the passed value
-     * @name div
-     * @memberof Vector3d
      * @param {number} n - the value to divide the vector by
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -189,8 +169,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Update this vector values to absolute values
-     * @name abs
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     abs() {
@@ -199,8 +177,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Clamp the vector value within the specified value range
-     * @name clamp
-     * @memberof Vector3d
      * @param {number} low
      * @param {number} high
      * @returns {Vector3d} new me.Vector3d
@@ -211,8 +187,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Clamp this vector value within the specified value range
-     * @name clampSelf
-     * @memberof Vector3d
      * @param {number} low
      * @param {number} high
      * @returns {Vector3d} Reference to this object for method chaining
@@ -223,8 +197,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Update this vector with the minimum value between this and the passed vector
-     * @name minV
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -235,8 +207,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Update this vector with the maximum value between this and the passed vector
-     * @name maxV
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -247,8 +217,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Floor the vector values
-     * @name floor
-     * @memberof Vector3d
      * @returns {Vector3d} new me.Vector3d
      */
     floor() {
@@ -257,8 +225,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Floor this vector values
-     * @name floorSelf
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     floorSelf() {
@@ -267,8 +233,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Ceil the vector values
-     * @name ceil
-     * @memberof Vector3d
      * @returns {Vector3d} new me.Vector3d
      */
     ceil() {
@@ -277,8 +241,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Ceil this vector values
-     * @name ceilSelf
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     ceilSelf() {
@@ -287,8 +249,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Negate the vector values
-     * @name negate
-     * @memberof Vector3d
      * @returns {Vector3d} new me.Vector3d
      */
     negate() {
@@ -297,8 +257,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Negate this vector values
-     * @name negateSelf
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     negateSelf() {
@@ -307,8 +265,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Copy the components of the given vector into this one
-     * @name copy
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -317,19 +273,9 @@ import pool from '../system/pooling.js';
     }
 
     /**
-     * return true if the two vectors are the same
-     * @name equals
-     * @memberof Vector3d
-     * @method
-     * @param {Vector2d|Vector3d} v
-     * @returns {boolean}
-     */
-    /**
-     * return true if this vector is equal to the given values
-     * @name equals
-     * @memberof Vector3d
-     * @param {number} x
-     * @param {number} y
+     * return true if this vector is equal to the given values or vector
+     * @param {number|Vector2d|ObservableVector2d|Vector3d|ObservableVector3d} x
+     * @param {number} [y]
      * @param {number} [z]
      * @returns {boolean}
      */
@@ -356,8 +302,6 @@ import pool from '../system/pooling.js';
 
     /**
      * normalize this vector (scale the vector so that its magnitude is 1)
-     * @name normalize
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     normalize() {
@@ -367,8 +311,6 @@ import pool from '../system/pooling.js';
     /**
      * change this vector to be perpendicular to what it was before.<br>
      * (Effectively rotates it 90 degrees in a clockwise direction around the z axis)
-     * @name perp
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     perp() {
@@ -377,8 +319,6 @@ import pool from '../system/pooling.js';
 
     /**
      * 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)
      * @returns {Vector3d} Reference to this object for method chaining
@@ -404,8 +344,6 @@ import pool from '../system/pooling.js';
 
     /**
      * return the dot product of this vector and the passed one
-     * @name dot
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {number} The dot product.
      */
@@ -415,8 +353,6 @@ import pool from '../system/pooling.js';
 
     /**
      * calculate the cross product of this vector and the passed one
-     * @name cross
-     * @memberof Vector3d
      * @param {Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -431,10 +367,8 @@ import pool from '../system/pooling.js';
         return this;
     }
 
-   /**
+    /**
     * return the square length of this vector
-    * @name length2
-    * @memberof Vector3d
     * @returns {number} The length^2 of this vector.
     */
     length2() {
@@ -443,8 +377,6 @@ import pool from '../system/pooling.js';
 
     /**
      * return the length (magnitude) of this vector
-     * @name length
-     * @memberof Vector3d
      * @returns {number} the length of this vector
      */
     length() {
@@ -453,8 +385,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Linearly interpolate between this vector and the given one.
-     * @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).
      * @returns {Vector3d} Reference to this object for method chaining
@@ -468,8 +398,6 @@ import pool from '../system/pooling.js';
 
     /**
      * interpolate the position of this vector on the x and y axis towards the given one by the given maximum step.
-     * @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)
      * @returns {Vector3d} Reference to this object for method chaining
@@ -494,8 +422,6 @@ import pool from '../system/pooling.js';
 
     /**
      * return the distance between this vector and the passed one
-     * @name distance
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {number}
      */
@@ -508,8 +434,6 @@ import pool from '../system/pooling.js';
 
     /**
      * return the angle between this vector and the passed one
-     * @name angle
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {number} angle in radians
      */
@@ -519,8 +443,6 @@ import pool from '../system/pooling.js';
 
     /**
      * project this vector on to another vector.
-     * @name project
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v - The vector to project onto.
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -532,8 +454,6 @@ import pool from '../system/pooling.js';
     /**
      * Project this vector onto a vector of unit length.<br>
      * 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.
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -544,8 +464,6 @@ import pool from '../system/pooling.js';
 
     /**
      * return a clone copy of this vector
-     * @name clone
-     * @memberof Vector3d
      * @returns {Vector3d} new me.Vector3d
      */
     clone() {
@@ -554,8 +472,6 @@ import pool from '../system/pooling.js';
 
     /**
      * convert the object to a string representation
-     * @name toString
-     * @memberof Vector3d
      * @returns {string}
      */
     toString() {

package/dist/melonjs.mjs/node_modules/@teppeis/multimaps/dist/esm/arraymultimap.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.2.1
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license

package/dist/melonjs.mjs/node_modules/@teppeis/multimaps/dist/esm/multimap.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.2.1
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license

package/dist/melonjs.mjs/node_modules/earcut/src/earcut.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.2.1
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license

package/dist/melonjs.mjs/node_modules/eventemitter3/index.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.2.1
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license

package/dist/melonjs.mjs/node_modules/eventemitter3/index2.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.2.1
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license

package/dist/melonjs.mjs/node_modules/howler/dist/howler.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.2.1
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license

package/dist/melonjs.mjs/particles/emitter.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.2.1
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license
@@ -27,7 +27,7 @@ function createDefaultParticleTexture(w = 8, h = 8) {
  * Particle Emitter Object.
  * @augments Container
  */
- class ParticleEmitter extends Container {
+class ParticleEmitter extends Container {
     /**
      * @param {number} x - x position of the particle emitter
      * @param {number} y - y position of the particle emitter

package/dist/melonjs.mjs/particles/particle.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.2.1
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license
@@ -15,7 +15,7 @@ import Renderable from '../renderable/renderable.js';
  * Single Particle Object.
  * @augments Renderable
  */
- class Particle extends Renderable {
+class Particle extends Renderable {
     /**
      * @param {ParticleEmitter} emitter - the particle emitter
      */

package/dist/melonjs.mjs/particles/settings.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.2.1
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license

package/dist/melonjs.mjs/physics/body.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.2.1
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license
@@ -21,7 +21,7 @@ import Point from '../geometries/point.js';
  * a Generic Physic Body Object with some physic properties and behavior functionality, to as a member of a Renderable.
  * @see Renderable.body
  */
- class Body {
+class Body {
     /**
      * @param {Renderable|Container|Entity|Sprite|NineSliceSprite} ancestor - the parent object this body is attached to
      * @param {Rect|Rect[]|Polygon|Polygon[]|Line|Line[]|Ellipse|Ellipse[]|Point|Point[]|Bounds|Bounds[]|object} [shapes] - a initial shape, list of shapes, or JSON object defining the body
@@ -523,32 +523,34 @@ import Point from '../geometries/point.js';
 
     /**
      * Returns true if the any of the shape composing the body contains the given point.
-     * @method Body#contains
-     * @param {Vector2d} point
-     * @returns {boolean} true if contains
-     */
-    /**
-     * Returns true if the any of the shape composing the body contains the given point.
-     * @param  {number} x -  x coordinate
-     * @param  {number} y -  y coordinate
+     * @param {number|Vector2d} x -  x coordinate or a vector point to check
+     * @param {number} [y] -  y coordinate
      * @returns {boolean} true if contains
+     * @example
+     * if (mySprite.body.contains(10, 10)) {
+     *   // do something
+     * }
+     * // or
+     * if (mySprite.body.contains(myVector2d)) {
+     *   // do something
+     * }
      */
     contains() {
         let _x, _y;
 
         if (arguments.length === 2) {
-          // x, y
-          _x = arguments[0];
-          _y = arguments[1];
+            // x, y
+            _x = arguments[0];
+            _y = arguments[1];
         } else {
-          // vector
-          _x = arguments[0].x;
-          _y = arguments[0].y;
+            // vector
+            _x = arguments[0].x;
+            _y = arguments[0].y;
         }
 
         if (this.getBounds().contains(_x, _y)) {
-             // cannot use forEach here as cannot break out with a return
-             for (let i = this.shapes.length, shape; i--, (shape = this.shapes[i]);) {
+            // cannot use forEach here as cannot break out with a return
+            for (let i = this.shapes.length, shape; i--, (shape = this.shapes[i]);) {
                 if (shape.contains(_x, _y)) {
                     return true;
                 }
@@ -640,7 +642,7 @@ import Point from '../geometries/point.js';
 
             this.vel.x = (
                 (nx < 0) ? nx :
-                ( x > 0) ? x  : 0
+                    ( x > 0) ? x  : 0
             );
         }
         if (this.friction.y > 0) {
@@ -650,7 +652,7 @@ import Point from '../geometries/point.js';
 
             this.vel.y = (
                 (ny < 0) ? ny :
-                ( y > 0) ? y  : 0
+                    ( y > 0) ? y  : 0
             );
         }
 

package/dist/melonjs.mjs/physics/bounds.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.2.1
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license
@@ -12,7 +12,7 @@ import Vector2d from '../math/vector2.js';
  * @classdesc
  * a bound object contains methods for creating and manipulating axis-aligned bounding boxes (AABB).
  */
- class Bounds {
+class Bounds {
     /**
      * @param {Vector2d[]|Point[]} [vertices] - an array of Vector2d or Point
      */
@@ -261,17 +261,17 @@ import Vector2d from '../math/vector2.js';
 
     /**
      * Returns true if the bounds contains the given point.
-     * @name contains
-     * @memberof Bounds
-     * @method
-     * @param {Vector2d} point
-     * @returns {boolean} True if the bounds contain the point, otherwise false
-     */
-    /**
-     * Returns true if the bounds contains the given point.
-     * @param {number} x
-     * @param {number} y
+     * @param {number|Vector2d} x -  x coordinate or a vector point to check
+     * @param {number} [y] - y coordinate
      * @returns {boolean} True if the bounds contain the point, otherwise false
+     * @example
+     * if (bounds.contains(10, 10)) {
+     *   // do something
+     * }
+     * // or
+     * if (bounds.contains(myVector2d)) {
+     *   // do something
+     * }
      */
     contains() {
         let arg0 = arguments[0];
@@ -281,8 +281,8 @@ import Vector2d from '../math/vector2.js';
             _x1 = _x2 = arg0;
             _y1 = _y2 = arguments[1];
         } else {
-            if (arg0 instanceof Bounds) {
-                // bounds
+            if (typeof arg0.max !== "undefined") {
+                // only bounds define min and max properties
                 _x1 = arg0.min.x;
                 _x2 = arg0.max.x;
                 _y1 = arg0.min.y;
@@ -317,16 +317,13 @@ import Vector2d from '../math/vector2.js';
     }
 
     /**
-     * Translates the bounds by the given vector.
-     * @name translate
-     * @memberof Bounds
-     * @method
-     * @param {Vector2d} vector
-     */
-    /**
-     * Translates the bounds by x on the x axis, and y on the y axis
-     * @param {number} x
-     * @param {number} y
+     * Translates the bounds by the given point
+     * @param {number|Vector2d} x -  x coordinate or a vector point to translate by
+     * @param {number} [y]
+     * @example
+     * bounds.translate(10, 10);
+     * // or
+     * bounds.translate(myVector2d);
      */
     translate() {
         let _x, _y;
@@ -345,17 +342,14 @@ import Vector2d from '../math/vector2.js';
         this.max.y += _y;
     }
 
-    /**
-     * Shifts the bounds to the given position vector.
-     * @name shift
-     * @memberof Bounds
-     * @method
-     * @param {Vector2d} position
-     */
     /**
      * Shifts the bounds to the given x, y position.
-     * @param {number} x
-     * @param {number} y
+     * @param {number|Vector2d} x -  x coordinate or a vector point to shift to
+     * @param {number} [y]
+     * @example
+     * bounds.shift(10, 10);
+     * // or
+     * bounds.shift(myVector2d);
      */
     shift() {
         let _x, _y;

package/dist/melonjs.mjs/physics/collision.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.2.1
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license
@@ -15,7 +15,7 @@ import { game } from '../index.js';
 
 let collision = {
 
-     /**
+    /**
       * The maximum number of children that a quadtree node can contain before it is split into sub-nodes.
       * @name maxChildren
       * @memberof collision
@@ -24,9 +24,9 @@ let collision = {
       * @default 8
       * @see game.world.broadphase
       */
-     maxChildren : 8,
+    maxChildren : 8,
 
-     /**
+    /**
       * The maximum number of levels that the quadtree will create.
       * @name maxDepth
       * @memberof collision
@@ -35,7 +35,7 @@ let collision = {
       * @default 4
       * @see game.world.broadphase
       */
-     maxDepth : 4,
+    maxDepth : 4,
 
     /**
      * Enum for collision type values.