melonjs 10.2.3 → 10.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "melonjs",
-  "version": "10.2.3",
+  "version": "10.3.0",
   "description": "melonJS Game Engine",
   "homepage": "http://www.melonjs.org/",
   "keywords": [
@@ -60,32 +60,32 @@
   "devDependencies": {
     "@rollup/plugin-buble": "^0.21.3",
     "@rollup/plugin-commonjs": "^21.0.1",
-    "@rollup/plugin-node-resolve": "^13.1.1",
-    "@rollup/plugin-replace": "^3.0.0",
+    "@rollup/plugin-node-resolve": "^13.1.3",
+    "@rollup/plugin-replace": "^3.0.1",
     "cheerio": "^1.0.0-rc.10",
     "del-cli": "^4.0.1",
-    "eslint": "^8.5.0",
-    "eslint-plugin-jsdoc": "^37.2.8",
-    "jasmine-core": "^3.10.1",
-    "jsdoc": "^3.6.7",
-    "karma": "^6.3.9",
+    "eslint": "^8.8.0",
+    "eslint-plugin-jsdoc": "^37.7.0",
+    "jasmine-core": "^4.0.0",
+    "jsdoc": "^3.6.10",
+    "karma": "^6.3.13",
     "karma-chrome-launcher": "^3.1.0",
     "karma-coverage": "^2.1.0",
     "karma-html-detailed-reporter": "^2.1.0",
     "karma-jasmine": "^4.0.1",
     "karma-nyan-reporter": "0.2.5",
-    "qs": "^6.10.2",
-    "rollup": "^2.61.1",
+    "qs": "^6.10.3",
+    "rollup": "^2.67.0",
     "rollup-plugin-bundle-size": "^1.0.3",
     "rollup-plugin-string": "^3.0.0",
     "terser": "^5.10.0",
-    "typescript": "^4.5.4"
+    "typescript": "^4.5.5"
   },
   "scripts": {
     "build": "npm run lint && rollup -c --silent",
     "dist": " npm run build && npm run minify && mkdirp dist && cp -f build/*.js dist/ && npm run makedts",
     "minify": "terser build/melonjs.js --compress --mangle --comments  '/(?:^!|@(?:license|preserve|cc_on))/' --output build/melonjs.min.js",
-    "lint": "eslint --config .eslintrc.json src",
+    "lint": "eslint --config .eslintrc.json src rollup.config.js",
     "test": "npm run build && karma start tests/karma.conf.js",
     "doc": "mkdirp docs && jsdoc -c jsdoc_conf.json",
     "release": "npm run dist && npm publish --access public",

package/src/audio/audio.js

@@ -5,7 +5,7 @@ import loader from "./../loader/loader.js";
 
 /**
  * @namespace audio
- * @memberOf me
+ * @memberof me
  */
 
 /**
@@ -70,7 +70,7 @@ var soundLoadError = function (sound_name, onerror_cb) {
  * @name stopOnAudioError
  * @type {boolean}
  * @default true
- * @memberOf me.audio
+ * @memberof me.audio
  */
 export let stopOnAudioError = true;
 
@@ -241,7 +241,7 @@ export function fade(sound_name, from, to, duration, id) {
  * get/set the position of playback for a sound.
  * @function me.audio.seek
  * @param {string} sound_name audio clip name - case sensitive
- * @param {number} [seek]  The position to move current playback to (in seconds).
+ * @param {number} [seek] the position to move current playback to (in seconds).
  * @param {number} [id] the sound instance ID. If none is passed, all sounds in group will changed.
  * @returns {number} return the current seek position (if no extra parameters were given)
  * @example

package/src/camera/camera2d.js

@@ -4,7 +4,7 @@ import ObservableVector2d from "./../math/observable_vector2.js";
 import ObservableVector3d from "./../math/observable_vector3.js";
 import Matrix2d from "./../math/matrix2.js";
 import Matrix3d from "./../math/matrix3.js";
-import Rect from "./../shapes/rectangle.js";
+import Rect from "./../geometries/rectangle.js";
 import { renderer } from "./../video/video.js";
 import * as event from "./../system/event.js";
 import pool from "./../system/pooling.js";
@@ -22,9 +22,8 @@ var targetV = new Vector2d();
  * @classdesc
  * a 2D orthographic camera
  * @class Camera2d
- * @extends me.Renderable
- * @memberOf me
- * @constructor
+ * @augments me.Renderable
+ * @memberof me
  * @param {number} minX start x offset
  * @param {number} minY start y offset
  * @param {number} maxX end x offset
@@ -48,7 +47,7 @@ class Camera2d extends Renderable {
          * @constant
          * @enum {number}
          * @name AXIS
-         * @memberOf me.Camera2d
+         * @memberof me.Camera2d
          */
         this.AXIS = {
             NONE : 0,
@@ -62,7 +61,7 @@ class Camera2d extends Renderable {
          * @public
          * @type {me.Bounds}
          * @name bounds
-         * @memberOf me.Camera2d
+         * @memberof me.Camera2d
          */
         this.bounds = pool.pull("Bounds");
 
@@ -73,7 +72,7 @@ class Camera2d extends Renderable {
          * @name smoothFollow
          * @see me.Camera2d.damping
          * @default true
-         * @memberOf me.Camera2d
+         * @memberof me.Camera2d
          */
         this.smoothFollow = true;
 
@@ -84,7 +83,7 @@ class Camera2d extends Renderable {
          * @type {number}
          * @name damping
          * @default 1.0
-         * @memberOf me.Camera2d
+         * @memberof me.Camera2d
          */
         this.damping = 1.0;
 
@@ -94,7 +93,7 @@ class Camera2d extends Renderable {
          * @type {number}
          * @name near
          * @default -1000
-         * @memberOf me.Camera2d
+         * @memberof me.Camera2d
          */
         this.near = -1000;
 
@@ -104,7 +103,7 @@ class Camera2d extends Renderable {
          * @type {number}
          * @name far
          * @default 1000
-         * @memberOf me.Camera2d
+         * @memberof me.Camera2d
          */
         this.far = 1000;
 
@@ -114,7 +113,7 @@ class Camera2d extends Renderable {
          * @public
          * @type {me.Matrix3d}
          * @name projectionMatrix
-         * @memberOf me.Camera2d
+         * @memberof me.Camera2d
          */
         this.projectionMatrix = new Matrix3d();
 
@@ -123,7 +122,7 @@ class Camera2d extends Renderable {
          * @ignore
          * @type {me.Matrix2d}
          * @name invCurrentTransform
-         * @memberOf me.Camera2d
+         * @memberof me.Camera2d
          */
         this.invCurrentTransform = new Matrix2d();
 
@@ -216,7 +215,7 @@ class Camera2d extends Renderable {
     /**
      * reset the camera position to specified coordinates
      * @name reset
-     * @memberOf me.Camera2d
+     * @memberof me.Camera2d
      * @function
      * @param {number} [x=0]
      * @param {number} [y=0]
@@ -247,7 +246,7 @@ class Camera2d extends Renderable {
      * the followed renderable can move without scrolling the camera.
      * @name setDeadzone
      * @see me.Camera2d.follow
-     * @memberOf me.Camera2d
+     * @memberof me.Camera2d
      * @function
      * @param {number} w deadzone width
      * @param {number} h deadzone height
@@ -275,7 +274,7 @@ class Camera2d extends Renderable {
     /**
      * resize the camera
      * @name resize
-     * @memberOf me.Camera2d
+     * @memberof me.Camera2d
      * @function
      * @param {number} w new width of the camera
      * @param {number} h new height of the camera
@@ -307,7 +306,7 @@ class Camera2d extends Renderable {
      * set the camera boundaries (set to the world limit by default).
      * the camera is bound to the given coordinates and cannot move/be scrolled outside of it.
      * @name setBounds
-     * @memberOf me.Camera2d
+     * @memberof me.Camera2d
      * @function
      * @param {number} x world left limit
      * @param {number} y world top limit
@@ -326,7 +325,7 @@ class Camera2d extends Renderable {
      * set the camera to follow the specified renderable. <br>
      * (this will put the camera center around the given target)
      * @name follow
-     * @memberOf me.Camera2d
+     * @memberof me.Camera2d
      * @function
      * @param {me.Renderable|me.Vector2d} target renderable or position vector to follow
      * @param {me.Camera2d.AXIS} [axis=this.AXIS.BOTH] Which axis to follow
@@ -368,7 +367,7 @@ class Camera2d extends Renderable {
     /**
      * unfollow the current target
      * @name unfollow
-     * @memberOf me.Camera2d
+     * @memberof me.Camera2d
      * @function
      */
     unfollow() {
@@ -379,7 +378,7 @@ class Camera2d extends Renderable {
     /**
      * move the camera upper-left position by the specified offset.
      * @name move
-     * @memberOf me.Camera2d
+     * @memberof me.Camera2d
      * @see me.Camera2d.focusOn
      * @function
      * @param {number} x
@@ -395,7 +394,7 @@ class Camera2d extends Renderable {
     /**
      * move the camera upper-left position to the specified coordinates
      * @name moveTo
-     * @memberOf me.Camera2d
+     * @memberof me.Camera2d
      * @see me.Camera2d.focusOn
      * @function
      * @param {number} x
@@ -519,7 +518,7 @@ class Camera2d extends Renderable {
     /**
      * shake the camera
      * @name shake
-     * @memberOf me.Camera2d
+     * @memberof me.Camera2d
      * @function
      * @param {number} intensity maximum offset that the screen can be moved
      * while shaking
@@ -545,7 +544,7 @@ class Camera2d extends Renderable {
      * fadeOut(flash) effect<p>
      * screen is filled with the specified color and slowly goes back to normal
      * @name fadeOut
-     * @memberOf me.Camera2d
+     * @memberof me.Camera2d
      * @function
      * @param {me.Color|string} color a CSS color value
      * @param {number} [duration=1000] expressed in milliseconds
@@ -571,7 +570,7 @@ class Camera2d extends Renderable {
      * fadeIn effect <p>
      * fade to the specified color
      * @name fadeIn
-     * @memberOf me.Camera2d
+     * @memberof me.Camera2d
      * @function
      * @param {me.Color|string} color a CSS color value
      * @param {number} [duration=1000] expressed in milliseconds
@@ -594,7 +593,7 @@ class Camera2d extends Renderable {
     /**
      * set the camera position around the specified object
      * @name focusOn
-     * @memberOf me.Camera2d
+     * @memberof me.Camera2d
      * @function
      * @param {me.Renderable} target the renderable to focus the camera on
      */
@@ -609,7 +608,7 @@ class Camera2d extends Renderable {
     /**
      * check if the specified renderable is in the camera
      * @name isVisible
-     * @memberOf me.Camera2d
+     * @memberof me.Camera2d
      * @function
      * @param {me.Renderable} obj to be checked against
      * @param {boolean} [floating = obj.floating] if visibility check should be done against screen coordinates
@@ -628,7 +627,7 @@ class Camera2d extends Renderable {
     /**
      * convert the given "local" (screen) coordinates into world coordinates
      * @name localToWorld
-     * @memberOf me.Camera2d
+     * @memberof me.Camera2d
      * @function
      * @param {number} x
      * @param {number} y
@@ -649,7 +648,7 @@ class Camera2d extends Renderable {
     /**
      * convert the given world coordinates into "local" (screen) coordinates
      * @name worldToLocal
-     * @memberOf me.Camera2d
+     * @memberof me.Camera2d
      * @function
      * @param {number} x
      * @param {number} y

package/src/entity/draggable.js

@@ -4,26 +4,17 @@ import * as event from "./../system/event.js";
 import Entity from "./entity.js";
 
 /**
+ * @classdesc
  * Used to make a game entity draggable
- * @class
- * @extends me.Entity
- * @memberOf me
- * @constructor
+ * @class DraggableEntity
+ * @augments me.Entity
+ * @memberof me
  * @param {number} x the x coordinates of the entity object
  * @param {number} y the y coordinates of the entity object
  * @param {object} settings Entity properties (see {@link me.Entity})
  */
 class DraggableEntity extends Entity {
 
-    /**
-     * Constructor
-     * @name init
-     * @memberOf me.DraggableEntity
-     * @function
-     * @param {number} x the x postion of the entity
-     * @param {number} y the y postion of the entity
-     * @param {object} settings the additional entity settings
-     */
     constructor(x, y, settings) {
         super(x, y, settings);
         this.dragging = false;
@@ -41,7 +32,7 @@ class DraggableEntity extends Entity {
      * this module testable. Then we subscribe this module to the
      * transformed events.
      * @name initEvents
-     * @memberOf me.DraggableEntity
+     * @memberof me.DraggableEntity
      * @function
      */
     initEvents() {
@@ -68,7 +59,7 @@ class DraggableEntity extends Entity {
     /**
      * Translates a pointer event to a me.event
      * @name translatePointerEvent
-     * @memberOf me.DraggableEntity
+     * @memberof me.DraggableEntity
      * @function
      * @param {object} e the pointer event you want to translate
      * @param {string} translation the me.event you want to translate the event to
@@ -80,7 +71,7 @@ class DraggableEntity extends Entity {
     /**
      * Gets called when the user starts dragging the entity
      * @name dragStart
-     * @memberOf me.DraggableEntity
+     * @memberof me.DraggableEntity
      * @function
      * @param {object} e the pointer event
      * @returns {boolean} false if the object is being dragged
@@ -97,7 +88,7 @@ class DraggableEntity extends Entity {
     /**
      * Gets called when the user drags this entity around
      * @name dragMove
-     * @memberOf me.DraggableEntity
+     * @memberof me.DraggableEntity
      * @function
      * @param {object} e the pointer event
      */
@@ -111,7 +102,7 @@ class DraggableEntity extends Entity {
     /**
      * Gets called when the user stops dragging the entity
      * @name dragEnd
-     * @memberOf me.DraggableEntity
+     * @memberof me.DraggableEntity
      * @function
      * @returns {boolean} false if the object stopped being dragged
      */
@@ -125,7 +116,7 @@ class DraggableEntity extends Entity {
     /**
      * Destructor
      * @name destroy
-     * @memberOf me.DraggableEntity
+     * @memberof me.DraggableEntity
      * @function
      */
     destroy() {

package/src/entity/droptarget.js

@@ -2,26 +2,18 @@ import * as event from "./../system/event.js";
 import Entity from "./entity.js";
 
 /**
+ * @classdesc
  * Used to make a game entity a droptarget
- * @class
- * @extends me.Entity
- * @memberOf me
- * @constructor
+ * @class DroptargetEntity
+ * @augments me.Entity
+ * @memberof me
  * @param {number} x the x coordinates of the entity object
  * @param {number} y the y coordinates of the entity object
  * @param {object} settings Entity properties (see {@link me.Entity})
  */
 
 class DroptargetEntity extends Entity {
-    /**
-     * Constructor
-     * @name init
-     * @memberOf me.DroptargetEntity
-     * @function
-     * @param {number} x the x postion of the entity
-     * @param {number} y the y postion of the entity
-     * @param {object} settings the additional entity settings
-     */
+
     constructor(x, y, settings) {
         super(x, y, settings);
         /**
@@ -30,7 +22,7 @@ class DroptargetEntity extends Entity {
          * @constant
          * @type {string}
          * @name CHECKMETHOD_OVERLAP
-         * @memberOf me.DroptargetEntity
+         * @memberof me.DroptargetEntity
          */
         this.CHECKMETHOD_OVERLAP = "overlaps";
         /**
@@ -39,7 +31,7 @@ class DroptargetEntity extends Entity {
          * @constant
          * @type {string}
          * @name CHECKMETHOD_CONTAINS
-         * @memberOf me.DroptargetEntity
+         * @memberof me.DroptargetEntity
          */
         this.CHECKMETHOD_CONTAINS = "contains";
         /**
@@ -48,7 +40,7 @@ class DroptargetEntity extends Entity {
          * @constant
          * @type {string}
          * @name checkMethod
-         * @memberOf me.DroptargetEntity
+         * @memberof me.DroptargetEntity
          */
         this.checkMethod = null;
         event.on(event.DRAGEND, this.checkOnMe, this);
@@ -58,7 +50,7 @@ class DroptargetEntity extends Entity {
     /**
      * Sets the collision method which is going to be used to check a valid drop
      * @name setCheckMethod
-     * @memberOf me.DroptargetEntity
+     * @memberof me.DroptargetEntity
      * @function
      * @param {string} checkMethod the checkmethod (defaults to CHECKMETHOD_OVERLAP)
      */
@@ -73,7 +65,7 @@ class DroptargetEntity extends Entity {
     /**
      * Checks if a dropped entity is dropped on the current entity
      * @name checkOnMe
-     * @memberOf me.DroptargetEntity
+     * @memberof me.DroptargetEntity
      * @function
      * @param {object} e the triggering event
      * @param {object} draggableEntity the draggable entity that is dropped
@@ -88,7 +80,7 @@ class DroptargetEntity extends Entity {
     /**
      * Gets called when a draggable entity is dropped on the current entity
      * @name drop
-     * @memberOf me.DroptargetEntity
+     * @memberof me.DroptargetEntity
      * @function
      * @param {object} draggableEntity the draggable entity that is dropped
      */
@@ -99,7 +91,7 @@ class DroptargetEntity extends Entity {
     /**
      * Destructor
      * @name destroy
-     * @memberOf me.DroptargetEntity
+     * @memberof me.DroptargetEntity
      * @function
      */
     destroy() {

package/src/entity/entity.js

@@ -2,16 +2,16 @@ import Vector2d from "./../math/vector2.js";
 import Renderable from "./../renderable/renderable.js";
 import Sprite from "./../renderable/sprite.js";
 import Body from "./../physics/body.js";
-import Polygon from "./../shapes/poly.js";
+import Polygon from "./../geometries/poly.js";
 
 
 /**
+ * @classdesc
  * a Generic Object Entity
  * @class Entity
- * @extends me.Renderable
- * @memberOf me
+ * @augments me.Renderable
+ * @memberof me
  * @see me.Renderable
- * @constructor
  * @param {number} x the x coordinates of the entity object
  * @param {number} y the y coordinates of the entity object
  * @param {object} settings Entity properties, to be defined through Tiled or when calling the entity constructor
@@ -76,7 +76,7 @@ class Entity extends Renderable {
          * @public
          * @type {string}
          * @name type
-         * @memberOf me.Entity
+         * @memberof me.Entity
          */
         this.type = settings.type || "";
 
@@ -85,7 +85,7 @@ class Entity extends Renderable {
          * @public
          * @type {number}
          * @name id
-         * @memberOf me.Entity
+         * @memberof me.Entity
          */
         this.id = settings.id || "";
 
@@ -95,7 +95,7 @@ class Entity extends Renderable {
          * @public
          * @type {boolean}
          * @name alive
-         * @memberOf me.Entity
+         * @memberof me.Entity
          */
         this.alive = true;
 
@@ -104,7 +104,7 @@ class Entity extends Renderable {
          * @public
          * @type {me.Body}
          * @name body
-         * @memberOf me.Entity
+         * @memberof me.Entity
          */
         // initialize the default body
         if (typeof settings.shapes === "undefined") {
@@ -136,7 +136,7 @@ class Entity extends Renderable {
      * @public
      * @type {me.Renderable}
      * @name renderable
-     * @memberOf me.Entity
+     * @memberof me.Entity
      */
 
     get renderable() {
@@ -164,9 +164,9 @@ class Entity extends Renderable {
      * update the bounds position when the body is modified
      * @ignore
      * @name onBodyUpdate
-     * @memberOf me.Entity
+     * @memberof me.Entity
      * @function
-     * @param {me.Body} the body whose bounds to update
+     * @param {me.Body} body the body whose bounds to update
      */
     onBodyUpdate(body) {
         // update the entity bounds to include the body bounds
@@ -200,7 +200,7 @@ class Entity extends Renderable {
      * not to be called by the end user<br>
      * called by the game manager on each game loop
      * @name draw
-     * @memberOf me.Entity
+     * @memberof me.Entity
      * @function
      * @protected
      * @param {me.CanvasRenderer|me.WebGLRenderer} renderer a renderer object
@@ -239,7 +239,7 @@ class Entity extends Renderable {
      * onDeactivateEvent Notification function<br>
      * Called by engine before deleting the object
      * @name onDeactivateEvent
-     * @memberOf me.Entity
+     * @memberof me.Entity
      * @function
      */
     onDeactivateEvent() {

package/src/game.js

@@ -9,7 +9,7 @@ import World from "./physics/world.js";
  * tilemap layers, current viewport, collision map, etc...<br>
  * me.game is also responsible for updating (each frame) the object status and draw them.
  * @namespace me.game
- * @memberOf me
+ * @memberof me
  */
 
 // to know when we have to refresh the display
@@ -49,7 +49,7 @@ event.on(event.BOOT, () => {
  * @public
  * @type {me.Camera2d}
  * @name viewport
- * @memberOf me.game
+ * @memberof me.game
  */
 export let viewport;
 
@@ -59,7 +59,7 @@ export let viewport;
  * @public
  * @type {me.World}
  * @name world
- * @memberOf me.game
+ * @memberof me.game
  */
 export let world;
 
@@ -70,7 +70,7 @@ export let world;
  * @type {boolean}
  * @default true
  * @name mergeGroup
- * @memberOf me.game
+ * @memberof me.game
  */
 export let mergeGroup = true;
 
@@ -81,7 +81,7 @@ export let mergeGroup = true;
  * @type {string}
  * @default "z"
  * @name sortOn
- * @memberOf me.game
+ * @memberof me.game
  */
 export let sortOn = "z";
 
@@ -93,7 +93,7 @@ export let sortOn = "z";
  * @public
  * @type {DOMHighResTimeStamp}
  * @name lastUpdate
- * @memberOf me.game
+ * @memberof me.game
  */
 export let lastUpdate = window.performance.now();