melonjs 10.2.3 → 10.3.0

package/src/renderable/imagelayer.js

@@ -10,9 +10,8 @@ import * as stringUtil from "./../utils/string.js";
  * @classdesc
  * a generic Image Layer Object
  * @class ImageLayer
- * @extends me.Renderable
- * @memberOf me
- * @constructor
+ * @augments me.Renderable
+ * @memberof me
  * @param {number} x x coordinate
  * @param {number} y y coordinate
  * @param {object} settings ImageLayer properties
@@ -166,7 +165,7 @@ class ImageLayer extends Sprite {
     /**
      * resize the Image Layer to match the given size
      * @name resize
-     * @memberOf me.ImageLayer.prototype
+     * @memberof me.ImageLayer.prototype
      * @function
      * @param {number} w new width
      * @param {number} h new height
@@ -256,7 +255,7 @@ class ImageLayer extends Sprite {
      * draw the ImageLayer. <br>
      * automatically called by the game manager {@link me.game}
      * @name draw
-     * @memberOf me.ImageLayer.prototype
+     * @memberof me.ImageLayer.prototype
      * @function
      * @protected
      * @param {me.CanvasRenderer|me.WebGLRenderer} renderer a renderer object

package/src/renderable/nineslicesprite.js

@@ -7,9 +7,8 @@ import Sprite from "./sprite.js";
  * <img src="images/9-slice-scaling.png"/><br>
  * @see https://en.wikipedia.org/wiki/9-slice_scaling
  * @class NineSliceSprite
- * @extends me.Sprite
- * @memberOf me
- * @constructor
+ * @augments me.Sprite
+ * @memberof me
  * @param {number} x the x coordinates of the sprite object
  * @param {number} y the y coordinates of the sprite object
  * @param {object} settings Configuration parameters for the Sprite object

package/src/renderable/renderable.js

@@ -1,6 +1,6 @@
 import ObservableVector2d from "./../math/observable_vector2.js";
 import ObservableVector3d from "./../math/observable_vector3.js";
-import Rect from "./../shapes/rectangle.js";
+import Rect from "./../geometries/rectangle.js";
 import Container from "./container.js";
 import pool from "./../system/pooling.js";
 import { releaseAllPointerEvents } from "./../input/input.js";
@@ -10,9 +10,8 @@ import { clamp } from "./../math/math.js";
  * @classdesc
  * A base class for renderable objects.
  * @class Renderable
- * @extends me.Rect
- * @memberOf me
- * @constructor
+ * @augments me.Rect
+ * @memberof me
  * @param {number} x position of the renderable object (accessible through inherited pos.x property)
  * @param {number} y position of the renderable object (accessible through inherited pos.y property)
  * @param {number} width object width
@@ -40,7 +39,7 @@ class Renderable extends Rect {
          * @type {boolean}
          * @default true
          * @name isKinematic
-         * @memberOf me.Renderable
+         * @memberof me.Renderable
          */
         this.isKinematic = true;
 
@@ -50,7 +49,7 @@ class Renderable extends Rect {
          * @type {me.Body}
          * @see me.Body
          * @name body
-         * @memberOf me.Renderable#
+         * @memberof me.Renderable#
          * @example
          *  // define a new Player Class
          *  class PlayerEntity extends me.Sprite {
@@ -90,7 +89,7 @@ class Renderable extends Rect {
          * @public
          * @type {me.Matrix2d}
          * @name currentTransform
-         * @memberOf me.Renderable#
+         * @memberof me.Renderable#
          */
         if (typeof this.currentTransform === "undefined") {
             this.currentTransform = pool.pull("Matrix2d");
@@ -104,7 +103,7 @@ class Renderable extends Rect {
         * @public
         * @type {string}
         * @name GUID
-        * @memberOf me.Renderable
+        * @memberof me.Renderable
         */
         this.GUID = undefined;
 
@@ -114,7 +113,7 @@ class Renderable extends Rect {
          * @type {Function}
          * @default undefined
          * @name onVisibilityChange
-         * @memberOf me.Renderable#
+         * @memberof me.Renderable#
          * @example
          * this.onVisibilityChange = function(inViewport) {
          *     if (inViewport === true) {
@@ -130,7 +129,7 @@ class Renderable extends Rect {
          * @type {boolean}
          * @default false
          * @name alwaysUpdate
-         * @memberOf me.Renderable
+         * @memberof me.Renderable
          */
         this.alwaysUpdate = false;
 
@@ -140,7 +139,7 @@ class Renderable extends Rect {
          * @type {boolean}
          * @default false
          * @name updateWhenPaused
-         * @memberOf me.Renderable
+         * @memberof me.Renderable
          */
         this.updateWhenPaused = false;
 
@@ -150,7 +149,7 @@ class Renderable extends Rect {
          * @type {boolean}
          * @default false
          * @name isPersistent
-         * @memberOf me.Renderable
+         * @memberof me.Renderable
          */
         this.isPersistent = false;
 
@@ -161,7 +160,7 @@ class Renderable extends Rect {
          * @type {boolean}
          * @default false
          * @name floating
-         * @memberOf me.Renderable
+         * @memberof me.Renderable
          */
         this.floating = false;
 
@@ -177,7 +176,7 @@ class Renderable extends Rect {
          * @type {me.ObservableVector2d}
          * @default <0.5,0.5>
          * @name anchorPoint
-         * @memberOf me.Renderable#
+         * @memberof me.Renderable#
          */
         if (this.anchorPoint instanceof ObservableVector2d) {
             this.anchorPoint.setMuted(0.5, 0.5).setCallback(this.onAnchorUpdate, this);
@@ -192,7 +191,7 @@ class Renderable extends Rect {
          * @type {boolean}
          * @default true
          * @name autoTransform
-         * @memberOf me.Renderable
+         * @memberof me.Renderable
          * @example
          * // enable "automatic" transformation when the object is activated
          * onActivateEvent: function () {
@@ -235,7 +234,7 @@ class Renderable extends Rect {
          * @type {me.Rect|me.Polygon|me.Line|me.Ellipse}
          * @name mask
          * @default undefined
-         * @memberOf me.Renderable#
+         * @memberof me.Renderable#
          * @example
          * // apply a mask in the shape of a Star
          * myNPCSprite.mask = new me.Polygon(myNPCSprite.width / 2, 0, [
@@ -260,7 +259,7 @@ class Renderable extends Rect {
          * @type {me.Color}
          * @name tint
          * @default (255, 255, 255)
-         * @memberOf me.Renderable#
+         * @memberof me.Renderable#
          * @example
          * // add a red tint to this renderable
          * this.tint.setColor(255, 128, 128);
@@ -275,7 +274,7 @@ class Renderable extends Rect {
          * @type {string}
          * @name name
          * @default ""
-         * @memberOf me.Renderable
+         * @memberof me.Renderable
          */
         this.name = "";
 
@@ -284,7 +283,7 @@ class Renderable extends Rect {
          * @public
          * @type {me.ObservableVector3d}
          * @name pos
-         * @memberOf me.Renderable#
+         * @memberof me.Renderable#
          */
         if (this.pos instanceof ObservableVector3d) {
             this.pos.setMuted(x, y, 0).setCallback(this.updateBoundsPos, this);
@@ -297,7 +296,7 @@ class Renderable extends Rect {
          * @type {boolean}
          * @name isDirty
          * @default false
-         * @memberOf me.Renderable#
+         * @memberof me.Renderable#
          */
         this.isDirty = false;
 
@@ -321,7 +320,7 @@ class Renderable extends Rect {
      * @readonly
      * @type {boolean}
      * @name isFloating
-     * @memberOf me.Renderable
+     * @memberof me.Renderable
      */
     get isFloating() {
         return this.floating === true || (typeof this.ancestor !== "undefined" && this.ancestor.floating === true);
@@ -334,7 +333,7 @@ class Renderable extends Rect {
      * @type {boolean}
      * @default false
      * @name inViewport
-     * @memberOf me.Renderable
+     * @memberof me.Renderable
      */
 
     get inViewport() {
@@ -356,7 +355,7 @@ class Renderable extends Rect {
      * @see me.Renderable#flipX
      * @type {boolean}
      * @name isFlippedX
-     * @memberOf me.Renderable
+     * @memberof me.Renderable
      */
 
     get isFlippedX() {
@@ -369,7 +368,7 @@ class Renderable extends Rect {
      * @see me.Renderable#flipY
      * @type {boolean}
      * @name isFlippedY
-     * @memberOf me.Renderable
+     * @memberof me.Renderable
      */
 
     get isFlippedY() {
@@ -379,7 +378,7 @@ class Renderable extends Rect {
     /**
      * returns the bounding box for this renderable
      * @name getBounds
-     * @memberOf me.Renderable.prototype
+     * @memberof me.Renderable.prototype
      * @function
      * @returns {me.Bounds} bounding box Rectangle object
      */
@@ -400,7 +399,7 @@ class Renderable extends Rect {
     /**
      * get the renderable alpha channel value<br>
      * @name getOpacity
-     * @memberOf me.Renderable.prototype
+     * @memberof me.Renderable.prototype
      * @function
      * @returns {number} current opacity value between 0 and 1
      */
@@ -411,7 +410,7 @@ class Renderable extends Rect {
     /**
      * set the renderable alpha channel value<br>
      * @name setOpacity
-     * @memberOf me.Renderable.prototype
+     * @memberof me.Renderable.prototype
      * @function
      * @param {number} alpha opacity value between 0.0 and 1.0
      */
@@ -430,7 +429,7 @@ class Renderable extends Rect {
      * flip the renderable on the horizontal axis (around the center of the renderable)
      * @see me.Matrix2d#scaleX
      * @name flipX
-     * @memberOf me.Renderable.prototype
+     * @memberof me.Renderable.prototype
      * @function
      * @param {boolean} [flip=true] `true` to flip this renderable.
      * @returns {me.Renderable} Reference to this object for method chaining
@@ -445,7 +444,7 @@ class Renderable extends Rect {
      * flip the renderable on the vertical axis (around the center of the renderable)
      * @see me.Matrix2d#scaleY
      * @name flipY
-     * @memberOf me.Renderable.prototype
+     * @memberof me.Renderable.prototype
      * @function
      * @param {boolean} [flip=true] `true` to flip this renderable.
      * @returns {me.Renderable} Reference to this object for method chaining
@@ -459,7 +458,7 @@ class Renderable extends Rect {
     /**
      * multiply the renderable currentTransform with the given matrix
      * @name transform
-     * @memberOf me.Renderable.prototype
+     * @memberof me.Renderable.prototype
      * @see me.Renderable#currentTransform
      * @function
      * @param {me.Matrix2d} m the transformation matrix
@@ -476,7 +475,7 @@ class Renderable extends Rect {
     /**
      * return the angle to the specified target
      * @name angleTo
-     * @memberOf me.Renderable
+     * @memberof me.Renderable
      * @function
      * @param {me.Renderable|me.Vector2d|me.Vector3d} target
      * @returns {number} angle in radians
@@ -500,7 +499,7 @@ class Renderable extends Rect {
     /**
      * return the distance to the specified target
      * @name distanceTo
-     * @memberOf me.Renderable
+     * @memberof me.Renderable
      * @function
      * @param {me.Renderable|me.Vector2d|me.Vector3d} target
      * @returns {number} distance
@@ -524,7 +523,7 @@ class Renderable extends Rect {
     /**
      * Rotate this renderable towards the given target.
      * @name lookAt
-     * @memberOf me.Renderable.prototype
+     * @memberof me.Renderable.prototype
      * @function
      * @param {me.Renderable|me.Vector2d|me.Vector3d} target the renderable or position to look at
      * @returns {me.Renderable} Reference to this object for method chaining
@@ -548,7 +547,7 @@ class Renderable extends Rect {
     /**
      * Rotate this renderable by the specified angle (in radians).
      * @name rotate
-     * @memberOf me.Renderable.prototype
+     * @memberof me.Renderable.prototype
      * @function
      * @param {number} angle The angle to rotate (in radians)
      * @param {me.Vector2d|me.ObservableVector2d} [v] an optional point to rotate around
@@ -570,7 +569,7 @@ class Renderable extends Rect {
      * is an image, the image.width and image.height properties are unaltered but the currentTransform
      * member will be changed.
      * @name scale
-     * @memberOf me.Renderable.prototype
+     * @memberof me.Renderable.prototype
      * @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.
@@ -586,7 +585,7 @@ class Renderable extends Rect {
     /**
      * scale the renderable around his anchor point
      * @name scaleV
-     * @memberOf me.Renderable.prototype
+     * @memberof me.Renderable.prototype
      * @function
      * @param {me.Vector2d} v scaling vector
      * @returns {me.Renderable} Reference to this object for method chaining
@@ -600,7 +599,7 @@ class Renderable extends Rect {
      * update function. <br>
      * automatically called by the game manager {@link me.game}
      * @name update
-     * @memberOf me.Renderable.prototype
+     * @memberof me.Renderable.prototype
      * @function
      * @protected
      * @param {number} dt time since the last update in milliseconds.
@@ -614,7 +613,7 @@ class Renderable extends Rect {
      * update the bounding box for this shape.
      * @ignore
      * @name updateBounds
-     * @memberOf me.Renderable.prototype
+     * @memberof me.Renderable.prototype
      * @function
      * @returns {me.Bounds} this shape bounding box Rectangle object
      */
@@ -628,7 +627,7 @@ class Renderable extends Rect {
      * update the renderable's bounding rect (private)
      * @ignore
      * @name updateBoundsPos
-     * @memberOf me.Renderable.prototype
+     * @memberof me.Renderable.prototype
      * @function
      */
      updateBoundsPos(newX, newY) {
@@ -660,7 +659,7 @@ class Renderable extends Rect {
      /**
       * return the renderable absolute position in the game world
       * @name getAbsolutePosition
-      * @memberOf me.Renderable.prototype
+      * @memberof me.Renderable.prototype
       * @function
       * @returns {me.Vector2d}
       */
@@ -680,7 +679,7 @@ class Renderable extends Rect {
      * called when the anchor point value is changed
      * @private
      * @name onAnchorUpdate
-     * @memberOf me.Renderable.prototype
+     * @memberof me.Renderable.prototype
      * @function
      * @param {number} x the new X value to be set for the anchor
      * @param {number} y the new Y value to be set for the anchor
@@ -698,7 +697,7 @@ class Renderable extends Rect {
      * (apply defined transforms, anchor point). <br>
      * automatically called by the game manager {@link me.game}
      * @name preDraw
-     * @memberOf me.Renderable.prototype
+     * @memberof me.Renderable.prototype
      * @function
      * @protected
      * @param {me.CanvasRenderer|me.WebGLRenderer} renderer a renderer object
@@ -749,7 +748,7 @@ class Renderable extends Rect {
      * object draw. <br>
      * automatically called by the game manager {@link me.game}
      * @name draw
-     * @memberOf me.Renderable.prototype
+     * @memberof me.Renderable.prototype
      * @function
      * @protected
      * @param {me.CanvasRenderer|me.WebGLRenderer} renderer a renderer object
@@ -762,7 +761,7 @@ class Renderable extends Rect {
      * restore the rendering context after drawing. <br>
      * automatically called by the game manager {@link me.game}
      * @name postDraw
-     * @memberOf me.Renderable.prototype
+     * @memberof me.Renderable.prototype
      * @function
      * @protected
      * @param {me.CanvasRenderer|me.WebGLRenderer} renderer a renderer object
@@ -788,7 +787,7 @@ class Renderable extends Rect {
      * onCollision callback, triggered in case of collision,
      * when this renderable body is colliding with another one
      * @name onCollision
-     * @memberOf me.Renderable.prototype
+     * @memberof me.Renderable.prototype
      * @function
      * @param {me.collision.ResponseObject} response the collision response object
      * @param {me.Renderable} other the other renderable touching this one (a reference to response.a or response.b)
@@ -865,7 +864,7 @@ class Renderable extends Rect {
      * OnDestroy Notification function<br>
      * Called by engine before deleting the object
      * @name onDestroyEvent
-     * @memberOf me.Renderable
+     * @memberof me.Renderable
      * @function
      */
     onDestroyEvent() {

package/src/renderable/sprite.js

@@ -10,9 +10,8 @@ import Renderable from "./renderable.js";
  * @classdesc
  * An object to display a fixed or animated sprite on screen.
  * @class Sprite
- * @extends me.Renderable
- * @memberOf me
- * @constructor
+ * @augments me.Renderable
+ * @memberof me
  * @param {number} x the x coordinates of the sprite object
  * @param {number} y the y coordinates of the sprite object
  * @param {object} settings Configuration parameters for the Sprite object
@@ -79,7 +78,7 @@ class Sprite extends Renderable {
          * @type {me.Vector2d}
          * @default <0.0,0.0>
          * @name offset
-         * @memberOf me.Sprite#
+         * @memberof me.Sprite#
          */
         this.offset = pool.pull("Vector2d", 0, 0);
 
@@ -88,7 +87,7 @@ class Sprite extends Renderable {
          * @public
          * @type {me.Renderer.Texture}
          * @name source
-         * @memberOf me.Sprite#
+         * @memberof me.Sprite#
          */
         this.source = null;
 
@@ -217,7 +216,7 @@ class Sprite extends Renderable {
     /**
      * return the flickering state of the object
      * @name isFlickering
-     * @memberOf me.Sprite.prototype
+     * @memberof me.Sprite.prototype
      * @function
      * @returns {boolean}
      */
@@ -228,7 +227,7 @@ class Sprite extends Renderable {
     /**
      * make the object flicker
      * @name flicker
-     * @memberOf me.Sprite.prototype
+     * @memberof me.Sprite.prototype
      * @function
      * @param {number} duration expressed in milliseconds
      * @param {Function} callback Function to call when flickering ends
@@ -259,7 +258,7 @@ class Sprite extends Renderable {
      * logic as per the following example :<br>
      * <img src="images/spritesheet_grid.png"/>
      * @name addAnimation
-     * @memberOf me.Sprite.prototype
+     * @memberof me.Sprite.prototype
      * @function
      * @param {string} name animation id
      * @param {number[]|string[]|object[]} index list of sprite index or name
@@ -359,7 +358,7 @@ class Sprite extends Renderable {
      * set the current animation
      * this will always change the animation & set the frame to zero
      * @name setCurrentAnimation
-     * @memberOf me.Sprite.prototype
+     * @memberof me.Sprite.prototype
      * @function
      * @param {string} name animation id
      * @param {string|Function} [resetAnim] animation id to switch to when complete, or callback
@@ -420,7 +419,7 @@ class Sprite extends Renderable {
     /**
      * reverse the given or current animation if none is specified
      * @name reverseAnimation
-     * @memberOf me.Sprite.prototype
+     * @memberof me.Sprite.prototype
      * @function
      * @param {string} [name] animation id
      * @returns {me.Sprite} Reference to this object for method chaining
@@ -439,7 +438,7 @@ class Sprite extends Renderable {
     /**
      * return true if the specified animation is the current one.
      * @name isCurrentAnimation
-     * @memberOf me.Sprite.prototype
+     * @memberof me.Sprite.prototype
      * @function
      * @param {string} name animation id
      * @returns {boolean}
@@ -456,7 +455,7 @@ class Sprite extends Renderable {
      * change the current texture atlas region for this sprite
      * @see me.Texture.getRegion
      * @name setRegion
-     * @memberOf me.Sprite.prototype
+     * @memberof me.Sprite.prototype
      * @function
      * @param {object} region typically returned through me.Texture.getRegion()
      * @returns {me.Sprite} Reference to this object for method chaining
@@ -488,7 +487,7 @@ class Sprite extends Renderable {
     /**
      * force the current animation frame index.
      * @name setAnimationFrame
-     * @memberOf me.Sprite.prototype
+     * @memberof me.Sprite.prototype
      * @function
      * @param {number} [idx=0] animation frame index
      * @returns {me.Sprite} Reference to this object for method chaining
@@ -504,7 +503,7 @@ class Sprite extends Renderable {
     /**
      * return the current animation frame index.
      * @name getCurrentAnimationFrame
-     * @memberOf me.Sprite.prototype
+     * @memberof me.Sprite.prototype
      * @function
      * @returns {number} current animation frame index
      */
@@ -515,7 +514,7 @@ class Sprite extends Renderable {
     /**
      * Returns the frame object by the index.
      * @name getAnimationFrameObjectByIndex
-     * @memberOf me.Sprite.prototype
+     * @memberof me.Sprite.prototype
      * @function
      * @ignore
      * @param {number} id the frame id
@@ -529,7 +528,7 @@ class Sprite extends Renderable {
      * update function. <br>
      * automatically called by the game manager {@link me.game}
      * @name update
-     * @memberOf me.Sprite.prototype
+     * @memberof me.Sprite.prototype
      * @function
      * @protected
      * @param {number} dt time since the last update in milliseconds.
@@ -608,7 +607,7 @@ class Sprite extends Renderable {
      * sprite draw. <br>
      * automatically called by the game manager {@link me.game}
      * @name draw
-     * @memberOf me.Sprite.prototype
+     * @memberof me.Sprite.prototype
      * @function
      * @protected
      * @param {me.CanvasRenderer|me.WebGLRenderer} renderer a renderer object

package/src/renderable/trigger.js

@@ -1,7 +1,7 @@
 import Renderable from "./renderable.js";
 import collision from "./../physics/collision.js";
 import Body from "./../physics/body.js";
-import Rect from "./../shapes/rectangle.js";
+import Rect from "./../geometries/rectangle.js";
 import level from "./../level/level.js";
 import { world, viewport } from "./../game.js";
 
@@ -9,9 +9,8 @@ import { world, viewport } from "./../game.js";
  * @classdesc
  * trigger an event when colliding with another object
  * @class Trigger
- * @extends me.Renderable
- * @memberOf me
- * @constructor
+ * @augments me.Renderable
+ * @memberof me
  * @param {number} x the x coordinates of the trigger area
  * @param {number} y the y coordinates of the trigger area
  * @param {number} [settings.width] width of the trigger area
@@ -104,7 +103,7 @@ class Trigger extends Renderable {
     /**
      * trigger this event
      * @name triggerEvent
-     * @memberOf me.Trigger
+     * @memberof me.Trigger
      * @function
      * @protected
      */

package/src/state/stage.js

@@ -16,9 +16,8 @@ var default_settings = {
  * every "stage" object (title screen, credits, ingame, etc...) to be managed
  * through the state manager must inherit from this base class.
  * @class Stage
- * @extends me.Object
- * @memberOf me
- * @constructor
+ * @augments me.Object
+ * @memberof me
  * @param {object} [options] The stage` parameters
  * @param {me.Camera2d[]} [options.cameras=[new me.Camera2d()]] a list of cameras (experimental)
  * @param {Function} [options.onResetEvent] called by the state manager when reseting the object
@@ -38,7 +37,7 @@ class Stage {
          * @public
          * @type {Map}
          * @name cameras
-         * @memberOf me.Stage
+         * @memberof me.Stage
          */
         this.cameras = new Map();
 
@@ -46,7 +45,7 @@ class Stage {
          * The given constructor options
          * @public
          * @name settings
-         * @memberOf me.Stage
+         * @memberof me.Stage
          * @type {object}
          */
         this.settings = Object.assign(default_settings, settings || {});
@@ -84,7 +83,7 @@ class Stage {
     /**
      * update function
      * @name update
-     * @memberOf me.Stage
+     * @memberof me.Stage
      * @ignore
      * @function
      * @param {number} dt time since the last update in milliseconds.
@@ -108,7 +107,7 @@ class Stage {
     /**
      * draw the current stage
      * @name draw
-     * @memberOf me.Stage
+     * @memberof me.Stage
      * @ignore
      * @function
      * @param {me.CanvasRenderer|me.WebGLRenderer} renderer a renderer object
@@ -137,7 +136,7 @@ class Stage {
      * called by the state manager when reseting the object
      * this is typically where you will load a level, add renderables, etc...
      * @name onResetEvent
-     * @memberOf me.Stage
+     * @memberof me.Stage
      * @function
      * @param {object} [...arguments] optional arguments passed when switching state
      * @see me.state#change
@@ -154,7 +153,7 @@ class Stage {
      * onDestroyEvent function<br>
      * called by the state manager before switching to another state
      * @name onDestroyEvent
-     * @memberOf me.Stage
+     * @memberof me.Stage
      * @function
      */
     onDestroyEvent() {