melonjs 10.2.3 → 10.5.0

package/src/entity/entity.js

@@ -2,38 +2,32 @@ import Vector2d from "./../math/vector2.js";
 import Renderable from "./../renderable/renderable.js";
 import Sprite from "./../renderable/sprite.js";
 import Body from "./../physics/body.js";
-import Polygon from "./../shapes/poly.js";
+import Polygon from "./../geometries/poly.js";
 
 
 /**
+ * @classdesc
  * a Generic Object Entity
- * @class Entity
- * @extends me.Renderable
- * @memberOf me
- * @see me.Renderable
- * @constructor
- * @param {number} x the x coordinates of the entity object
- * @param {number} y the y coordinates of the entity object
- * @param {object} settings Entity properties, to be defined through Tiled or when calling the entity constructor
- * <img src="images/object_properties.png"/>
- * @param {number} settings.width the physical width the entity takes up in game
- * @param {number} settings.height the physical height the entity takes up in game
- * @param {string} [settings.name] object entity name
- * @param {string} [settings.id] object unique IDs
- * @param {Image|string} [settings.image] resource name of a spritesheet to use for the entity renderable component
- * @param {me.Vector2d} [settings.anchorPoint=0.0] Entity anchor point
- * @param {number} [settings.framewidth=settings.width] width of a single frame in the given spritesheet
- * @param {number} [settings.frameheight=settings.width] height of a single frame in the given spritesheet
- * @param {string} [settings.type] object type
- * @param {number} [settings.collisionMask] Mask collision detection for this object
- * @param {me.Rect[]|me.Polygon[]|me.Line[]|me.Ellipse[]} [settings.shapes] the initial list of collision shapes (usually populated through Tiled)
+ * @augments Renderable
+ * @see Renderable
  */
-
 class Entity extends Renderable {
-
-
     /**
-     * @ignore
+     * @param {number} x the x coordinates of the entity object
+     * @param {number} y the y coordinates of the entity object
+     * @param {object} settings Entity properties, to be defined through Tiled or when calling the entity constructor
+     * <img src="images/object_properties.png"/>
+     * @param {number} settings.width the physical width the entity takes up in game
+     * @param {number} settings.height the physical height the entity takes up in game
+     * @param {string} [settings.name] object entity name
+     * @param {string} [settings.id] object unique IDs
+     * @param {Image|string} [settings.image] resource name of a spritesheet to use for the entity renderable component
+     * @param {Vector2d} [settings.anchorPoint=0.0] Entity anchor point
+     * @param {number} [settings.framewidth=settings.width] width of a single frame in the given spritesheet
+     * @param {number} [settings.frameheight=settings.width] height of a single frame in the given spritesheet
+     * @param {string} [settings.type] object type
+     * @param {number} [settings.collisionMask] Mask collision detection for this object
+     * @param {Rect[]|Polygon[]|Line[]|Ellipse[]} [settings.shapes] the initial list of collision shapes (usually populated through Tiled)
      */
     constructor(x, y, settings) {
 
@@ -76,7 +70,7 @@ class Entity extends Renderable {
          * @public
          * @type {string}
          * @name type
-         * @memberOf me.Entity
+         * @memberof Entity
          */
         this.type = settings.type || "";
 
@@ -85,7 +79,7 @@ class Entity extends Renderable {
          * @public
          * @type {number}
          * @name id
-         * @memberOf me.Entity
+         * @memberof Entity
          */
         this.id = settings.id || "";
 
@@ -95,16 +89,16 @@ class Entity extends Renderable {
          * @public
          * @type {boolean}
          * @name alive
-         * @memberOf me.Entity
+         * @memberof Entity
          */
         this.alive = true;
 
         /**
          * the entity body object
          * @public
-         * @type {me.Body}
+         * @type {Body}
          * @name body
-         * @memberOf me.Entity
+         * @memberof Entity
          */
         // initialize the default body
         if (typeof settings.shapes === "undefined") {
@@ -134,9 +128,9 @@ class Entity extends Renderable {
     /**
      * The entity renderable component (can be any objects deriving from me.Renderable, like me.Sprite for example)
      * @public
-     * @type {me.Renderable}
+     * @type {Renderable}
      * @name renderable
-     * @memberOf me.Entity
+     * @memberof Entity
      */
 
     get renderable() {
@@ -164,9 +158,9 @@ class Entity extends Renderable {
      * update the bounds position when the body is modified
      * @ignore
      * @name onBodyUpdate
-     * @memberOf me.Entity
+     * @memberof Entity
      * @function
-     * @param {me.Body} the body whose bounds to update
+     * @param {Body} body the body whose bounds to update
      */
     onBodyUpdate(body) {
         // update the entity bounds to include the body bounds
@@ -200,11 +194,11 @@ class Entity extends Renderable {
      * not to be called by the end user<br>
      * called by the game manager on each game loop
      * @name draw
-     * @memberOf me.Entity
+     * @memberof Entity
      * @function
      * @protected
-     * @param {me.CanvasRenderer|me.WebGLRenderer} renderer a renderer object
-     * @param {me.Rect} rect region to draw
+     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
+     * @param {Rect} rect region to draw
      */
     draw(renderer, rect) {
         var renderable = this.renderable;
@@ -239,7 +233,7 @@ class Entity extends Renderable {
      * onDeactivateEvent Notification function<br>
      * Called by engine before deleting the object
      * @name onDeactivateEvent
-     * @memberOf me.Entity
+     * @memberof Entity
      * @function
      */
     onDeactivateEvent() {

package/src/game.js

@@ -8,8 +8,7 @@ import World from "./physics/world.js";
  * me.game represents your current game, it contains all the objects,
  * tilemap layers, current viewport, collision map, etc...<br>
  * me.game is also responsible for updating (each frame) the object status and draw them.
- * @namespace me.game
- * @memberOf me
+ * @namespace game
  */
 
 // to know when we have to refresh the display
@@ -47,9 +46,9 @@ event.on(event.BOOT, () => {
 /**
  * a reference to the current active stage "default" camera
  * @public
- * @type {me.Camera2d}
+ * @type {Camera2d}
  * @name viewport
- * @memberOf me.game
+ * @memberof game
  */
 export let viewport;
 
@@ -57,9 +56,9 @@ export let viewport;
  * a reference to the game world, <br>
  * a world is a virtual environment containing all the game objects
  * @public
- * @type {me.World}
+ * @type {World}
  * @name world
- * @memberOf me.game
+ * @memberof game
  */
 export let world;
 
@@ -70,7 +69,7 @@ export let world;
  * @type {boolean}
  * @default true
  * @name mergeGroup
- * @memberOf me.game
+ * @memberof game
  */
 export let mergeGroup = true;
 
@@ -81,7 +80,7 @@ export let mergeGroup = true;
  * @type {string}
  * @default "z"
  * @name sortOn
- * @memberOf me.game
+ * @memberof game
  */
 export let sortOn = "z";
 
@@ -93,14 +92,14 @@ export let sortOn = "z";
  * @public
  * @type {DOMHighResTimeStamp}
  * @name lastUpdate
- * @memberOf me.game
+ * @memberof game
  */
 export let lastUpdate = window.performance.now();
 
 /**
  * Fired when a level is fully loaded and all entities instantiated. <br>
  * Additionnaly the level id will also be passed to the called function.
- * @function me.game.onLevelLoaded
+ * @function game.onLevelLoaded
  * @example
  * // call myFunction () everytime a level is loaded
  * me.game.onLevelLoaded = this.myFunction.bind(this);
@@ -110,7 +109,7 @@ export function onLevelLoaded() {};
 /**
  * reset the game Object manager<br>
  * destroy all current objects
- * @function me.game.reset
+ * @function game.reset
  */
 export function reset () {
     // point to the current active stage "default" camera
@@ -128,9 +127,9 @@ export function reset () {
 
 /**
  * Update the renderer framerate using the system config variables.
- * @function me.game.updateFrameRate
- * @see me.timer.maxfps
- * @see me.World.fps
+ * @function game.updateFrameRate
+ * @see timer.maxfps
+ * @see World.fps
  */
 export function updateFrameRate() {
     // reset the frame counter
@@ -149,9 +148,9 @@ export function updateFrameRate() {
 
 /**
  * Returns the parent container of the specified Child in the game world
- * @function me.game.getParentContainer
- * @param {me.Renderable} child
- * @returns {me.Container}
+ * @function game.getParentContainer
+ * @param {Renderable} child
+ * @returns {Container}
  */
 export function getParentContainer(child) {
     return child.ancestor;
@@ -159,7 +158,7 @@ export function getParentContainer(child) {
 
 /**
  * force the redraw (not update) of all objects
- * @function me.game.repaint
+ * @function game.repaint
  */
 export function repaint() {
     isDirty = true;
@@ -169,9 +168,9 @@ export function repaint() {
 /**
  * update all objects of the game manager
  * @ignore
- * @function me.game.update
+ * @function game.update
  * @param {number} time current timestamp as provided by the RAF callback
- * @param {me.Stage} stage the current stage
+ * @param {Stage} stage the current stage
  */
 export function update(time, stage) {
     // handle frame skipping if required
@@ -216,9 +215,9 @@ export function update(time, stage) {
 
 /**
  * draw the current scene/stage
- * @function me.game.draw
+ * @function game.draw
  * @ignore
- * @param {me.Stage} stage the current stage
+ * @param {Stage} stage the current stage
  */
 export function draw(stage) {
 

package/src/{shapes → geometries}/ellipse.js

@@ -4,34 +4,27 @@ import pool from "./../system/pooling.js";
 /**
  * @classdesc
  * an ellipse Object
- * @class Ellipse
- * @extends me.Object
- * @memberOf me
- * @constructor
- * @param {number} x the center x coordinate of the ellipse
- * @param {number} y the center y coordinate of the ellipse
- * @param {number} w width (diameter) of the ellipse
- * @param {number} h height (diameter) of the ellipse
  */
-
 class Ellipse {
-
+    /**
+     * @param {number} x the center x coordinate of the ellipse
+     * @param {number} y the center y coordinate of the ellipse
+     * @param {number} w width (diameter) of the ellipse
+     * @param {number} h height (diameter) of the ellipse
+     */
     constructor(x, y, w, h) {
         /**
          * the center coordinates of the ellipse
          * @public
-         * @type {me.Vector2d}
+         * @type {Vector2d}
          * @name pos
-         * @memberOf me.Ellipse#
+         * @memberof Ellipse#
          */
         this.pos = new Vector2d();
 
         /**
          * The bounding rectangle for this shape
          * @private
-         * @type {me.Bounds}
-         * @name _bounds
-         * @memberOf me.Ellipse#
          */
         this._bounds = undefined;
 
@@ -40,34 +33,34 @@ class Ellipse {
          * @public
          * @type {number}
          * @name radius
-         * @memberOf me.Ellipse
+         * @memberof Ellipse
          */
         this.radius = NaN;
 
         /**
          * Pre-scaled radius vector for ellipse
          * @public
-         * @type {me.Vector2d}
+         * @type {Vector2d}
          * @name radiusV
-         * @memberOf me.Ellipse#
+         * @memberof Ellipse#
          */
         this.radiusV = new Vector2d();
 
         /**
          * Radius squared, for pythagorean theorom
          * @public
-         * @type {me.Vector2d}
+         * @type {Vector2d}
          * @name radiusSq
-         * @memberOf me.Ellipse#
+         * @memberof Ellipse#
          */
         this.radiusSq = new Vector2d();
 
         /**
          * x/y scaling ratio for ellipse
          * @public
-         * @type {me.Vector2d}
+         * @type {Vector2d}
          * @name ratio
-         * @memberOf me.Ellipse#
+         * @memberof Ellipse#
          */
         this.ratio = new Vector2d();
 
@@ -84,13 +77,13 @@ class Ellipse {
     /**
      * set new value to the Ellipse shape
      * @name setShape
-     * @memberOf me.Ellipse.prototype
+     * @memberof Ellipse.prototype
      * @function
      * @param {number} x the center x coordinate of the ellipse
      * @param {number} y the center y coordinate of the ellipse
      * @param {number} w width (diameter) of the ellipse
      * @param {number} h height (diameter) of the ellipse
-     * @returns {me.Ellipse} this instance for objecf chaining
+     * @returns {Ellipse} this instance for objecf chaining
      */
     setShape(x, y, w, h) {
         var hW = w / 2;
@@ -114,11 +107,11 @@ class Ellipse {
     /**
      * Rotate this Ellipse (counter-clockwise) by the specified angle (in radians).
      * @name rotate
-     * @memberOf me.Ellipse.prototype
+     * @memberof Ellipse.prototype
      * @function
      * @param {number} angle The angle to rotate (in radians)
-     * @param {me.Vector2d|me.ObservableVector2d} [v] an optional point to rotate around
-     * @returns {me.Ellipse} Reference to this object for method chaining
+     * @param {Vector2d|ObservableVector2d} [v] an optional point to rotate around
+     * @returns {Ellipse} Reference to this object for method chaining
      */
     rotate(angle, v) {
         // TODO : only works for circle
@@ -131,11 +124,11 @@ class Ellipse {
     /**
      * Scale this Ellipse by the specified scalar.
      * @name scale
-     * @memberOf me.Ellipse.prototype
+     * @memberof Ellipse.prototype
      * @function
      * @param {number} x
      * @param {number} [y=x]
-     * @returns {me.Ellipse} Reference to this object for method chaining
+     * @returns {Ellipse} Reference to this object for method chaining
      */
     scale(x, y) {
         y = typeof (y) !== "undefined" ? y : x;
@@ -150,10 +143,10 @@ class Ellipse {
     /**
      * Scale this Ellipse by the specified vector.
      * @name scale
-     * @memberOf me.Ellipse.prototype
+     * @memberof Ellipse.prototype
      * @function
-     * @param {me.Vector2d} v
-     * @returns {me.Ellipse} Reference to this object for method chaining
+     * @param {Vector2d} v
+     * @returns {Ellipse} Reference to this object for method chaining
      */
     scaleV(v) {
         return this.scale(v.x, v.y);
@@ -162,10 +155,10 @@ class Ellipse {
     /**
      * apply the given transformation matrix to this ellipse
      * @name transform
-     * @memberOf me.Ellipse.prototype
+     * @memberof Ellipse.prototype
      * @function
-     * @param {me.Matrix2d} matrix the transformation matrix
-     * @returns {me.Polygon} Reference to this object for method chaining
+     * @param {Matrix2d} matrix the transformation matrix
+     * @returns {Polygon} Reference to this object for method chaining
      */
     transform(/* m */) {
         // TODO
@@ -175,19 +168,19 @@ class Ellipse {
     /**
      * translate the circle/ellipse by the specified offset
      * @name translate
-     * @memberOf me.Ellipse.prototype
+     * @memberof Ellipse.prototype
      * @function
      * @param {number} x x offset
      * @param {number} y y offset
-     * @returns {me.Ellipse} this ellipse
+     * @returns {Ellipse} this ellipse
      */
     /**
      * translate the circle/ellipse by the specified vector
      * @name translate
-     * @memberOf me.Ellipse.prototype
+     * @memberof Ellipse.prototype
      * @function
-     * @param {me.Vector2d} v vector offset
-     * @returns {me.Ellipse} this ellipse
+     * @param {Vector2d} v vector offset
+     * @returns {Ellipse} this ellipse
      */
     translate() {
         var _x, _y;
@@ -212,16 +205,16 @@ class Ellipse {
     /**
      * check if this circle/ellipse contains the specified point
      * @name contains
-     * @memberOf me.Ellipse.prototype
+     * @memberof Ellipse.prototype
      * @function
-     * @param  {me.Vector2d} point
+     * @param {Vector2d} point
      * @returns {boolean} true if contains
      */
 
     /**
      * check if this circle/ellipse contains the specified point
      * @name contains
-     * @memberOf me.Ellipse.prototype
+     * @memberof Ellipse.prototype
      * @function
      * @param  {number} x x coordinate
      * @param  {number} y y coordinate
@@ -253,9 +246,9 @@ class Ellipse {
     /**
      * returns the bounding box for this shape, the smallest Rectangle object completely containing this shape.
      * @name getBounds
-     * @memberOf me.Ellipse.prototype
+     * @memberof Ellipse.prototype
      * @function
-     * @returns {me.Bounds} this shape bounding box Rectangle object
+     * @returns {Bounds} this shape bounding box Rectangle object
      */
     getBounds() {
         if (typeof this._bounds === "undefined") {
@@ -267,9 +260,9 @@ class Ellipse {
     /**
      * clone this Ellipse
      * @name clone
-     * @memberOf me.Ellipse.prototype
+     * @memberof Ellipse.prototype
      * @function
-     * @returns {me.Ellipse} new Ellipse
+     * @returns {Ellipse} new Ellipse
      */
     clone() {
         return new Ellipse(

package/src/{shapes → geometries}/line.js

@@ -4,13 +4,10 @@ import Polygon from "./poly.js";
 /**
  * @classdesc
  * a line segment Object
- * @class Line
- * @extends me.Polygon
- * @memberOf me
- * @constructor
+ * @augments Polygon
  * @param {number} x origin point of the Line
  * @param {number} y origin point of the Line
- * @param {me.Vector2d[]} points array of vectors defining the Line
+ * @param {Vector2d[]} points array of vectors defining the Line
  */
 
 class Line extends Polygon {
@@ -18,16 +15,16 @@ class Line extends Polygon {
     /**
      * Returns true if the Line contains the given point
      * @name contains
-     * @memberOf me.Line.prototype
+     * @memberof Line.prototype
      * @function
-     * @param  {me.Vector2d} point
+     * @param {Vector2d} point
      * @returns {boolean} true if contains
      */
 
     /**
      * Returns true if the Line contains the given point
      * @name contains
-     * @memberOf me.Line.prototype
+     * @memberof Line.prototype
      * @function
      * @param  {number} x x coordinate
      * @param  {number} y y coordinate
@@ -61,9 +58,9 @@ class Line extends Polygon {
      * Computes the calculated collision edges and normals.
      * This **must** be called if the `points` array, `angle`, or `offset` is modified manually.
      * @name recalc
-     * @memberOf me.Line.prototype
+     * @memberof Line.prototype
      * @function
-     * @returns {me.Line} this instance for objecf chaining
+     * @returns {Line} this instance for objecf chaining
      */
     recalc() {
         var edges = this.edges;
@@ -97,9 +94,9 @@ class Line extends Polygon {
     /**
      * clone this line segment
      * @name clone
-     * @memberOf me.Line.prototype
+     * @memberof Line.prototype
      * @function
-     * @returns {me.Line} new Line
+     * @returns {Line} new Line
      */
     clone() {
         var copy = [];