melonjs 10.10.0 → 10.11.0

package/src/geometries/rectangle.js

@@ -33,7 +33,6 @@ class Rect extends Polygon {
      * set new value to the rectangle shape
      * @name setShape
      * @memberof Rect
-     * @function
      * @param {number} x position of the Rectangle
      * @param {number} y position of the Rectangle
      * @param {number|Vector2d[]} w width of the rectangle, or an array of vector defining the rectangle
@@ -176,7 +175,6 @@ class Rect extends Polygon {
      * center the rectangle position around the given coordinates
      * @name centerOn
      * @memberof Rect
-     * @function
      * @param {number} x the x coordinate around which to center this rectangle
      * @param {number} x the y coordinate around which to center this rectangle
      * @returns {Rect} this rectangle
@@ -191,7 +189,6 @@ class Rect extends Polygon {
      * resize the rectangle
      * @name resize
      * @memberof Rect
-     * @function
      * @param {number} w new width of the rectangle
      * @param {number} h new height of the rectangle
      * @returns {Rect} this rectangle
@@ -206,7 +203,6 @@ class Rect extends Polygon {
      * scale the rectangle
      * @name scale
      * @memberof Rect
-     * @function
      * @param {number} x a number representing the abscissa of the scaling vector.
      * @param {number} [y=x] a number representing the ordinate of the scaling vector.
      * @returns {Rect} this rectangle
@@ -221,7 +217,6 @@ class Rect extends Polygon {
      * clone this rectangle
      * @name clone
      * @memberof Rect
-     * @function
      * @returns {Rect} new rectangle
      */
     clone() {
@@ -232,7 +227,6 @@ class Rect extends Polygon {
      * copy the position and size of the given rectangle into this one
      * @name copy
      * @memberof Rect
-     * @function
      * @param {Rect} rect Source rectangle
      * @returns {Rect} new rectangle
      */
@@ -244,7 +238,6 @@ class Rect extends Polygon {
      * merge this rectangle with another one
      * @name union
      * @memberof Rect
-     * @function
      * @param {Rect} rect other rectangle to union with
      * @returns {Rect} the union(ed) rectangle
      */
@@ -266,7 +259,6 @@ class Rect extends Polygon {
      * check if this rectangle is intersecting with the specified one
      * @name overlaps
      * @memberof Rect
-     * @function
      * @param {Rect} rect
      * @returns {boolean} true if overlaps
      */
@@ -283,7 +275,7 @@ class Rect extends Polygon {
      * Returns true if the rectangle contains the given rectangle
      * @name contains
      * @memberof Rect
-     * @function
+     * @method
      * @param {Rect} rect
      * @returns {boolean} true if contains
      */
@@ -292,7 +284,7 @@ class Rect extends Polygon {
      * Returns true if the rectangle contains the given point
      * @name contains
      * @memberof Rect
-     * @function
+     * @method
      * @param  {number} x x coordinate
      * @param  {number} y y coordinate
      * @returns {boolean} true if contains
@@ -302,7 +294,6 @@ class Rect extends Polygon {
      * Returns true if the rectangle contains the given point
      * @name contains
      * @memberof Rect
-     * @function
      * @param {Vector2d} point
      * @returns {boolean} true if contains
      */
@@ -338,7 +329,6 @@ class Rect extends Polygon {
      * check if this rectangle is identical to the specified one
      * @name equals
      * @memberof Rect
-     * @function
      * @param {Rect} rect
      * @returns {boolean} true if equals
      */
@@ -355,7 +345,6 @@ class Rect extends Polygon {
      * determines whether all coordinates of this rectangle are finite numbers.
      * @name isFinite
      * @memberof Rect
-     * @function
      * @returns {boolean} false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
      */
     isFinite() {
@@ -366,7 +355,6 @@ class Rect extends Polygon {
      * Returns a polygon whose edges are the same as this box.
      * @name toPolygon
      * @memberof Rect
-     * @function
      * @returns {Polygon} a new Polygon that represents this rectangle.
      */
     toPolygon() {

package/src/geometries/roundrect.js

@@ -56,7 +56,6 @@ class RoundRect extends Rect {
      * copy the position, size and radius of the given rounded rectangle into this one
      * @name copy
      * @memberof RoundRect
-     * @function
      * @param {RoundRect} rrect source rounded rectangle
      * @returns {RoundRect} new rectangle
      */
@@ -70,7 +69,7 @@ class RoundRect extends Rect {
      * Returns true if the rounded rectangle contains the given point
      * @name contains
      * @memberof RoundRect
-     * @function
+     * @method
      * @param  {number} x x coordinate
      * @param  {number} y y coordinate
      * @returns {boolean} true if contains
@@ -80,7 +79,6 @@ class RoundRect extends Rect {
      * Returns true if the rounded rectangle contains the given point
      * @name contains
      * @memberof RoundRect
-     * @function
      * @param {Vector2d} point
      * @returns {boolean} true if contains
      */
@@ -141,7 +139,6 @@ class RoundRect extends Rect {
      * check if this RoundRect is identical to the specified one
      * @name equals
      * @memberof RoundRect
-     * @function
      * @param {RoundRect} rrect
      * @returns {boolean} true if equals
      */
@@ -153,11 +150,10 @@ class RoundRect extends Rect {
      * clone this RoundRect
      * @name clone
      * @memberof RoundRect
-     * @function
      * @returns {RoundRect} new RoundRect
      */
     clone() {
-        return new RoundRect(this.pos.x, this.pos.y, this.width, this.height, radius);
+        return new RoundRect(this.pos.x, this.pos.y, this.width, this.height, this.radius);
     }
 };
 

package/src/index.js

@@ -193,7 +193,6 @@ export var skipAutoInit = false;
  * @name boot
  * @see skipAutoInit
  * @public
- * @function
  */
 export function boot() {
     // don't do anything if already initialized (should not happen anyway)

package/src/input/gamepad.js

@@ -86,10 +86,7 @@ var remap = new Map();
 
 var updateEventHandler;
 
-/**
- * Default gamepad mappings
- * @ignore
- */
+// Default gamepad mappings
 [
     // Firefox mappings
     [
@@ -261,18 +258,14 @@ var updateGamepads = function () {
     });
 };
 
-/**
- * gamepad connected callback
- * @ignore
- */
+// gamepad connected callback
 if (globalThis.navigator && typeof globalThis.navigator.getGamepads === "function") {
     globalThis.addEventListener("gamepadconnected", function (e) {
         event.emit(event.GAMEPAD_CONNECTED, e.gamepad);
     }, false);
 
-    /**
+    /*
      * gamepad disconnected callback
-     * @ignore
      */
     globalThis.addEventListener("gamepaddisconnected", function (e) {
         event.emit(event.GAMEPAD_DISCONNECTED, e.gamepad);
@@ -362,7 +355,6 @@ export var GAMEPAD = {
  * @name bindGamepad
  * @memberof input
  * @public
- * @function
  * @param {number} index Gamepad index
  * @param {object} button Button/Axis definition
  * @param {string} button.type "buttons" or "axes"
@@ -437,7 +429,6 @@ export function bindGamepad(index, button, keyCode) {
  * @name unbindGamepad
  * @memberof input
  * @public
- * @function
  * @param {number} index Gamepad index
  * @param {number} button (See {@link input.GAMEPAD.BUTTONS})
  * @example
@@ -456,7 +447,6 @@ export function unbindGamepad(index, button) {
  * @name setGamepadDeadzone
  * @memberof input
  * @public
- * @function
  * @param {number} value Deadzone value
  */
 export function setGamepadDeadzone(value) {
@@ -470,7 +460,6 @@ export function setGamepadDeadzone(value) {
  * @name setGamepadMapping
  * @memberof input
  * @public
- * @function
  * @param {string} id Gamepad id string
  * @param {object} mapping A hash table
  * @param {number[]} mapping.axes Standard analog control stick axis locations

package/src/input/keyboard.js

@@ -111,8 +111,7 @@ var keyUpEvent = function (e, keyCode, mouseButton) {
  * @namespace KEY
  * @memberof input
  */
-export var KEY = {
-    /** @memberof input.KEY */
+export const KEY = {
     "BACKSPACE" : 8,
     /** @memberof input.KEY */
     "TAB" : 9,
@@ -332,7 +331,6 @@ export function initKeyboardEvent() {
  * @name isKeyPressed
  * @memberof input
  * @public
- * @function
  * @param {string} action user defined corresponding action
  * @returns {boolean} true if pressed
  * @example
@@ -358,7 +356,6 @@ export function isKeyPressed(action) {
  * @name keyStatus
  * @memberof input
  * @public
- * @function
  * @param {string} action user defined corresponding action
  * @returns {boolean} down (true) or up(false)
  */
@@ -372,7 +369,6 @@ export function keyStatus(action) {
  * @name triggerKeyEvent
  * @memberof input
  * @public
- * @function
  * @param {number} keycode (See {@link input.KEY})
  * @param {boolean} [status=false] true to trigger a key down event, or false for key up event
  * @param {number} [mouseButton] the mouse button to trigger
@@ -395,7 +391,6 @@ export function triggerKeyEvent(keycode, status, mouseButton) {
  * @name bindKey
  * @memberof input
  * @public
- * @function
  * @param {number} keycode (See {@link input.KEY})
  * @param {string} action user defined corresponding action
  * @param {boolean} [lock=false] cancel the keypress event once read
@@ -422,7 +417,6 @@ export function bindKey(keycode, action, lock, preventDefault = preventDefaultAc
  * @name getBindingKey
  * @memberof input
  * @public
- * @function
  * @param {number} keycode (See {@link input.KEY})
  * @returns {string} user defined associated action
  */
@@ -435,7 +429,6 @@ export function getBindingKey(keycode) {
  * @name unlockKey
  * @memberof input
  * @public
- * @function
  * @param {string} action user defined corresponding action
  * @example
  * // Unlock jump when touching the ground
@@ -452,7 +445,6 @@ export function unlockKey(action) {
  * @name unbindKey
  * @memberof input
  * @public
- * @function
  * @param {number} keycode (See {@link input.KEY})
  * @example
  * me.input.unbindKey(me.input.KEY.LEFT);

package/src/input/pointer.js

@@ -311,7 +311,6 @@ class Pointer extends Bounds {
      * initialize the Pointer object using the given Event Object
      * @name Pointer#set
      * @private
-     * @function
      * @param {Event} event the original Event object
      * @param {number} [pageX=0] the horizontal coordinate at which the event occurred, relative to the left edge of the entire document
      * @param {number} [pageY=0] the vertical coordinate at which the event occurred, relative to the left edge of the entire document

package/src/input/pointerevent.js

@@ -35,17 +35,17 @@ var lastTimeStamp = 0;
 var activeEventList = [];
 
 // internal constants
-var WHEEL           = ["wheel"];
-var POINTER_MOVE    = ["pointermove",   "mousemove",    "touchmove"];
-var POINTER_DOWN    = ["pointerdown",   "mousedown",    "touchstart"];
-var POINTER_UP      = ["pointerup",     "mouseup",      "touchend"];
-var POINTER_CANCEL  = ["pointercancel", "mousecancel",  "touchcancel"];
-var POINTER_ENTER   = ["pointerenter",  "mouseenter",   "touchenter"];
-var POINTER_OVER    = ["pointerover",   "mouseover",    "touchover"];
-var POINTER_LEAVE   = ["pointerleave",  "mouseleave",   "touchleave"];
+const WHEEL           = ["wheel"];
+const POINTER_MOVE    = ["pointermove",   "mousemove",    "touchmove"];
+const POINTER_DOWN    = ["pointerdown",   "mousedown",    "touchstart"];
+const POINTER_UP      = ["pointerup",     "mouseup",      "touchend"];
+const POINTER_CANCEL  = ["pointercancel", "mousecancel",  "touchcancel"];
+const POINTER_ENTER   = ["pointerenter",  "mouseenter",   "touchenter"];
+const POINTER_OVER    = ["pointerover",   "mouseover",    "touchover"];
+const POINTER_LEAVE   = ["pointerleave",  "mouseleave",   "touchleave"];
 
 // list of standard pointer event type
-var pointerEventList = [
+const pointerEventList = [
     WHEEL[0],
     POINTER_MOVE[0],
     POINTER_DOWN[0],
@@ -57,7 +57,7 @@ var pointerEventList = [
 ];
 
 // legacy mouse event type
-var mouseEventList = [
+const mouseEventList = [
     WHEEL[0],
     POINTER_MOVE[1],
     POINTER_DOWN[1],
@@ -69,7 +69,7 @@ var mouseEventList = [
 ];
 
 // iOS style touch event type
-var touchEventList = [
+const touchEventList = [
     POINTER_MOVE[2],
     POINTER_DOWN[2],
     POINTER_UP[2],
@@ -79,7 +79,7 @@ var touchEventList = [
     POINTER_LEAVE[2]
 ];
 
-var pointerEventMap = {
+const pointerEventMap = {
     wheel : WHEEL,
     pointermove: POINTER_MOVE,
     pointerdown: POINTER_DOWN,
@@ -264,8 +264,8 @@ function dispatchEvent(normalizedEvents) {
         // and put it back into our cache
         T_POINTERS.push(pointer);
 
-        // Do not fire older events
-        if (typeof(pointer.event.timeStamp) !== "undefined") {
+        // Do not fire older touch events (not required for PointerEvent type)
+        if (pointer.isNormalized === true && typeof(pointer.event.timeStamp) !== "undefined") {
             if (pointer.event.timeStamp < lastTimeStamp) {
                 continue;
             }
@@ -543,7 +543,6 @@ export var throttlingInterval;
  * @name globalToLocal
  * @memberof input
  * @public
- * @function
  * @param {number} x the global x coordinate to be translated.
  * @param {number} y the global y coordinate to be translated.
  * @param {Vector2d} [v] an optional vector object where to set the translated coordinates
@@ -576,7 +575,6 @@ export function globalToLocal(x, y, v) {
  * @memberof input
  * @see https://developer.mozilla.org/en-US/docs/Web/CSS/touch-action
  * @public
- * @function
  * @param {HTMLCanvasElement} element
  * @param {string} [value="none"]
  */
@@ -592,7 +590,6 @@ export function setTouchAction(element, value) {
  * @name bindPointer
  * @memberof input
  * @public
- * @function
  * @param {number} [button=input.pointer.LEFT] (accordingly to W3C values : 0,1,2 for left, middle and right buttons)
  * @param {input.KEY} keyCode
  * @example
@@ -623,7 +620,6 @@ export function bindPointer() {
  * @name unbindPointer
  * @memberof input
  * @public
- * @function
  * @param {number} [button=input.pointer.LEFT] (accordingly to W3C values : 0,1,2 for left, middle and right buttons)
  * @example
  * me.input.unbindPointer(me.input.pointer.LEFT);
@@ -645,7 +641,6 @@ export function unbindPointer(button) {
  * @name registerPointerEvent
  * @memberof input
  * @public
- * @function
  * @param {string} eventType The event type for which the object is registering <br>
  * melonJS currently supports: <br>
  * <ul>
@@ -717,7 +712,6 @@ export function registerPointerEvent(eventType, region, callback) {
  * @name releasePointerEvent
  * @memberof input
  * @public
- * @function
  * @param {string} eventType The event type for which the object was registered. See {@link input.registerPointerEvent}
  * @param {Rect|Polygon|Line|Ellipse} region the registered region to release for this event
  * @param {Function} [callback="all"] if specified unregister the event only for the specific callback
@@ -762,7 +756,6 @@ export function releasePointerEvent(eventType, region, callback) {
  * @name releaseAllPointerEvents
  * @memberof input
  * @public
- * @function
  * @param {Rect|Polygon|Line|Ellipse} region the registered region to release event from
  * @example
  * // release all registered event on the
@@ -782,7 +775,6 @@ export function releaseAllPointerEvents(region) {
  * @name requestPointerLock
  * @memberof input
  * @public
- * @function
  * @returns {boolean} return true if the request was successfully submitted
  * @example
  * // register on the pointer lock change event
@@ -806,7 +798,6 @@ export function requestPointerLock() {
  * @name exitPointerLock
  * @memberof input
  * @public
- * @function
  * @returns {boolean} return true if the request was successfully submitted
  */
 export function exitPointerLock() {

package/src/lang/deprecated.js

@@ -4,7 +4,7 @@ import { TextureAtlas } from "./../video/texture/atlas.js";
 import Renderer from "./../video/renderer.js";
 import { Draggable, DropTarget } from "./../renderable/dragndrop.js";
 
-/**
+/*
  * placeholder for all deprecated classes and corresponding alias for backward compatibility
  */
 
@@ -48,7 +48,6 @@ export function warning(deprecated, replacement, version) {
 /**
  * @public
  * @name turnOnPointerLock
- * @function
  * @returns {boolean} return true if the request was successfully submitted
  * @memberof device#
  * @deprecated since 10.3.0
@@ -62,7 +61,6 @@ device.turnOnPointerLock = function () {
 /**
  * @public
  * @name turnOffPointerLock
- * @function
  * @returns {boolean} return true if the request was successfully submitted
  * @memberof device#
  * @deprecated since 10.3.0
@@ -74,8 +72,11 @@ device.turnOffPointerLock = function () {
 };
 
 /**
+ * Alias of {@link TextureAtlas}
+ *
  * @public
  * @name Texture
+ * @class
  * @memberof Renderer#
  * @deprecated since 10.4.0
  * @see TextureAtlas

package/src/level/level.js

@@ -56,7 +56,6 @@ function safeLoadLevel(levelId, options, restart) {
  * @param {boolean} [flatten=true] if true, flatten all objects into the given container
  * @param {boolean} [setViewportBounds=false] if true, set the viewport bounds to the map size, this should be set to true especially if adding a level to the game world container.
  * @ignore
- * @function
  */
 function loadTMXLevel(levelId, container, flatten, setViewportBounds) {
     var level = levels[levelId];
@@ -85,7 +84,6 @@ var level = {
      * @name add
      * @memberof level
      * @public
-     * @function
      * @param {string} format level format (only "tmx" supported)
      * @param {string} levelId the level id (or name)
      * @param {Function} [callback] a function to be called once the level is loaded
@@ -124,7 +122,6 @@ var level = {
      * @name load
      * @memberof level
      * @public
-     * @function
      * @param {string} levelId level id
      * @param {object} [options] additional optional parameters
      * @param {Container} [options.container=game.world] container in which to load the specified level
@@ -198,7 +195,6 @@ var level = {
      * @name getCurrentLevelId
      * @memberof level
      * @public
-     * @function
      * @returns {string}
      */
     getCurrentLevelId() {
@@ -212,7 +208,6 @@ var level = {
      * @name getCurrentLevel
      * @memberof level
      * @public
-     * @function
      * @returns {TMXTileMap}
      */
     getCurrentLevel() {
@@ -224,7 +219,6 @@ var level = {
      * @name reload
      * @memberof level
      * @public
-     * @function
      * @param {object} [options] additional optional parameters
      * @param {Container} [options.container=game.world] container in which to load the specified level
      * @param {Function} [options.onLoaded=game.onLevelLoaded] callback for when the level is fully loaded
@@ -242,7 +236,6 @@ var level = {
      * @name next
      * @memberof level
      * @public
-     * @function
      * @param {object} [options] additional optional parameters
      * @param {Container} [options.container=game.world] container in which to load the specified level
      * @param {Function} [options.onLoaded=game.onLevelLoaded] callback for when the level is fully loaded
@@ -264,7 +257,6 @@ var level = {
      * @name previous
      * @memberof level
      * @public
-     * @function
      * @param {object} [options] additional optional parameters
      * @param {Container} [options.container=game.world] container in which to load the specified level
      * @param {Function} [options.onLoaded=game.onLevelLoaded] callback for when the level is fully loaded
@@ -286,7 +278,6 @@ var level = {
      * @name levelCount
      * @memberof level
      * @public
-     * @function
      * @returns {number} the amount of level preloaded
      */
     levelCount() {

package/src/level/tiled/TMXGroup.js

@@ -98,9 +98,7 @@ export default class TMXGroup {
     /**
      * reset function
      * @ignore
-     * @function
      */
-
     destroy() {
         // clear all allocated objects
         this.objects = null;
@@ -109,7 +107,6 @@ export default class TMXGroup {
     /**
      * return the object count
      * @ignore
-     * @function
      */
     getObjectCount() {
         return this.objects.length;
@@ -118,7 +115,6 @@ export default class TMXGroup {
     /**
      * returns the object at the specified index
      * @ignore
-     * @function
      */
     getObjectByIndex(idx) {
         return this.objects[idx];

package/src/level/tiled/TMXLayer.js

@@ -242,7 +242,6 @@ class TMXLayer extends Renderable {
      * @name setRenderer
      * @memberof TMXLayer
      * @public
-     * @function
      * @param {TMXRenderer} renderer
      * @example
      * // use the parent map default renderer
@@ -258,7 +257,6 @@ class TMXLayer extends Renderable {
      * @name getRenderer
      * @memberof TMXLayer
      * @public
-     * @function
      * @returns {TMXRenderer} renderer
      */
     getRenderer() {
@@ -271,7 +269,6 @@ class TMXLayer extends Renderable {
      * @name getTileId
      * @memberof TMXLayer
      * @public
-     * @function
      * @param {number} x X coordinate (in world/pixels coordinates)
      * @param {number} y Y coordinate (in world/pixels coordinates)
      * @returns {number} TileId or null if there is no Tile at the given position
@@ -286,7 +283,6 @@ class TMXLayer extends Renderable {
      * @name getTile
      * @memberof TMXLayer
      * @public
-     * @function
      * @param {number} x X coordinate (in world/pixels coordinates)
      * @param {number} y Y coordinate (in world/pixels coordinates)
      * @returns {Tile} corresponding tile or null if there is no defined tile at the coordinate or if outside of the layer bounds
@@ -312,7 +308,6 @@ class TMXLayer extends Renderable {
      * @name getTile
      * @memberof TMXLayer
      * @public
-     * @function
      * @param {Tile} tile the tile object to be assigned
      * @param {number} x x coordinate (in world/pixels coordinates)
      * @param {number} y y coordinate (in world/pixels coordinates)
@@ -328,7 +323,6 @@ class TMXLayer extends Renderable {
      * @name setTile
      * @memberof TMXLayer
      * @public
-     * @function
      * @param {number} tileId tileId
      * @param {number} x X coordinate (in world/pixels coordinates)
      * @param {number} y Y coordinate (in world/pixels coordinates)
@@ -347,7 +341,6 @@ class TMXLayer extends Renderable {
      * @name cellAt
      * @memberof TMXLayer
      * @public
-     * @function
      * @param {number} x x position of the tile (in Tile unit)
      * @param {number} y x position of the tile (in Tile unit)
      * @param {number} [boundsCheck=true] check first if within the layer bounds
@@ -374,7 +367,6 @@ class TMXLayer extends Renderable {
      * @name clearTile
      * @memberof TMXLayer
      * @public
-     * @function
      * @param {number} x X coordinate (in map coordinates: row/column)
      * @param {number} y Y coordinate (in map coordinates: row/column)
      * @example

package/src/level/tiled/TMXObject.js

@@ -226,7 +226,6 @@ export default class TMXObject {
     /**
      * set the object image (for Tiled Object)
      * @ignore
-     * @function
      */
     setTile(tilesets) {
         // get the corresponding tileset
@@ -247,7 +246,6 @@ export default class TMXObject {
      * @name parseTMXShapes
      * @memberof TMXObject
      * @private
-     * @function
      * @returns {Polygon[]|Line[]|Ellipse[]} an array of shape objects
      */
     parseTMXShapes() {
@@ -318,7 +316,6 @@ export default class TMXObject {
     /**
      * getObjectPropertyByName
      * @ignore
-     * @function
      */
     getObjectPropertyByName(name) {
         return this[name];

package/src/level/tiled/TMXTile.js

@@ -3,10 +3,10 @@ import Sprite from "./../../renderable/sprite.js";
 import Bounds from "./../../physics/bounds.js";
 
 // bitmask constants to check for flipped & rotated tiles
-var TMX_FLIP_H          = 0x80000000,
-    TMX_FLIP_V          = 0x40000000,
-    TMX_FLIP_AD         = 0x20000000,
-    TMX_CLEAR_BIT_MASK  = ~(0x80000000 | 0x40000000 | 0x20000000);
+const TMX_FLIP_H          = 0x80000000,
+      TMX_FLIP_V          = 0x40000000,
+      TMX_FLIP_AD         = 0x20000000,
+      TMX_CLEAR_BIT_MASK  = ~(0x80000000 | 0x40000000 | 0x20000000);
 
 /**
  * @classdesc
@@ -132,7 +132,6 @@ class Tile extends Bounds {
      * return a renderable object for this Tile object
      * @name Tile#getRenderable
      * @public
-     * @function
      * @param {object} [settings] see {@link Sprite}
      * @returns {Renderable} a me.Sprite object
      */