melonjs 10.9.0 → 10.12.0

package/src/geometries/poly.js

@@ -9,11 +9,10 @@ import pool from "./../system/pooling.js";
  * A polygon is convex when all line segments connecting two points in the interior do not cross any edge of the polygon
  * (which means that all angles are less than 180 degrees), as described here below : <br>
  * <center><img src="images/convex_polygon.png"/></center><br>
- * A polygon's `winding` is clockwise iff its vertices (points) are declared turning to the right. The image above shows COUNTERCLOCKWISE winding.
+ *
+ * A polygon's `winding` is clockwise if its vertices (points) are declared turning to the right. The image above shows COUNTERCLOCKWISE winding.
  */
-
 class Polygon {
-
     /**
      * @param {number} x origin point of the Polygon
      * @param {number} y origin point of the Polygon
@@ -25,16 +24,16 @@ class Polygon {
          * @public
          * @type {Vector2d}
          * @name pos
-         * @memberof Polygon.prototype
+         * @memberof Polygon
          */
         this.pos = pool.pull("Vector2d");
 
         /**
          * The bounding rectangle for this shape
          * @ignore
-         * @type {Bounds}
+         * @member {Bounds}
          * @name _bounds
-         * @memberof Polygon.prototype
+         * @memberof Polygon
          */
         this._bounds;
 
@@ -44,7 +43,7 @@ class Polygon {
          * @public
          * @type {Vector2d[]}
          * @name points
-         * @memberof Polygon.prototype
+         * @memberof Polygon
          */
         this.points = [];
 
@@ -83,8 +82,7 @@ class Polygon {
     /**
      * set new value to the Polygon
      * @name setShape
-     * @memberof Polygon.prototype
-     * @function
+     * @memberof Polygon
      * @param {number} x position of the Polygon
      * @param {number} y position of the Polygon
      * @param {Vector2d[]|number[]} points array of vector or vertice defining the Polygon
@@ -99,8 +97,7 @@ class Polygon {
     /**
      * set the vertices defining this Polygon
      * @name setVertices
-     * @memberof Polygon.prototype
-     * @function
+     * @memberof Polygon
      * @param {Vector2d[]} vertices array of vector or vertice defining the Polygon
      * @returns {Polygon} this instance for objecf chaining
      */
@@ -139,8 +136,7 @@ class Polygon {
     /**
      * apply the given transformation matrix to this Polygon
      * @name transform
-     * @memberof Polygon.prototype
-     * @function
+     * @memberof Polygon
      * @param {Matrix2d} m the transformation matrix
      * @returns {Polygon} Reference to this object for method chaining
      */
@@ -158,8 +154,7 @@ class Polygon {
     /**
      * apply an isometric projection to this shape
      * @name toIso
-     * @memberof Polygon.prototype
-     * @function
+     * @memberof Polygon
      * @returns {Polygon} Reference to this object for method chaining
      */
     toIso() {
@@ -169,8 +164,7 @@ class Polygon {
     /**
      * apply a 2d projection to this shape
      * @name to2d
-     * @memberof Polygon.prototype
-     * @function
+     * @memberof Polygon
      * @returns {Polygon} Reference to this object for method chaining
      */
     to2d() {
@@ -180,8 +174,7 @@ class Polygon {
     /**
      * Rotate this Polygon (counter-clockwise) by the specified angle (in radians).
      * @name rotate
-     * @memberof Polygon.prototype
-     * @function
+     * @memberof Polygon
      * @param {number} angle The angle to rotate (in radians)
      * @param {Vector2d|ObservableVector2d} [v] an optional point to rotate around
      * @returns {Polygon} Reference to this object for method chaining
@@ -202,8 +195,7 @@ class Polygon {
     /**
      * Scale this Polygon by the given scalar.
      * @name scale
-     * @memberof Polygon.prototype
-     * @function
+     * @memberof Polygon
      * @param {number} x
      * @param {number} [y=x]
      * @returns {Polygon} Reference to this object for method chaining
@@ -224,8 +216,7 @@ class Polygon {
     /**
      * Scale this Polygon by the given vector
      * @name scaleV
-     * @memberof Polygon.prototype
-     * @function
+     * @memberof Polygon
      * @param {Vector2d} v
      * @returns {Polygon} Reference to this object for method chaining
      */
@@ -237,8 +228,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
-     * @function
+     * @memberof Polygon
      * @returns {Polygon} Reference to this object for method chaining
      */
     recalc() {
@@ -281,8 +271,7 @@ class Polygon {
     /**
      * returns a list of indices for all triangles defined in this polygon
      * @name getIndices
-     * @memberof Polygon.prototype
-     * @function
+     * @memberof Polygon
      * @returns {Array} an array of vertex indices for all triangles forming this polygon.
      */
     getIndices() {
@@ -295,8 +284,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
-     * @function
+     * @memberof Polygon
      * @returns {boolean} true if the vertices are convex, false if not, null if not computable
      */
     isConvex() {
@@ -342,8 +330,8 @@ class Polygon {
     /**
      * translate the Polygon by the specified offset
      * @name translate
-     * @memberof Polygon.prototype
-     * @function
+     * @memberof Polygon
+     * @method
      * @param {number} x x offset
      * @param {number} y y offset
      * @returns {Polygon} this Polygon
@@ -351,8 +339,7 @@ class Polygon {
     /**
      * translate the Polygon by the specified vector
      * @name translate
-     * @memberof Polygon.prototype
-     * @function
+     * @memberof Polygon
      * @param {Vector2d} v vector offset
      * @returns {Polygon} Reference to this object for method chaining
      */
@@ -379,15 +366,14 @@ class Polygon {
     /**
      * Shifts the Polygon to the given position vector.
      * @name shift
-     * @memberof Polygon.prototype
-     * @function
+     * @memberof Polygon
+     * @method
      * @param {Vector2d} position
      */
     /**
      * Shifts the Polygon to the given x, y position.
      * @name shift
-     * @memberof Polygon.prototype
-     * @function
+     * @memberof Polygon
      * @param {number} x
      * @param {number} y
      */
@@ -412,8 +398,8 @@ 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
-     * @function
+     * @memberof Polygon
+     * @method
      * @param {Vector2d} point
      * @returns {boolean} true if contains
      */
@@ -423,8 +409,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
-     * @function
+     * @memberof Polygon
      * @param  {number} x x coordinate
      * @param  {number} y y coordinate
      * @returns {boolean} true if contains
@@ -461,8 +446,7 @@ class Polygon {
     /**
      * returns the bounding box for this shape, the smallest Rectangle object completely containing this shape.
      * @name getBounds
-     * @memberof Polygon.prototype
-     * @function
+     * @memberof Polygon
      * @returns {Bounds} this shape bounding box Rectangle object
      */
     getBounds() {
@@ -476,8 +460,7 @@ class Polygon {
      * update the bounding box for this shape.
      * @ignore
      * @name updateBounds
-     * @memberof Polygon.prototype
-     * @function
+     * @memberof Polygon
      * @returns {Bounds} this shape bounding box Rectangle object
      */
     updateBounds() {
@@ -492,8 +475,7 @@ class Polygon {
     /**
      * clone this Polygon
      * @name clone
-     * @memberof Polygon.prototype
-     * @function
+     * @memberof Polygon
      * @returns {Polygon} new Polygon
      */
     clone() {

package/src/geometries/rectangle.js

@@ -32,8 +32,7 @@ class Rect extends Polygon {
     /**
      * set new value to the rectangle shape
      * @name setShape
-     * @memberof Rect.prototype
-     * @function
+     * @memberof Rect
      * @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
@@ -63,7 +62,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name left
-     * @memberof Rect.prototype
+     * @memberof Rect
      */
     get left() {
         return this.pos.x;
@@ -74,7 +73,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name right
-     * @memberof Rect.prototype
+     * @memberof Rect
      */
     get right() {
         var w = this.width;
@@ -86,7 +85,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name top
-     * @memberof Rect.prototype
+     * @memberof Rect
      */
     get top() {
         return this.pos.y;
@@ -97,7 +96,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name bottom
-     * @memberof Rect.prototype
+     * @memberof Rect
      */
     get bottom() {
         var h = this.height;
@@ -109,7 +108,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name width
-     * @memberof Rect.prototype
+     * @memberof Rect
      */
     get width() {
         return this.points[2].x;
@@ -125,7 +124,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name height
-     * @memberof Rect.prototype
+     * @memberof Rect
      */
     get height() {
         return this.points[2].y;
@@ -141,7 +140,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name centerX
-     * @memberof Rect.prototype
+     * @memberof Rect
      */
     get centerX() {
         if (isFinite(this.width)) {
@@ -159,7 +158,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name centerY
-     * @memberof Rect.prototype
+     * @memberof Rect
      */
     get centerY() {
         if (isFinite(this.height)) {
@@ -175,10 +174,9 @@ class Rect extends Polygon {
     /**
      * center the rectangle position around the given coordinates
      * @name centerOn
-     * @memberof Rect.prototype
-     * @function
+     * @memberof Rect
      * @param {number} x the x coordinate around which to center this rectangle
-     * @param {number} x the y coordinate around which to center this rectangle
+     * @param {number} y the y coordinate around which to center this rectangle
      * @returns {Rect} this rectangle
      */
     centerOn(x, y) {
@@ -190,8 +188,7 @@ class Rect extends Polygon {
     /**
      * resize the rectangle
      * @name resize
-     * @memberof Rect.prototype
-     * @function
+     * @memberof Rect
      * @param {number} w new width of the rectangle
      * @param {number} h new height of the rectangle
      * @returns {Rect} this rectangle
@@ -205,8 +202,7 @@ class Rect extends Polygon {
     /**
      * scale the rectangle
      * @name scale
-     * @memberof Rect.prototype
-     * @function
+     * @memberof Rect
      * @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
@@ -220,8 +216,7 @@ class Rect extends Polygon {
     /**
      * clone this rectangle
      * @name clone
-     * @memberof Rect.prototype
-     * @function
+     * @memberof Rect
      * @returns {Rect} new rectangle
      */
     clone() {
@@ -231,8 +226,7 @@ class Rect extends Polygon {
     /**
      * copy the position and size of the given rectangle into this one
      * @name copy
-     * @memberof Rect.prototype
-     * @function
+     * @memberof Rect
      * @param {Rect} rect Source rectangle
      * @returns {Rect} new rectangle
      */
@@ -243,8 +237,7 @@ class Rect extends Polygon {
     /**
      * merge this rectangle with another one
      * @name union
-     * @memberof Rect.prototype
-     * @function
+     * @memberof Rect
      * @param {Rect} rect other rectangle to union with
      * @returns {Rect} the union(ed) rectangle
      */
@@ -265,8 +258,7 @@ class Rect extends Polygon {
     /**
      * check if this rectangle is intersecting with the specified one
      * @name overlaps
-     * @memberof Rect.prototype
-     * @function
+     * @memberof Rect
      * @param {Rect} rect
      * @returns {boolean} true if overlaps
      */
@@ -282,8 +274,8 @@ class Rect extends Polygon {
     /**
      * Returns true if the rectangle contains the given rectangle
      * @name contains
-     * @memberof Rect.prototype
-     * @function
+     * @memberof Rect
+     * @method
      * @param {Rect} rect
      * @returns {boolean} true if contains
      */
@@ -291,8 +283,8 @@ class Rect extends Polygon {
     /**
      * Returns true if the rectangle contains the given point
      * @name contains
-     * @memberof Rect.prototype
-     * @function
+     * @memberof Rect
+     * @method
      * @param  {number} x x coordinate
      * @param  {number} y y coordinate
      * @returns {boolean} true if contains
@@ -301,8 +293,7 @@ class Rect extends Polygon {
     /**
      * Returns true if the rectangle contains the given point
      * @name contains
-     * @memberof Rect.prototype
-     * @function
+     * @memberof Rect
      * @param {Vector2d} point
      * @returns {boolean} true if contains
      */
@@ -337,8 +328,7 @@ class Rect extends Polygon {
     /**
      * check if this rectangle is identical to the specified one
      * @name equals
-     * @memberof Rect.prototype
-     * @function
+     * @memberof Rect
      * @param {Rect} rect
      * @returns {boolean} true if equals
      */
@@ -354,8 +344,7 @@ class Rect extends Polygon {
     /**
      * determines whether all coordinates of this rectangle are finite numbers.
      * @name isFinite
-     * @memberof Rect.prototype
-     * @function
+     * @memberof Rect
      * @returns {boolean} false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
      */
     isFinite() {
@@ -365,8 +354,7 @@ class Rect extends Polygon {
     /**
      * Returns a polygon whose edges are the same as this box.
      * @name toPolygon
-     * @memberof Rect.prototype
-     * @function
+     * @memberof Rect
      * @returns {Polygon} a new Polygon that represents this rectangle.
      */
     toPolygon() {

package/src/geometries/roundrect.js

@@ -36,7 +36,7 @@ class RoundRect extends Rect {
      * @type {number}
      * @default 20
      * @name radius
-     * @memberof RoundRect.prototype
+     * @memberof RoundRect
      */
     get radius() {
         return this._radius;
@@ -55,8 +55,7 @@ class RoundRect extends Rect {
     /**
      * copy the position, size and radius of the given rounded rectangle into this one
      * @name copy
-     * @memberof RoundRect.prototype
-     * @function
+     * @memberof RoundRect
      * @param {RoundRect} rrect source rounded rectangle
      * @returns {RoundRect} new rectangle
      */
@@ -69,8 +68,8 @@ class RoundRect extends Rect {
     /**
      * Returns true if the rounded rectangle contains the given point
      * @name contains
-     * @memberof RoundRect.prototype
-     * @function
+     * @memberof RoundRect
+     * @method
      * @param  {number} x x coordinate
      * @param  {number} y y coordinate
      * @returns {boolean} true if contains
@@ -79,8 +78,7 @@ class RoundRect extends Rect {
     /**
      * Returns true if the rounded rectangle contains the given point
      * @name contains
-     * @memberof RoundRect.prototype
-     * @function
+     * @memberof RoundRect
      * @param {Vector2d} point
      * @returns {boolean} true if contains
      */
@@ -140,8 +138,7 @@ class RoundRect extends Rect {
     /**
      * check if this RoundRect is identical to the specified one
      * @name equals
-     * @memberof RoundRect.prototype
-     * @function
+     * @memberof RoundRect
      * @param {RoundRect} rrect
      * @returns {boolean} true if equals
      */
@@ -152,12 +149,11 @@ class RoundRect extends Rect {
     /**
      * clone this RoundRect
      * @name clone
-     * @memberof RoundRect.prototype
-     * @function
+     * @memberof RoundRect
      * @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

@@ -41,7 +41,8 @@ import WebGLCompositor from "./video/webgl/webgl_compositor.js";
 import Renderer from "./video/renderer.js";
 import WebGLRenderer from "./video/webgl/webgl_renderer.js";
 import CanvasRenderer from "./video/canvas/canvas_renderer.js";
-import { TextureAtlas } from "./video/texture.js";
+import CanvasTexture from "./video/texture/canvas_texture.js";
+import { TextureAtlas } from "./video/texture/atlas.js";
 import Renderable from "./renderable/renderable.js";
 import Text from "./text/text.js";
 import BitmapText from "./text/bitmaptext.js";
@@ -53,6 +54,7 @@ import NineSliceSprite from "./renderable/nineslicesprite.js";
 import GUI_Object from "./renderable/GUI.js";
 import Collectable from "./renderable/collectable.js";
 import Trigger from "./renderable/trigger.js";
+import Light2d from "./renderable/light2d.js";
 import { Draggable, DropTarget } from "./renderable/dragndrop.js";
 import TMXRenderer from "./level/tiled/renderer/TMXRenderer.js";
 import TMXOrthogonalRenderer from "./level/tiled/renderer/TMXOrthogonalRenderer.js";
@@ -140,6 +142,7 @@ export {
     GUI_Object,
     Collectable,
     Trigger,
+    Light2d,
     Draggable,
     DropTarget,
     TMXRenderer,
@@ -190,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)
@@ -202,6 +204,7 @@ export function boot() {
     pool.register("me.Entity", Entity);
     pool.register("me.Collectable", Collectable);
     pool.register("me.Trigger", Trigger);
+    pool.register("me.Light2d", Light2d);
     pool.register("me.Tween", Tween, true);
     pool.register("me.Color", Color, true);
     pool.register("me.Particle", Particle, true);
@@ -230,6 +233,7 @@ export function boot() {
     pool.register("Entity", Entity);
     pool.register("Collectable", Collectable);
     pool.register("Trigger", Trigger);
+    pool.register("Light2d", Light2d);
     pool.register("Tween", Tween, true);
     pool.register("Color", Color, true);
     pool.register("Particle", Particle, true);
@@ -253,6 +257,7 @@ export function boot() {
     pool.register("Line", Line, true);
     pool.register("Ellipse", Ellipse, true);
     pool.register("Bounds", Bounds, true);
+    pool.register("CanvasTexture", CanvasTexture, true);
 
     // publish Boot notification
     event.emit(event.BOOT);

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);