melonjs 10.9.0 → 10.12.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "melonjs",
-  "version": "10.9.0",
+  "version": "10.12.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,44 +55,44 @@
   ],
   "dependencies": {
     "@teppeis/multimaps": "^2.0.0",
-    "core-js": "^3.22.5",
+    "core-js": "^3.23.1",
     "earcut": "2.2.3",
     "eventemitter3": "^4.0.7",
     "howler": "2.2.3"
   },
   "devDependencies": {
+    "@melonjs/webdoc-theme": "^1.1.1",
     "@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",
-    "cheerio": "^1.0.0-rc.11",
+    "@types/offscreencanvas": "^2019.7.0",
+    "@webdoc/cli": "^1.6.6",
     "del-cli": "^4.0.1",
-    "eslint": "^8.16.0",
-    "eslint-plugin-jsdoc": "^39.3.0",
-    "jasmine-core": "^4.1.1",
-    "jsdoc": "^3.6.10",
-    "karma": "^6.3.20",
+    "eslint": "^8.18.0",
+    "jasmine-core": "^4.2.0",
+    "karma": "^6.4.0",
     "karma-chrome-launcher": "^3.1.1",
     "karma-coverage": "^2.2.0",
     "karma-html-detailed-reporter": "^2.1.0",
-    "karma-jasmine": "^5.0.1",
+    "karma-jasmine": "^5.1.0",
     "karma-nyan-reporter": "0.2.5",
-    "qs": "^6.10.3",
-    "rollup": "^2.74.1",
+    "rollup": "^2.75.6",
     "rollup-plugin-bundle-size": "^1.0.3",
     "rollup-plugin-string": "^3.0.0",
-    "terser": "^5.13.1",
-    "typescript": "^4.6.4"
+    "terser": "^5.14.1",
+    "typescript": "^4.7.4"
   },
   "scripts": {
     "build": "npm run lint && rollup -c --silent",
     "dist": " npm run build && npm run minify && mkdirp dist && cp -f build/*.js dist/ && npm run types",
     "minify": "terser build/melonjs.js --compress --mangle --comments  '/(?:^!|@(?:license|preserve|cc_on))/' --output build/melonjs.min.js",
     "lint": "eslint src rollup.config.js",
-    "test": "npm run build && karma start tests/karma.conf.cjs",
-    "doc": "mkdirp docs && jsdoc -c jsdoc_conf.json",
-    "release": "npm run dist && npm publish --access public",
+    "test": "npm run test-node && karma start tests/karma.conf.cjs",
+    "test-node": "node build/melonjs.module.js",
+    "doc": "mkdirp docs && webdoc --quiet --site-root docs -R README.md",
+    "serve": "python3 -m http.server",
+    "prepublishOnly": "npm run dist && npm run test",
     "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/audio/audio.js

@@ -517,7 +517,6 @@ export function unload(sound_name) {
 /**
  * unload all audio to free memory
  * @function audio.unloadAll
- * @function
  * @example
  * me.audio.unloadAll();
  */

package/src/camera/camera2d.js

@@ -14,7 +14,7 @@ import { world } from "./../game.js";
 
 
 // some ref shortcut
-var MIN = Math.min, MAX = Math.max;
+const MIN = Math.min, MAX = Math.max;
 
 var targetV = new Vector2d();
 
@@ -207,7 +207,6 @@ class Camera2d extends Renderable {
      * reset the camera position to specified coordinates
      * @name reset
      * @memberof Camera2d
-     * @function
      * @param {number} [x=0]
      * @param {number} [y=0]
      */
@@ -238,7 +237,6 @@ class Camera2d extends Renderable {
      * @name setDeadzone
      * @see Camera2d.follow
      * @memberof Camera2d
-     * @function
      * @param {number} w deadzone width
      * @param {number} h deadzone height
      */
@@ -266,7 +264,6 @@ class Camera2d extends Renderable {
      * resize the camera
      * @name resize
      * @memberof Camera2d
-     * @function
      * @param {number} w new width of the camera
      * @param {number} h new height of the camera
      * @returns {Camera2d} this camera
@@ -298,7 +295,6 @@ class Camera2d extends Renderable {
      * the camera is bound to the given coordinates and cannot move/be scrolled outside of it.
      * @name setBounds
      * @memberof Camera2d
-     * @function
      * @param {number} x world left limit
      * @param {number} y world top limit
      * @param {number} w world width limit
@@ -317,7 +313,6 @@ class Camera2d extends Renderable {
      * (this will put the camera center around the given target)
      * @name follow
      * @memberof Camera2d
-     * @function
      * @param {Renderable|Vector2d} target renderable or position vector to follow
      * @param {number} [axis=me.game.viewport.AXIS.BOTH] Which axis to follow (see {@link Camera2d.AXIS})
      * @param {number} [damping=1] default damping value
@@ -359,7 +354,6 @@ class Camera2d extends Renderable {
      * unfollow the current target
      * @name unfollow
      * @memberof Camera2d
-     * @function
      */
     unfollow() {
         this.target = null;
@@ -371,7 +365,6 @@ class Camera2d extends Renderable {
      * @name move
      * @memberof Camera2d
      * @see Camera2d.focusOn
-     * @function
      * @param {number} x
      * @param {number} y
      * @example
@@ -387,7 +380,6 @@ class Camera2d extends Renderable {
      * @name moveTo
      * @memberof Camera2d
      * @see Camera2d.focusOn
-     * @function
      * @param {number} x
      * @param {number} y
      */
@@ -511,7 +503,6 @@ class Camera2d extends Renderable {
      * shake the camera
      * @name shake
      * @memberof Camera2d
-     * @function
      * @param {number} intensity maximum offset that the screen can be moved
      * while shaking
      * @param {number} duration expressed in milliseconds
@@ -536,7 +527,6 @@ class Camera2d extends Renderable {
      * screen is filled with the specified color and slowly goes back to normal
      * @name fadeOut
      * @memberof Camera2d
-     * @function
      * @param {Color|string} color a CSS color value
      * @param {number} [duration=1000] expressed in milliseconds
      * @param {Function} [onComplete] callback once effect is over
@@ -562,7 +552,6 @@ class Camera2d extends Renderable {
      * fade to the specified color
      * @name fadeIn
      * @memberof Camera2d
-     * @function
      * @param {Color|string} color a CSS color value
      * @param {number} [duration=1000] expressed in milliseconds
      * @param {Function} [onComplete] callback once effect is over
@@ -585,7 +574,6 @@ class Camera2d extends Renderable {
      * set the camera position around the specified object
      * @name focusOn
      * @memberof Camera2d
-     * @function
      * @param {Renderable} target the renderable to focus the camera on
      */
     focusOn(target) {
@@ -600,7 +588,6 @@ class Camera2d extends Renderable {
      * check if the specified renderable is in the camera
      * @name isVisible
      * @memberof Camera2d
-     * @function
      * @param {Renderable} obj to be checked against
      * @param {boolean} [floating = obj.floating] if visibility check should be done against screen coordinates
      * @returns {boolean}
@@ -619,7 +606,6 @@ class Camera2d extends Renderable {
      * convert the given "local" (screen) coordinates into world coordinates
      * @name localToWorld
      * @memberof Camera2d
-     * @function
      * @param {number} x
      * @param {number} y
      * @param {number} [v] an optional vector object where to set the
@@ -640,7 +626,6 @@ class Camera2d extends Renderable {
      * convert the given world coordinates into "local" (screen) coordinates
      * @name worldToLocal
      * @memberof Camera2d
-     * @function
      * @param {number} x
      * @param {number} y
      * @param {number} [v] an optional vector object where to set the

package/src/entity/entity.js

@@ -95,7 +95,7 @@ class Entity extends Renderable {
         /**
          * the entity body object
          * @public
-         * @type {Body}
+         * @member {Body}
          * @name body
          * @memberof Entity
          */
@@ -158,7 +158,6 @@ class Entity extends Renderable {
      * @ignore
      * @name onBodyUpdate
      * @memberof Entity
-     * @function
      * @param {Body} body the body whose bounds to update
      */
     onBodyUpdate(body) {
@@ -189,24 +188,21 @@ class Entity extends Renderable {
     }
 
     /**
-     * object draw<br>
-     * not to be called by the end user<br>
-     * called by the game manager on each game loop
+     * draw this entity (automatically called by melonJS)
      * @name draw
      * @memberof Entity
-     * @function
      * @protected
-     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
-     * @param {Rect} rect region to draw
+     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer instance
+     * @param {Camera2d} [viewport] the viewport to (re)draw
      */
-    draw(renderer, rect) {
+    draw(renderer, viewport) {
         var renderable = this.renderable;
         if (renderable instanceof Renderable) {
             // predraw (apply transforms)
             renderable.preDraw(renderer);
 
             // draw the object
-            renderable.draw(renderer, rect);
+            renderable.draw(renderer, viewport);
 
             // postdraw (clean-up);
             renderable.postDraw(renderer);
@@ -233,7 +229,6 @@ class Entity extends Renderable {
      * Called by engine before deleting the object
      * @name onDeactivateEvent
      * @memberof Entity
-     * @function
      */
     onDeactivateEvent() {
         if (this.renderable && this.renderable.onDeactivateEvent) {

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,8 +76,7 @@ class Ellipse {
     /**
      * set new value to the Ellipse shape
      * @name setShape
-     * @memberof Ellipse.prototype
-     * @function
+     * @memberof Ellipse
      * @param {number} x the center x coordinate of the ellipse
      * @param {number} y the center y coordinate of the ellipse
      * @param {number} w width (diameter) of the ellipse
@@ -106,8 +105,7 @@ class Ellipse {
     /**
      * Rotate this Ellipse (counter-clockwise) by the specified angle (in radians).
      * @name rotate
-     * @memberof Ellipse.prototype
-     * @function
+     * @memberof Ellipse
      * @param {number} angle The angle to rotate (in radians)
      * @param {Vector2d|ObservableVector2d} [v] an optional point to rotate around
      * @returns {Ellipse} Reference to this object for method chaining
@@ -123,8 +121,7 @@ class Ellipse {
     /**
      * Scale this Ellipse by the specified scalar.
      * @name scale
-     * @memberof Ellipse.prototype
-     * @function
+     * @memberof Ellipse
      * @param {number} x
      * @param {number} [y=x]
      * @returns {Ellipse} Reference to this object for method chaining
@@ -142,8 +139,7 @@ class Ellipse {
     /**
      * Scale this Ellipse by the specified vector.
      * @name scale
-     * @memberof Ellipse.prototype
-     * @function
+     * @memberof Ellipse
      * @param {Vector2d} v
      * @returns {Ellipse} Reference to this object for method chaining
      */
@@ -154,12 +150,11 @@ class Ellipse {
     /**
      * apply the given transformation matrix to this ellipse
      * @name transform
-     * @memberof Ellipse.prototype
-     * @function
+     * @memberof Ellipse
      * @param {Matrix2d} matrix the transformation matrix
      * @returns {Polygon} Reference to this object for method chaining
      */
-    transform(/* m */) {
+    transform(matrix) { // eslint-disable-line no-unused-vars
         // TODO
         return this;
     }
@@ -167,8 +162,8 @@ class Ellipse {
     /**
      * translate the circle/ellipse by the specified offset
      * @name translate
-     * @memberof Ellipse.prototype
-     * @function
+     * @memberof Ellipse
+     * @method
      * @param {number} x x offset
      * @param {number} y y offset
      * @returns {Ellipse} this ellipse
@@ -176,8 +171,7 @@ class Ellipse {
     /**
      * translate the circle/ellipse by the specified vector
      * @name translate
-     * @memberof Ellipse.prototype
-     * @function
+     * @memberof Ellipse
      * @param {Vector2d} v vector offset
      * @returns {Ellipse} this ellipse
      */
@@ -204,8 +198,8 @@ class Ellipse {
     /**
      * check if this circle/ellipse contains the specified point
      * @name contains
-     * @memberof Ellipse.prototype
-     * @function
+     * @method
+     * @memberof Ellipse
      * @param {Vector2d} point
      * @returns {boolean} true if contains
      */
@@ -213,8 +207,7 @@ class Ellipse {
     /**
      * check if this circle/ellipse contains the specified point
      * @name contains
-     * @memberof Ellipse.prototype
-     * @function
+     * @memberof Ellipse
      * @param  {number} x x coordinate
      * @param  {number} y y coordinate
      * @returns {boolean} true if contains
@@ -245,8 +238,7 @@ class Ellipse {
     /**
      * returns the bounding box for this shape, the smallest Rectangle object completely containing this shape.
      * @name getBounds
-     * @memberof Ellipse.prototype
-     * @function
+     * @memberof Ellipse
      * @returns {Bounds} this shape bounding box Rectangle object
      */
     getBounds() {
@@ -259,8 +251,7 @@ class Ellipse {
     /**
      * clone this Ellipse
      * @name clone
-     * @memberof Ellipse.prototype
-     * @function
+     * @memberof Ellipse
      * @returns {Ellipse} new Ellipse
      */
     clone() {

package/src/geometries/line.js

@@ -15,8 +15,8 @@ class Line extends Polygon {
     /**
      * Returns true if the Line contains the given point
      * @name contains
-     * @memberof Line.prototype
-     * @function
+     * @memberof Line
+     * @method
      * @param {Vector2d} point
      * @returns {boolean} true if contains
      */
@@ -24,8 +24,7 @@ class Line extends Polygon {
     /**
      * Returns true if the Line contains the given point
      * @name contains
-     * @memberof Line.prototype
-     * @function
+     * @memberof Line
      * @param  {number} x x coordinate
      * @param  {number} y y coordinate
      * @returns {boolean} true if contains
@@ -58,8 +57,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
-     * @function
+     * @memberof Line
      * @returns {Line} this instance for objecf chaining
      */
     recalc() {
@@ -94,8 +92,7 @@ class Line extends Polygon {
     /**
      * clone this line segment
      * @name clone
-     * @memberof Line.prototype
-     * @function
+     * @memberof Line
      * @returns {Line} new Line
      */
     clone() {

package/src/geometries/path2d.js

@@ -34,8 +34,7 @@ class Path2D {
     /**
      * begin a new path
      * @name beginPath
-     * @memberof Path2D.prototype
-     * @function
+     * @memberof Path2D
      */
     beginPath() {
         // empty the cache and recycle all vectors
@@ -50,8 +49,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
-     * @function
+     * @memberof Path2D
      */
     closePath() {
         var points = this.points;
@@ -63,8 +61,7 @@ class Path2D {
     /**
      * triangulate the shape defined by this path into an array of triangles
      * @name triangulatePath
-     * @memberof Path2D.prototype
-     * @function
+     * @memberof Path2D
      * @returns {Vector2d[]}
      */
     triangulatePath() {
@@ -94,8 +91,7 @@ class Path2D {
     /**
      * moves the starting point of the current path to the (x, y) coordinates.
      * @name moveTo
-     * @memberof Path2D.prototype
-     * @function
+     * @memberof Path2D
      * @param {number} x the x-axis (horizontal) coordinate of the point.
      * @param {number} y the y-axis (vertical) coordinate of the point.
      */
@@ -106,8 +102,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
-     * @function
+     * @memberof Path2D
      * @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,8 +114,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
-     * @function
+     * @memberof Path2D
      * @param {number} x the horizontal coordinate of the arc's center.
      * @param {number} y the vertical coordinate of the arc's center.
      * @param {number} radius the arc's radius. Must be positive.
@@ -169,12 +163,11 @@ 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
-     * @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.
-     * @param {number} x the x-axis coordinate of the second control point.
-     * @param {number} y the y-axis coordinate of the second control point.
+     * @memberof Path2D
+     * @param {number} x1 the x-axis coordinate of the first control point.
+     * @param {number} y1 the y-axis coordinate of the first control point.
+     * @param {number} x2 the x-axis coordinate of the second control point.
+     * @param {number} y2 the y-axis coordinate of the second control point.
      * @param {number} radius the arc's radius. Must be positive.
      */
     arcTo(x1, y1, x2, y2, radius) {
@@ -218,8 +211,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
-     * @function
+     * @memberof Path2D
      * @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.
      * @param {number} radiusX the ellipse's major-axis radius. Must be non-negative.
@@ -278,8 +270,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
-     * @function
+     * @memberof Path2D
      * @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.
      * @param {number} width the rectangle's width. Positive values are to the right, and negative to the left.
@@ -296,8 +287,7 @@ class Path2D {
     /**
      * adds an rounded rectangle to the current path.
      * @name roundRect
-     * @memberof Path2D.prototype
-     * @function
+     * @memberof Path2D
      * @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.
      * @param {number} width the rectangle's width. Positive values are to the right, and negative to the left.