melonjs 10.9.0 → 10.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "melonjs",
-  "version": "10.9.0",
+  "version": "10.10.0",
   "description": "melonJS Game Engine",
   "homepage": "http://www.melonjs.org/",
   "keywords": [
@@ -35,6 +35,7 @@
     "name": "Olivier Biot",
     "email": "contact@melonjs.org"
   },
+  "funding": "https://github.com/sponsors/melonjs",
   "engines": {
     "node": ">= 12"
   },
@@ -46,7 +47,6 @@
     "dist/melonjs.min.js",
     "dist/melonjs.module.js",
     "dist/melonjs.module.d.ts",
-    "plugins/",
     "src/",
     "package.json",
     "README.md",
@@ -55,21 +55,23 @@
   ],
   "dependencies": {
     "@teppeis/multimaps": "^2.0.0",
-    "core-js": "^3.22.5",
+    "core-js": "^3.22.8",
     "earcut": "2.2.3",
     "eventemitter3": "^4.0.7",
     "howler": "2.2.3"
   },
   "devDependencies": {
+    "@melonjs/jsdoc-template": "^2.0.2",
     "@rollup/plugin-buble": "^0.21.3",
     "@rollup/plugin-commonjs": "^22.0.0",
     "@rollup/plugin-node-resolve": "^13.3.0",
     "@rollup/plugin-replace": "^4.0.0",
-    "@types/offscreencanvas": "^2019.6.4",
+    "@types/offscreencanvas": "^2019.7.0",
+    "@webdoc/cli": "^1.6.0",
     "cheerio": "^1.0.0-rc.11",
     "del-cli": "^4.0.1",
-    "eslint": "^8.16.0",
-    "eslint-plugin-jsdoc": "^39.3.0",
+    "eslint": "^8.17.0",
+    "eslint-plugin-jsdoc": "^39.3.2",
     "jasmine-core": "^4.1.1",
     "jsdoc": "^3.6.10",
     "karma": "^6.3.20",
@@ -78,12 +80,12 @@
     "karma-html-detailed-reporter": "^2.1.0",
     "karma-jasmine": "^5.0.1",
     "karma-nyan-reporter": "0.2.5",
-    "qs": "^6.10.3",
-    "rollup": "^2.74.1",
+    "qs": "^6.10.5",
+    "rollup": "^2.75.5",
     "rollup-plugin-bundle-size": "^1.0.3",
     "rollup-plugin-string": "^3.0.0",
-    "terser": "^5.13.1",
-    "typescript": "^4.6.4"
+    "terser": "^5.14.0",
+    "typescript": "^4.7.3"
   },
   "scripts": {
     "build": "npm run lint && rollup -c --silent",
@@ -92,6 +94,7 @@
     "lint": "eslint src rollup.config.js",
     "test": "npm run build && karma start tests/karma.conf.cjs",
     "doc": "mkdirp docs && jsdoc -c jsdoc_conf.json",
+    "webdoc": "mkdirp dist && webdoc --quiet -R README.md",
     "release": "npm run dist && npm publish --access public",
     "clean": "del-cli --force build/*.js dist/*.js dist/*.d.ts docs src/**/*.d.ts",
     "types": "tsc dist/melonjs.module.js --declaration --allowJs --emitDeclarationOnly"

package/src/game.js

@@ -5,9 +5,9 @@ import state from "./state/state.js";
 import World from "./physics/world.js";
 
 /**
- * me.game represents your current game, it contains all the objects,
+ * game represents your current game, it contains all the objects,
  * tilemap layers, current viewport, collision map, etc...<br>
- * me.game is also responsible for updating (each frame) the object status and draw them.
+ * game is also responsible for updating (each frame) the object status and draw them.
  * @namespace game
  */
 

package/src/geometries/ellipse.js

@@ -17,7 +17,7 @@ class Ellipse {
          * @public
          * @type {Vector2d}
          * @name pos
-         * @memberof Ellipse.prototype
+         * @memberof Ellipse
          */
         this.pos = pool.pull("Vector2d");
 
@@ -32,7 +32,7 @@ class Ellipse {
          * @public
          * @type {number}
          * @name radius
-         * @memberof Ellipse.prototype
+         * @memberof Ellipse
          */
         this.radius = NaN;
 
@@ -41,7 +41,7 @@ class Ellipse {
          * @public
          * @type {Vector2d}
          * @name radiusV
-         * @memberof Ellipse.prototype
+         * @memberof Ellipse
          */
         this.radiusV = pool.pull("Vector2d");
 
@@ -50,7 +50,7 @@ class Ellipse {
          * @public
          * @type {Vector2d}
          * @name radiusSq
-         * @memberof Ellipse.prototype
+         * @memberof Ellipse
          */
         this.radiusSq = pool.pull("Vector2d");
 
@@ -59,7 +59,7 @@ class Ellipse {
          * @public
          * @type {Vector2d}
          * @name ratio
-         * @memberof Ellipse.prototype
+         * @memberof Ellipse
          */
         this.ratio = pool.pull("Vector2d");
 
@@ -76,7 +76,7 @@ class Ellipse {
     /**
      * set new value to the Ellipse shape
      * @name setShape
-     * @memberof Ellipse.prototype
+     * @memberof Ellipse
      * @function
      * @param {number} x the center x coordinate of the ellipse
      * @param {number} y the center y coordinate of the ellipse
@@ -106,7 +106,7 @@ class Ellipse {
     /**
      * Rotate this Ellipse (counter-clockwise) by the specified angle (in radians).
      * @name rotate
-     * @memberof Ellipse.prototype
+     * @memberof Ellipse
      * @function
      * @param {number} angle The angle to rotate (in radians)
      * @param {Vector2d|ObservableVector2d} [v] an optional point to rotate around
@@ -123,7 +123,7 @@ class Ellipse {
     /**
      * Scale this Ellipse by the specified scalar.
      * @name scale
-     * @memberof Ellipse.prototype
+     * @memberof Ellipse
      * @function
      * @param {number} x
      * @param {number} [y=x]
@@ -142,7 +142,7 @@ class Ellipse {
     /**
      * Scale this Ellipse by the specified vector.
      * @name scale
-     * @memberof Ellipse.prototype
+     * @memberof Ellipse
      * @function
      * @param {Vector2d} v
      * @returns {Ellipse} Reference to this object for method chaining
@@ -154,7 +154,7 @@ class Ellipse {
     /**
      * apply the given transformation matrix to this ellipse
      * @name transform
-     * @memberof Ellipse.prototype
+     * @memberof Ellipse
      * @function
      * @param {Matrix2d} matrix the transformation matrix
      * @returns {Polygon} Reference to this object for method chaining
@@ -167,7 +167,7 @@ class Ellipse {
     /**
      * translate the circle/ellipse by the specified offset
      * @name translate
-     * @memberof Ellipse.prototype
+     * @memberof Ellipse
      * @function
      * @param {number} x x offset
      * @param {number} y y offset
@@ -176,7 +176,7 @@ class Ellipse {
     /**
      * translate the circle/ellipse by the specified vector
      * @name translate
-     * @memberof Ellipse.prototype
+     * @memberof Ellipse
      * @function
      * @param {Vector2d} v vector offset
      * @returns {Ellipse} this ellipse
@@ -204,7 +204,7 @@ class Ellipse {
     /**
      * check if this circle/ellipse contains the specified point
      * @name contains
-     * @memberof Ellipse.prototype
+     * @memberof Ellipse
      * @function
      * @param {Vector2d} point
      * @returns {boolean} true if contains
@@ -213,7 +213,7 @@ class Ellipse {
     /**
      * check if this circle/ellipse contains the specified point
      * @name contains
-     * @memberof Ellipse.prototype
+     * @memberof Ellipse
      * @function
      * @param  {number} x x coordinate
      * @param  {number} y y coordinate
@@ -245,7 +245,7 @@ class Ellipse {
     /**
      * returns the bounding box for this shape, the smallest Rectangle object completely containing this shape.
      * @name getBounds
-     * @memberof Ellipse.prototype
+     * @memberof Ellipse
      * @function
      * @returns {Bounds} this shape bounding box Rectangle object
      */
@@ -259,7 +259,7 @@ class Ellipse {
     /**
      * clone this Ellipse
      * @name clone
-     * @memberof Ellipse.prototype
+     * @memberof Ellipse
      * @function
      * @returns {Ellipse} new Ellipse
      */

package/src/geometries/line.js

@@ -15,7 +15,7 @@ class Line extends Polygon {
     /**
      * Returns true if the Line contains the given point
      * @name contains
-     * @memberof Line.prototype
+     * @memberof Line
      * @function
      * @param {Vector2d} point
      * @returns {boolean} true if contains
@@ -24,7 +24,7 @@ class Line extends Polygon {
     /**
      * Returns true if the Line contains the given point
      * @name contains
-     * @memberof Line.prototype
+     * @memberof Line
      * @function
      * @param  {number} x x coordinate
      * @param  {number} y y coordinate
@@ -58,7 +58,7 @@ class Line extends Polygon {
      * Computes the calculated collision edges and normals.
      * This **must** be called if the `points` array, `angle`, or `offset` is modified manually.
      * @name recalc
-     * @memberof Line.prototype
+     * @memberof Line
      * @function
      * @returns {Line} this instance for objecf chaining
      */
@@ -94,7 +94,7 @@ class Line extends Polygon {
     /**
      * clone this line segment
      * @name clone
-     * @memberof Line.prototype
+     * @memberof Line
      * @function
      * @returns {Line} new Line
      */

package/src/geometries/path2d.js

@@ -34,7 +34,7 @@ class Path2D {
     /**
      * begin a new path
      * @name beginPath
-     * @memberof Path2D.prototype
+     * @memberof Path2D
      * @function
      */
     beginPath() {
@@ -50,7 +50,7 @@ class Path2D {
      * It tries to draw a straight line from the current point to the start.
      * If the shape has already been closed or has only one point, this function does nothing.
      * @name closePath
-     * @memberof Path2D.prototype
+     * @memberof Path2D
      * @function
      */
     closePath() {
@@ -63,7 +63,7 @@ class Path2D {
     /**
      * triangulate the shape defined by this path into an array of triangles
      * @name triangulatePath
-     * @memberof Path2D.prototype
+     * @memberof Path2D
      * @function
      * @returns {Vector2d[]}
      */
@@ -94,7 +94,7 @@ class Path2D {
     /**
      * moves the starting point of the current path to the (x, y) coordinates.
      * @name moveTo
-     * @memberof Path2D.prototype
+     * @memberof Path2D
      * @function
      * @param {number} x the x-axis (horizontal) coordinate of the point.
      * @param {number} y the y-axis (vertical) coordinate of the point.
@@ -106,7 +106,7 @@ class Path2D {
     /**
      * connects the last point in the current patch to the (x, y) coordinates with a straight line.
      * @name lineTo
-     * @memberof Path2D.prototype
+     * @memberof Path2D
      * @function
      * @param {number} x the x-axis coordinate of the line's end point.
      * @param {number} y the y-axis coordinate of the line's end point.
@@ -119,7 +119,7 @@ class Path2D {
      * adds an arc to the current path which is centered at (x, y) position with the given radius,
      * starting at startAngle and ending at endAngle going in the given direction by counterclockwise (defaulting to clockwise).
      * @name arc
-     * @memberof Path2D.prototype
+     * @memberof Path2D
      * @function
      * @param {number} x the horizontal coordinate of the arc's center.
      * @param {number} y the vertical coordinate of the arc's center.
@@ -169,7 +169,7 @@ class Path2D {
     /**
      * adds a circular arc to the path with the given control points and radius, connected to the previous point by a straight line.
      * @name arcTo
-     * @memberof Path2D.prototype
+     * @memberof Path2D
      * @function
      * @param {number} x the x-axis coordinate of the first control point.
      * @param {number} y the y-axis coordinate of the first control point.
@@ -218,7 +218,7 @@ class Path2D {
      * adds an elliptical arc to the path which is centered at (x, y) position with the radii radiusX and radiusY
      * starting at startAngle and ending at endAngle going in the given direction by counterclockwise.
      * @name ellipse
-     * @memberof Path2D.prototype
+     * @memberof Path2D
      * @function
      * @param {number} x the x-axis (horizontal) coordinate of the ellipse's center.
      * @param {number} y the  y-axis (vertical) coordinate of the ellipse's center.
@@ -278,7 +278,7 @@ class Path2D {
     /**
      * creates a path for a rectangle at position (x, y) with a size that is determined by width and height.
      * @name rect
-     * @memberof Path2D.prototype
+     * @memberof Path2D
      * @function
      * @param {number} x the x-axis coordinate of the rectangle's starting point.
      * @param {number} y the y-axis coordinate of the rectangle's starting point.
@@ -296,7 +296,7 @@ class Path2D {
     /**
      * adds an rounded rectangle to the current path.
      * @name roundRect
-     * @memberof Path2D.prototype
+     * @memberof Path2D
      * @function
      * @param {number} x the x-axis coordinate of the rectangle's starting point.
      * @param {number} y the y-axis coordinate of the rectangle's starting point.

package/src/geometries/poly.js

@@ -25,7 +25,7 @@ class Polygon {
          * @public
          * @type {Vector2d}
          * @name pos
-         * @memberof Polygon.prototype
+         * @memberof Polygon
          */
         this.pos = pool.pull("Vector2d");
 
@@ -34,7 +34,7 @@ class Polygon {
          * @ignore
          * @type {Bounds}
          * @name _bounds
-         * @memberof Polygon.prototype
+         * @memberof Polygon
          */
         this._bounds;
 
@@ -44,7 +44,7 @@ class Polygon {
          * @public
          * @type {Vector2d[]}
          * @name points
-         * @memberof Polygon.prototype
+         * @memberof Polygon
          */
         this.points = [];
 
@@ -83,7 +83,7 @@ class Polygon {
     /**
      * set new value to the Polygon
      * @name setShape
-     * @memberof Polygon.prototype
+     * @memberof Polygon
      * @function
      * @param {number} x position of the Polygon
      * @param {number} y position of the Polygon
@@ -99,7 +99,7 @@ class Polygon {
     /**
      * set the vertices defining this Polygon
      * @name setVertices
-     * @memberof Polygon.prototype
+     * @memberof Polygon
      * @function
      * @param {Vector2d[]} vertices array of vector or vertice defining the Polygon
      * @returns {Polygon} this instance for objecf chaining
@@ -139,7 +139,7 @@ class Polygon {
     /**
      * apply the given transformation matrix to this Polygon
      * @name transform
-     * @memberof Polygon.prototype
+     * @memberof Polygon
      * @function
      * @param {Matrix2d} m the transformation matrix
      * @returns {Polygon} Reference to this object for method chaining
@@ -158,7 +158,7 @@ class Polygon {
     /**
      * apply an isometric projection to this shape
      * @name toIso
-     * @memberof Polygon.prototype
+     * @memberof Polygon
      * @function
      * @returns {Polygon} Reference to this object for method chaining
      */
@@ -169,7 +169,7 @@ class Polygon {
     /**
      * apply a 2d projection to this shape
      * @name to2d
-     * @memberof Polygon.prototype
+     * @memberof Polygon
      * @function
      * @returns {Polygon} Reference to this object for method chaining
      */
@@ -180,7 +180,7 @@ class Polygon {
     /**
      * Rotate this Polygon (counter-clockwise) by the specified angle (in radians).
      * @name rotate
-     * @memberof Polygon.prototype
+     * @memberof Polygon
      * @function
      * @param {number} angle The angle to rotate (in radians)
      * @param {Vector2d|ObservableVector2d} [v] an optional point to rotate around
@@ -202,7 +202,7 @@ class Polygon {
     /**
      * Scale this Polygon by the given scalar.
      * @name scale
-     * @memberof Polygon.prototype
+     * @memberof Polygon
      * @function
      * @param {number} x
      * @param {number} [y=x]
@@ -224,7 +224,7 @@ class Polygon {
     /**
      * Scale this Polygon by the given vector
      * @name scaleV
-     * @memberof Polygon.prototype
+     * @memberof Polygon
      * @function
      * @param {Vector2d} v
      * @returns {Polygon} Reference to this object for method chaining
@@ -237,7 +237,7 @@ class Polygon {
      * Computes the calculated collision polygon.
      * This **must** be called if the `points` array, `angle`, or `offset` is modified manually.
      * @name recalc
-     * @memberof Polygon.prototype
+     * @memberof Polygon
      * @function
      * @returns {Polygon} Reference to this object for method chaining
      */
@@ -281,7 +281,7 @@ class Polygon {
     /**
      * returns a list of indices for all triangles defined in this polygon
      * @name getIndices
-     * @memberof Polygon.prototype
+     * @memberof Polygon
      * @function
      * @returns {Array} an array of vertex indices for all triangles forming this polygon.
      */
@@ -295,7 +295,7 @@ class Polygon {
     /**
      * Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
      * @name isConvex
-     * @memberof Polygon.prototype
+     * @memberof Polygon
      * @function
      * @returns {boolean} true if the vertices are convex, false if not, null if not computable
      */
@@ -342,7 +342,7 @@ class Polygon {
     /**
      * translate the Polygon by the specified offset
      * @name translate
-     * @memberof Polygon.prototype
+     * @memberof Polygon
      * @function
      * @param {number} x x offset
      * @param {number} y y offset
@@ -351,7 +351,7 @@ class Polygon {
     /**
      * translate the Polygon by the specified vector
      * @name translate
-     * @memberof Polygon.prototype
+     * @memberof Polygon
      * @function
      * @param {Vector2d} v vector offset
      * @returns {Polygon} Reference to this object for method chaining
@@ -379,14 +379,14 @@ class Polygon {
     /**
      * Shifts the Polygon to the given position vector.
      * @name shift
-     * @memberof Polygon.prototype
+     * @memberof Polygon
      * @function
      * @param {Vector2d} position
      */
     /**
      * Shifts the Polygon to the given x, y position.
      * @name shift
-     * @memberof Polygon.prototype
+     * @memberof Polygon
      * @function
      * @param {number} x
      * @param {number} y
@@ -412,7 +412,7 @@ class Polygon {
      * (Note: it is highly recommended to first do a hit test on the corresponding <br>
      *  bounding rect, as the function can be highly consuming with complex shapes)
      * @name contains
-     * @memberof Polygon.prototype
+     * @memberof Polygon
      * @function
      * @param {Vector2d} point
      * @returns {boolean} true if contains
@@ -423,7 +423,7 @@ class Polygon {
      * (Note: it is highly recommended to first do a hit test on the corresponding <br>
      *  bounding rect, as the function can be highly consuming with complex shapes)
      * @name contains
-     * @memberof Polygon.prototype
+     * @memberof Polygon
      * @function
      * @param  {number} x x coordinate
      * @param  {number} y y coordinate
@@ -461,7 +461,7 @@ class Polygon {
     /**
      * returns the bounding box for this shape, the smallest Rectangle object completely containing this shape.
      * @name getBounds
-     * @memberof Polygon.prototype
+     * @memberof Polygon
      * @function
      * @returns {Bounds} this shape bounding box Rectangle object
      */
@@ -476,7 +476,7 @@ class Polygon {
      * update the bounding box for this shape.
      * @ignore
      * @name updateBounds
-     * @memberof Polygon.prototype
+     * @memberof Polygon
      * @function
      * @returns {Bounds} this shape bounding box Rectangle object
      */
@@ -492,7 +492,7 @@ class Polygon {
     /**
      * clone this Polygon
      * @name clone
-     * @memberof Polygon.prototype
+     * @memberof Polygon
      * @function
      * @returns {Polygon} new Polygon
      */