melonjs 10.3.0 → 10.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "melonjs",
-  "version": "10.3.0",
+  "version": "10.4.0",
   "description": "melonJS Game Engine",
   "homepage": "http://www.melonjs.org/",
   "keywords": [
@@ -59,38 +59,38 @@
   },
   "devDependencies": {
     "@rollup/plugin-buble": "^0.21.3",
-    "@rollup/plugin-commonjs": "^21.0.1",
+    "@rollup/plugin-commonjs": "^21.0.2",
     "@rollup/plugin-node-resolve": "^13.1.3",
-    "@rollup/plugin-replace": "^3.0.1",
+    "@rollup/plugin-replace": "^4.0.0",
     "cheerio": "^1.0.0-rc.10",
     "del-cli": "^4.0.1",
-    "eslint": "^8.8.0",
-    "eslint-plugin-jsdoc": "^37.7.0",
-    "jasmine-core": "^4.0.0",
+    "eslint": "^8.10.0",
+    "eslint-plugin-jsdoc": "^37.9.7",
+    "jasmine-core": "^4.0.1",
     "jsdoc": "^3.6.10",
-    "karma": "^6.3.13",
+    "karma": "^6.3.17",
     "karma-chrome-launcher": "^3.1.0",
-    "karma-coverage": "^2.1.0",
+    "karma-coverage": "^2.2.0",
     "karma-html-detailed-reporter": "^2.1.0",
     "karma-jasmine": "^4.0.1",
     "karma-nyan-reporter": "0.2.5",
     "qs": "^6.10.3",
-    "rollup": "^2.67.0",
+    "rollup": "^2.70.0",
     "rollup-plugin-bundle-size": "^1.0.3",
     "rollup-plugin-string": "^3.0.0",
-    "terser": "^5.10.0",
-    "typescript": "^4.5.5"
+    "terser": "^5.12.0",
+    "typescript": "^4.6.2",
+    "@types/offscreencanvas": "^2019.6.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 makedts",
+    "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 --config .eslintrc.json src rollup.config.js",
+    "lint": "eslint 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",
-    "clean": "del-cli --force build/*.js docs src/**/*.d.ts",
-    "makedts": "npx -p typescript tsc dist/melonjs.module.js --declaration --allowJs --emitDeclarationOnly",
-    "make-separated-src-dts": "npm run clean && npx -p typescript tsc src/**/*.js --declaration --allowJs --emitDeclarationOnly"
+    "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

@@ -5,7 +5,6 @@ import loader from "./../loader/loader.js";
 
 /**
  * @namespace audio
- * @memberof me
  */
 
 /**
@@ -70,7 +69,7 @@ var soundLoadError = function (sound_name, onerror_cb) {
  * @name stopOnAudioError
  * @type {boolean}
  * @default true
- * @memberof me.audio
+ * @memberof audio
  */
 export let stopOnAudioError = true;
 
@@ -83,7 +82,7 @@ export let stopOnAudioError = true;
  * webm has nearly full browser coverage with a great combination of compression and quality, and mp3 will fallback gracefully for other browsers.
  * It is important to remember that melonJS selects the first compatible sound based on the list of extensions and given order passed here.
  * So if you want webm to be used before mp3, you need to put the audio format in that order.
- * @function me.audio.init
+ * @function audio.init
  * @param {string} [format="mp3"] audio format to prioritize
  * @returns {boolean} Indicates whether audio initialization was successful
  * @example
@@ -102,7 +101,7 @@ export let stopOnAudioError = true;
 
 /**
  * check if the given audio format is supported
- * @function me.audio.hasFormat
+ * @function audio.hasFormat
  * @param {string} codec audio format : "mp3", "mpeg", opus", "ogg", "oga", "wav", "aac", "caf", "m4a", "m4b", "mp4", "weba", "webm", "dolby", "flac"
  * @returns {boolean} return true if the given audio format is supported
  */
@@ -112,7 +111,7 @@ export function hasFormat(codec) {
 
 /**
  * check if audio (HTML5 or WebAudio) is supported
- * @function me.audio.hasAudio
+ * @function audio.hasAudio
  * @returns {boolean} return true if audio (HTML5 or WebAudio) is supported
  */
 export function hasAudio() {
@@ -122,8 +121,8 @@ export function hasAudio() {
 /**
  * enable audio output <br>
  * only useful if audio supported and previously disabled through
- * @function me.audio.enable
- * @see me.audio#disable
+ * @function audio.enable
+ * @see audio#disable
  */
 export function enable() {
     unmuteAll();
@@ -131,7 +130,7 @@ export function enable() {
 
 /**
  * disable audio output
- * @function me.audio.disable
+ * @function audio.disable
  */
 export function disable() {
     muteAll();
@@ -180,7 +179,7 @@ export function load(sound, html5, onload_cb, onerror_cb) {
 
 /**
  * play the specified sound
- * @function me.audio.play
+ * @function audio.play
  * @param {string} sound_name audio clip name - case sensitive
  * @param {boolean} [loop=false] loop audio
  * @param {Function} [onend] Function to call when sound instance ends playing.
@@ -221,7 +220,7 @@ export function play(sound_name, loop = false, onend, volume) {
 
 /**
  * Fade a currently playing sound between two volumee.
- * @function me.audio.fade
+ * @function audio.fade
  * @param {string} sound_name audio clip name - case sensitive
  * @param {number} from Volume to fade from (0.0 to 1.0).
  * @param {number} to Volume to fade to (0.0 to 1.0).
@@ -239,7 +238,7 @@ export function fade(sound_name, from, to, duration, id) {
 
 /**
  * get/set the position of playback for a sound.
- * @function me.audio.seek
+ * @function 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} [id] the sound instance ID. If none is passed, all sounds in group will changed.
@@ -261,7 +260,7 @@ export function seek(sound_name, ...args) {
 
 /**
  * get or set the rate of playback for a sound.
- * @function me.audio.rate
+ * @function audio.rate
  * @param {string} sound_name audio clip name - case sensitive
  * @param {number} [rate] playback rate : 0.5 to 4.0, with 1.0 being normal speed.
  * @param {number} [id] the sound instance ID. If none is passed, all sounds in group will be changed.
@@ -283,7 +282,7 @@ export function rate(sound_name, ...args) {
 
 /**
  * stop the specified sound on all channels
- * @function me.audio.stop
+ * @function audio.stop
  * @param {string} [sound_name] audio clip name (case sensitive). If none is passed, all sounds are stopped.
  * @param {number} [id] the sound instance ID. If none is passed, all sounds in group will stop.
  * @example
@@ -307,7 +306,7 @@ export function stop(sound_name, id) {
 /**
  * pause the specified sound on all channels<br>
  * this function does not reset the currentTime property
- * @function me.audio.pause
+ * @function audio.pause
  * @param {string} sound_name audio clip name - case sensitive
  * @param {number} [id] the sound instance ID. If none is passed, all sounds in group will pause.
  * @example
@@ -324,7 +323,7 @@ export function pause(sound_name, id) {
 
 /**
  * resume the specified sound on all channels<br>
- * @function me.audio.resume
+ * @function audio.resume
  * @param {string} sound_name audio clip name - case sensitive
  * @param {number} [id] the sound instance ID. If none is passed, all sounds in group will resume.
  * @example
@@ -350,7 +349,7 @@ export function resume(sound_name, id) {
  * play the specified audio track<br>
  * this function automatically set the loop property to true<br>
  * and keep track of the current sound being played.
- * @function me.audio.playTrack
+ * @function audio.playTrack
  * @param {string} sound_name audio track name - case sensitive
  * @param {number} [volume=default] Float specifying volume (0.0 - 1.0 values accepted).
  * @returns {number} the sound instance ID.
@@ -369,8 +368,8 @@ export function playTrack(sound_name, volume) {
 
 /**
  * stop the current audio track
- * @function me.audio.stopTrack
- * @see me.audio#playTrack
+ * @function audio.stopTrack
+ * @see audio#playTrack
  * @example
  * // play a awesome music
  * me.audio.playTrack("awesome_music");
@@ -386,7 +385,7 @@ export function stopTrack() {
 
 /**
  * pause the current audio track
- * @function me.audio.pauseTrack
+ * @function audio.pauseTrack
  * @example
  * me.audio.pauseTrack();
  */
@@ -398,7 +397,7 @@ export function pauseTrack() {
 
 /**
  * resume the previously paused audio track
- * @function me.audio.resumeTrack
+ * @function audio.resumeTrack
  * @example
  * // play an awesome music
  * me.audio.playTrack("awesome_music");
@@ -415,7 +414,7 @@ export function resumeTrack() {
 
 /**
  * returns the current track Id
- * @function me.audio.getCurrentTrack
+ * @function audio.getCurrentTrack
  * @returns {string} audio track name
  */
 export function getCurrentTrack() {
@@ -424,7 +423,7 @@ export function getCurrentTrack() {
 
 /**
  * set the default global volume
- * @function me.audio.setVolume
+ * @function audio.setVolume
  * @param {number} volume Float specifying volume (0.0 - 1.0 values accepted).
  */
 export function setVolume(volume) {
@@ -433,7 +432,7 @@ export function setVolume(volume) {
 
 /**
  * get the default global volume
- * @function me.audio.getVolume
+ * @function audio.getVolume
  * @returns {number} current volume value in Float [0.0 - 1.0] .
  */
 export function getVolume() {
@@ -442,7 +441,7 @@ export function getVolume() {
 
 /**
  * mute or unmute the specified sound, but does not pause the playback.
- * @function me.audio.mute
+ * @function audio.mute
  * @param {string} sound_name audio clip name - case sensitive
  * @param {number} [id] the sound instance ID. If none is passed, all sounds in group will mute.
  * @param {boolean} [mute=true] True to mute and false to unmute
@@ -463,7 +462,7 @@ export function mute(sound_name, id, mute) {
 
 /**
  * unmute the specified sound
- * @function me.audio.unmute
+ * @function audio.unmute
  * @param {string} sound_name audio clip name
  * @param {number} [id] the sound instance ID. If none is passed, all sounds in group will unmute.
  */
@@ -473,7 +472,7 @@ export function unmute(sound_name, id) {
 
 /**
  * mute all audio
- * @function me.audio.muteAll
+ * @function audio.muteAll
  */
 export function muteAll() {
     Howler.mute(true);
@@ -481,7 +480,7 @@ export function muteAll() {
 
 /**
  * unmute all audio
- * @function me.audio.unmuteAll
+ * @function audio.unmuteAll
  */
 export function unmuteAll() {
     Howler.mute(false);
@@ -489,7 +488,7 @@ export function unmuteAll() {
 
 /**
  * Returns true if audio is muted globally.
- * @function me.audio.muted
+ * @function audio.muted
  * @returns {boolean} true if audio is muted globally
  */
 export function muted() {
@@ -498,7 +497,7 @@ export function muted() {
 
 /**
  * unload specified audio track to free memory
- * @function me.audio.unload
+ * @function audio.unload
  * @param {string} sound_name audio track name - case sensitive
  * @returns {boolean} true if unloaded
  * @example
@@ -517,7 +516,7 @@ export function unload(sound_name) {
 
 /**
  * unload all audio to free memory
- * @function me.audio.unloadAll
+ * @function audio.unloadAll
  * @function
  * @example
  * me.audio.unloadAll();

package/src/camera/camera2d.js

@@ -21,33 +21,28 @@ var targetV = new Vector2d();
 /**
  * @classdesc
  * a 2D orthographic camera
- * @class Camera2d
- * @augments me.Renderable
- * @memberof me
- * @param {number} minX start x offset
- * @param {number} minY start y offset
- * @param {number} maxX end x offset
- * @param {number} maxY end y offset
+ * @augments Renderable
  */
 class Camera2d extends Renderable {
-
     /**
-     * @ignore
+     * @param {number} minX start x offset
+     * @param {number} minY start y offset
+     * @param {number} maxX end x offset
+     * @param {number} maxY end y offset
      */
     constructor(minX, minY, maxX, maxY) {
         super(minX, minY, maxX - minX, maxY - minY);
 
         /**
          * Axis definition
+         * @enum {number}
          * @property {number} NONE no axis
          * @property {number} HORIZONTAL horizontal axis only
          * @property {number} VERTICAL vertical axis only
          * @property {number} BOTH both axis
-         * @public
-         * @constant
-         * @enum {number}
+         * @readonly
          * @name AXIS
-         * @memberof me.Camera2d
+         * @memberof Camera2d
          */
         this.AXIS = {
             NONE : 0,
@@ -59,20 +54,16 @@ class Camera2d extends Renderable {
         /**
          * Camera bounds
          * @public
-         * @type {me.Bounds}
+         * @type {Bounds}
          * @name bounds
-         * @memberof me.Camera2d
+         * @memberof Camera2d
          */
         this.bounds = pool.pull("Bounds");
 
         /**
-         * [IMTERNAL] enable or disable damping
+         * enable or disable damping
          * @private
-         * @type {boolean}
-         * @name smoothFollow
-         * @see me.Camera2d.damping
          * @default true
-         * @memberof me.Camera2d
          */
         this.smoothFollow = true;
 
@@ -83,7 +74,7 @@ class Camera2d extends Renderable {
          * @type {number}
          * @name damping
          * @default 1.0
-         * @memberof me.Camera2d
+         * @memberof Camera2d
          */
         this.damping = 1.0;
 
@@ -93,7 +84,7 @@ class Camera2d extends Renderable {
          * @type {number}
          * @name near
          * @default -1000
-         * @memberof me.Camera2d
+         * @memberof Camera2d
          */
         this.near = -1000;
 
@@ -103,7 +94,7 @@ class Camera2d extends Renderable {
          * @type {number}
          * @name far
          * @default 1000
-         * @memberof me.Camera2d
+         * @memberof Camera2d
          */
         this.far = 1000;
 
@@ -111,18 +102,18 @@ class Camera2d extends Renderable {
          * the default camera projection matrix
          * (2d cameras use an orthographic projection by default).
          * @public
-         * @type {me.Matrix3d}
+         * @type {Matrix3d}
          * @name projectionMatrix
-         * @memberof me.Camera2d
+         * @memberof Camera2d
          */
         this.projectionMatrix = new Matrix3d();
 
         /**
          * the invert camera transform used to unproject points
          * @ignore
-         * @type {me.Matrix2d}
+         * @type {Matrix2d}
          * @name invCurrentTransform
-         * @memberof me.Camera2d
+         * @memberof Camera2d
          */
         this.invCurrentTransform = new Matrix2d();
 
@@ -215,7 +206,7 @@ class Camera2d extends Renderable {
     /**
      * reset the camera position to specified coordinates
      * @name reset
-     * @memberof me.Camera2d
+     * @memberof Camera2d
      * @function
      * @param {number} [x=0]
      * @param {number} [y=0]
@@ -245,8 +236,8 @@ class Camera2d extends Renderable {
      * the "deadzone" defines an area within the current camera in which
      * the followed renderable can move without scrolling the camera.
      * @name setDeadzone
-     * @see me.Camera2d.follow
-     * @memberof me.Camera2d
+     * @see Camera2d.follow
+     * @memberof Camera2d
      * @function
      * @param {number} w deadzone width
      * @param {number} h deadzone height
@@ -274,11 +265,11 @@ class Camera2d extends Renderable {
     /**
      * resize the camera
      * @name resize
-     * @memberof me.Camera2d
+     * @memberof Camera2d
      * @function
      * @param {number} w new width of the camera
      * @param {number} h new height of the camera
-     * @returns {me.Camera2d} this camera
+     * @returns {Camera2d} this camera
      */
     resize(w, h) {
         // parent consctructor, resize camera rect
@@ -306,7 +297,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 Camera2d
      * @function
      * @param {number} x world left limit
      * @param {number} y world top limit
@@ -325,10 +316,10 @@ 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 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
+     * @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
      * @example
      * // set the camera to follow this renderable on both axis, and enable damping
@@ -367,7 +358,7 @@ class Camera2d extends Renderable {
     /**
      * unfollow the current target
      * @name unfollow
-     * @memberof me.Camera2d
+     * @memberof Camera2d
      * @function
      */
     unfollow() {
@@ -378,8 +369,8 @@ class Camera2d extends Renderable {
     /**
      * move the camera upper-left position by the specified offset.
      * @name move
-     * @memberof me.Camera2d
-     * @see me.Camera2d.focusOn
+     * @memberof Camera2d
+     * @see Camera2d.focusOn
      * @function
      * @param {number} x
      * @param {number} y
@@ -394,8 +385,8 @@ class Camera2d extends Renderable {
     /**
      * move the camera upper-left position to the specified coordinates
      * @name moveTo
-     * @memberof me.Camera2d
-     * @see me.Camera2d.focusOn
+     * @memberof Camera2d
+     * @see Camera2d.focusOn
      * @function
      * @param {number} x
      * @param {number} y
@@ -518,13 +509,12 @@ class Camera2d extends Renderable {
     /**
      * shake the camera
      * @name shake
-     * @memberof me.Camera2d
+     * @memberof Camera2d
      * @function
      * @param {number} intensity maximum offset that the screen can be moved
      * while shaking
      * @param {number} duration expressed in milliseconds
-     * @param {me.Camera2d.AXIS} [axis=this.AXIS.BOTH] specify on which axis you
-     *   want the shake effect
+     * @param {number} [axis=me.game.viewport.AXIS.BOTH] specify on which axis to apply the shake effect (see {@link Camera2d.AXIS})
      * @param {Function} [onComplete] callback once shaking effect is over
      * @param {boolean} [force] if true this will override the current effect
      * @example
@@ -544,9 +534,9 @@ 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 Camera2d
      * @function
-     * @param {me.Color|string} color a CSS color value
+     * @param {Color|string} color a CSS color value
      * @param {number} [duration=1000] expressed in milliseconds
      * @param {Function} [onComplete] callback once effect is over
      * @example
@@ -570,9 +560,9 @@ class Camera2d extends Renderable {
      * fadeIn effect <p>
      * fade to the specified color
      * @name fadeIn
-     * @memberof me.Camera2d
+     * @memberof Camera2d
      * @function
-     * @param {me.Color|string} color a CSS color value
+     * @param {Color|string} color a CSS color value
      * @param {number} [duration=1000] expressed in milliseconds
      * @param {Function} [onComplete] callback once effect is over
      * @example
@@ -593,9 +583,9 @@ class Camera2d extends Renderable {
     /**
      * set the camera position around the specified object
      * @name focusOn
-     * @memberof me.Camera2d
+     * @memberof Camera2d
      * @function
-     * @param {me.Renderable} target the renderable to focus the camera on
+     * @param {Renderable} target the renderable to focus the camera on
      */
     focusOn(target) {
         var bounds = target.getBounds();
@@ -608,9 +598,9 @@ class Camera2d extends Renderable {
     /**
      * check if the specified renderable is in the camera
      * @name isVisible
-     * @memberof me.Camera2d
+     * @memberof Camera2d
      * @function
-     * @param {me.Renderable} obj to be checked against
+     * @param {Renderable} obj to be checked against
      * @param {boolean} [floating = obj.floating] if visibility check should be done against screen coordinates
      * @returns {boolean}
      */
@@ -627,13 +617,13 @@ class Camera2d extends Renderable {
     /**
      * convert the given "local" (screen) coordinates into world coordinates
      * @name localToWorld
-     * @memberof me.Camera2d
+     * @memberof Camera2d
      * @function
      * @param {number} x
      * @param {number} y
      * @param {number} [v] an optional vector object where to set the
      * converted value
-     * @returns {me.Vector2d}
+     * @returns {Vector2d}
      */
     localToWorld(x, y, v) {
         // TODO memoization for one set of coords (multitouch)
@@ -648,13 +638,13 @@ class Camera2d extends Renderable {
     /**
      * convert the given world coordinates into "local" (screen) coordinates
      * @name worldToLocal
-     * @memberof me.Camera2d
+     * @memberof Camera2d
      * @function
      * @param {number} x
      * @param {number} y
      * @param {number} [v] an optional vector object where to set the
      * converted value
-     * @returns {me.Vector2d}
+     * @returns {Vector2d}
      */
     worldToLocal(x, y, v) {
         // TODO memoization for one set of coords (multitouch)

package/src/entity/draggable.js

@@ -6,15 +6,14 @@ import Entity from "./entity.js";
 /**
  * @classdesc
  * Used to make a game entity draggable
- * @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})
+ * @augments Entity
  */
 class DraggableEntity extends Entity {
-
+    /**
+     * @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 Entity})
+     */
     constructor(x, y, settings) {
         super(x, y, settings);
         this.dragging = false;
@@ -32,7 +31,7 @@ class DraggableEntity extends Entity {
      * this module testable. Then we subscribe this module to the
      * transformed events.
      * @name initEvents
-     * @memberof me.DraggableEntity
+     * @memberof DraggableEntity
      * @function
      */
     initEvents() {
@@ -59,7 +58,7 @@ class DraggableEntity extends Entity {
     /**
      * Translates a pointer event to a me.event
      * @name translatePointerEvent
-     * @memberof me.DraggableEntity
+     * @memberof 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
@@ -71,7 +70,7 @@ class DraggableEntity extends Entity {
     /**
      * Gets called when the user starts dragging the entity
      * @name dragStart
-     * @memberof me.DraggableEntity
+     * @memberof DraggableEntity
      * @function
      * @param {object} e the pointer event
      * @returns {boolean} false if the object is being dragged
@@ -88,7 +87,7 @@ class DraggableEntity extends Entity {
     /**
      * Gets called when the user drags this entity around
      * @name dragMove
-     * @memberof me.DraggableEntity
+     * @memberof DraggableEntity
      * @function
      * @param {object} e the pointer event
      */
@@ -102,7 +101,7 @@ class DraggableEntity extends Entity {
     /**
      * Gets called when the user stops dragging the entity
      * @name dragEnd
-     * @memberof me.DraggableEntity
+     * @memberof DraggableEntity
      * @function
      * @returns {boolean} false if the object stopped being dragged
      */
@@ -116,7 +115,7 @@ class DraggableEntity extends Entity {
     /**
      * Destructor
      * @name destroy
-     * @memberof me.DraggableEntity
+     * @memberof DraggableEntity
      * @function
      */
     destroy() {