melonjs 10.1.1 → 10.2.3

package/src/renderable/trigger.js

@@ -12,19 +12,19 @@ import { world, viewport } from "./../game.js";
  * @extends me.Renderable
  * @memberOf me
  * @constructor
- * @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
- * @param {Number} [settings.height] height of the trigger area
+ * @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
+ * @param {number} [settings.height] height of the trigger area
  * @param {me.Rect[]|me.Polygon[]|me.Line[]|me.Ellipse[]} [settings.shapes] collision shape(s) that will trigger the event
- * @param {String} [settings.duration] Fade duration (in ms)
- * @param {String|me.Color} [settings.color] Fade color
- * @param {String} [settings.event="level"] the type of event to trigger (only "level" supported for now)
- * @param {String} [settings.to] level to load if level trigger
- * @param {String|me.Container} [settings.container] Target container. See {@link me.level.load}
+ * @param {string} [settings.duration] Fade duration (in ms)
+ * @param {string|me.Color} [settings.color] Fade color
+ * @param {string} [settings.event="level"] the type of event to trigger (only "level" supported for now)
+ * @param {string} [settings.to] level to load if level trigger
+ * @param {string|me.Container} [settings.container] Target container. See {@link me.level.load}
  * @param {Function} [settings.onLoaded] Level loaded callback. See {@link me.level.load}
- * @param {Boolean} [settings.flatten] Flatten all objects into the target container. See {@link me.level.load}
- * @param {Boolean} [settings.setViewportBounds] Resize the viewport to match the level. See {@link me.level.load}
+ * @param {boolean} [settings.flatten] Flatten all objects into the target container. See {@link me.level.load}
+ * @param {boolean} [settings.setViewportBounds] Resize the viewport to match the level. See {@link me.level.load}
  * @example
  * me.game.world.addChild(new me.Trigger(
  *     x, y, {
@@ -102,11 +102,10 @@ class Trigger extends Renderable {
     }
 
     /**
-     * go to the specified level
-     * @name goTo
-     * @memberOf me.LevelEntity
+     * trigger this event
+     * @name triggerEvent
+     * @memberOf me.Trigger
      * @function
-     * @param {String} [level=this.nextlevel] name of the level to load
      * @protected
      */
     triggerEvent() {

package/src/shapes/ellipse.js

@@ -8,10 +8,10 @@ import pool from "./../system/pooling.js";
  * @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
+ * @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 {
@@ -38,7 +38,7 @@ class Ellipse {
         /**
          * Maximum radius of the ellipse
          * @public
-         * @type {Number}
+         * @type {number}
          * @name radius
          * @memberOf me.Ellipse
          */
@@ -86,10 +86,11 @@ class Ellipse {
      * @name setShape
      * @memberOf me.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
+     * @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
      */
     setShape(x, y, w, h) {
         var hW = w / 2;
@@ -115,9 +116,9 @@ class Ellipse {
      * @name rotate
      * @memberOf me.Ellipse.prototype
      * @function
-     * @param {Number} angle The angle to rotate (in radians)
+     * @param {number} angle The angle to rotate (in radians)
      * @param {me.Vector2d|me.ObservableVector2d} [v] an optional point to rotate around
-     * @return {me.Ellipse} Reference to this object for method chaining
+     * @returns {me.Ellipse} Reference to this object for method chaining
      */
     rotate(angle, v) {
         // TODO : only works for circle
@@ -132,9 +133,9 @@ class Ellipse {
      * @name scale
      * @memberOf me.Ellipse.prototype
      * @function
-     * @param {Number} x
-     * @param {Number} [y=x]
-     * @return {me.Ellipse} Reference to this object for method chaining
+     * @param {number} x
+     * @param {number} [y=x]
+     * @returns {me.Ellipse} Reference to this object for method chaining
      */
     scale(x, y) {
         y = typeof (y) !== "undefined" ? y : x;
@@ -152,7 +153,7 @@ class Ellipse {
      * @memberOf me.Ellipse.prototype
      * @function
      * @param {me.Vector2d} v
-     * @return {me.Ellipse} Reference to this object for method chaining
+     * @returns {me.Ellipse} Reference to this object for method chaining
      */
     scaleV(v) {
         return this.scale(v.x, v.y);
@@ -164,7 +165,7 @@ class Ellipse {
      * @memberOf me.Ellipse.prototype
      * @function
      * @param {me.Matrix2d} matrix the transformation matrix
-     * @return {me.Polygon} Reference to this object for method chaining
+     * @returns {me.Polygon} Reference to this object for method chaining
      */
     transform(/* m */) {
         // TODO
@@ -176,9 +177,9 @@ class Ellipse {
      * @name translate
      * @memberOf me.Ellipse.prototype
      * @function
-     * @param {Number} x x offset
-     * @param {Number} y y offset
-     * @return {me.Ellipse} this ellipse
+     * @param {number} x x offset
+     * @param {number} y y offset
+     * @returns {me.Ellipse} this ellipse
      */
     /**
      * translate the circle/ellipse by the specified vector
@@ -186,7 +187,7 @@ class Ellipse {
      * @memberOf me.Ellipse.prototype
      * @function
      * @param {me.Vector2d} v vector offset
-     * @return {me.Ellipse} this ellipse
+     * @returns {me.Ellipse} this ellipse
      */
     translate() {
         var _x, _y;
@@ -214,7 +215,7 @@ class Ellipse {
      * @memberOf me.Ellipse.prototype
      * @function
      * @param  {me.Vector2d} point
-     * @return {boolean} true if contains
+     * @returns {boolean} true if contains
      */
 
     /**
@@ -222,9 +223,9 @@ class Ellipse {
      * @name contains
      * @memberOf me.Ellipse.prototype
      * @function
-     * @param  {Number} x x coordinate
-     * @param  {Number} y y coordinate
-     * @return {boolean} true if contains
+     * @param  {number} x x coordinate
+     * @param  {number} y y coordinate
+     * @returns {boolean} true if contains
      */
     contains() {
         var _x, _y;
@@ -254,7 +255,7 @@ class Ellipse {
      * @name getBounds
      * @memberOf me.Ellipse.prototype
      * @function
-     * @return {me.Bounds} this shape bounding box Rectangle object
+     * @returns {me.Bounds} this shape bounding box Rectangle object
      */
     getBounds() {
         if (typeof this._bounds === "undefined") {
@@ -268,7 +269,7 @@ class Ellipse {
      * @name clone
      * @memberOf me.Ellipse.prototype
      * @function
-     * @return {me.Ellipse} new Ellipse
+     * @returns {me.Ellipse} new Ellipse
      */
     clone() {
         return new Ellipse(

package/src/shapes/line.js

@@ -8,8 +8,8 @@ import Polygon from "./poly.js";
  * @extends me.Polygon
  * @memberOf me
  * @constructor
- * @param {Number} x origin point of the Line
- * @param {Number} y origin point of the Line
+ * @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
  */
 
@@ -21,7 +21,7 @@ class Line extends Polygon {
      * @memberOf me.Line.prototype
      * @function
      * @param  {me.Vector2d} point
-     * @return {boolean} true if contains
+     * @returns {boolean} true if contains
      */
 
     /**
@@ -29,9 +29,9 @@ class Line extends Polygon {
      * @name contains
      * @memberOf me.Line.prototype
      * @function
-     * @param  {Number} x x coordinate
-     * @param  {Number} y y coordinate
-     * @return {boolean} true if contains
+     * @param  {number} x x coordinate
+     * @param  {number} y y coordinate
+     * @returns {boolean} true if contains
      */
     contains() {
         var _x, _y;
@@ -63,6 +63,7 @@ class Line extends Polygon {
      * @name recalc
      * @memberOf me.Line.prototype
      * @function
+     * @returns {me.Line} this instance for objecf chaining
      */
     recalc() {
         var edges = this.edges;
@@ -98,7 +99,7 @@ class Line extends Polygon {
      * @name clone
      * @memberOf me.Line.prototype
      * @function
-     * @return {me.Line} new Line
+     * @returns {me.Line} new Line
      */
     clone() {
         var copy = [];

package/src/shapes/poly.js

@@ -13,8 +13,8 @@ import pool from "./../system/pooling.js";
  * @class Polygon
  * @memberOf me
  * @constructor
- * @param {Number} x origin point of the Polygon
- * @param {Number} y origin point of the Polygon
+ * @param {number} x origin point of the Polygon
+ * @param {number} y origin point of the Polygon
  * @param {me.Vector2d[]} points array of vector defining the Polygon
  */
 
@@ -86,9 +86,10 @@ class Polygon {
      * @name setShape
      * @memberOf me.Polygon.prototype
      * @function
-     * @param {Number} x position of the Polygon
-     * @param {Number} y position of the Polygon
-     * @param {me.Vector2d[]|Number[]} points array of vector or vertice defining the Polygon
+     * @param {number} x position of the Polygon
+     * @param {number} y position of the Polygon
+     * @param {me.Vector2d[]|number[]} points array of vector or vertice defining the Polygon
+     * @returns {me.Polygon} this instance for objecf chaining
      */
     setShape(x, y, points) {
         this.pos.set(x, y);
@@ -101,7 +102,8 @@ class Polygon {
      * @name setVertices
      * @memberOf me.Polygon.prototype
      * @function
-     * @param {me.Vector2d[]} points array of vector or vertice defining the Polygon
+     * @param {me.Vector2d[]} vertices array of vector or vertice defining the Polygon
+     * @returns {me.Polygon} this instance for objecf chaining
      */
     setVertices(vertices) {
 
@@ -140,8 +142,8 @@ class Polygon {
      * @name transform
      * @memberOf me.Polygon.prototype
      * @function
-     * @param {me.Matrix2d} matrix the transformation matrix
-     * @return {me.Polygon} Reference to this object for method chaining
+     * @param {me.Matrix2d} m the transformation matrix
+     * @returns {me.Polygon} Reference to this object for method chaining
      */
     transform(m) {
         var points = this.points;
@@ -159,7 +161,7 @@ class Polygon {
      * @name toIso
      * @memberOf me.Polygon.prototype
      * @function
-     * @return {me.Polygon} Reference to this object for method chaining
+     * @returns {me.Polygon} Reference to this object for method chaining
      */
     toIso() {
         return this.rotate(Math.PI / 4).scale(Math.SQRT2, Math.SQRT1_2);
@@ -170,7 +172,7 @@ class Polygon {
      * @name to2d
      * @memberOf me.Polygon.prototype
      * @function
-     * @return {me.Polygon} Reference to this object for method chaining
+     * @returns {me.Polygon} Reference to this object for method chaining
      */
     to2d() {
         return this.scale(Math.SQRT1_2, Math.SQRT2).rotate(-Math.PI / 4);
@@ -181,9 +183,9 @@ class Polygon {
      * @name rotate
      * @memberOf me.Polygon.prototype
      * @function
-     * @param {Number} angle The angle to rotate (in radians)
+     * @param {number} angle The angle to rotate (in radians)
      * @param {me.Vector2d|me.ObservableVector2d} [v] an optional point to rotate around
-     * @return {me.Polygon} Reference to this object for method chaining
+     * @returns {me.Polygon} Reference to this object for method chaining
      */
     rotate(angle, v) {
         if (angle !== 0) {
@@ -203,9 +205,9 @@ class Polygon {
      * @name scale
      * @memberOf me.Polygon.prototype
      * @function
-     * @param {Number} x
-     * @param {Number} [y=x]
-     * @return {me.Polygon} Reference to this object for method chaining
+     * @param {number} x
+     * @param {number} [y=x]
+     * @returns {me.Polygon} Reference to this object for method chaining
      */
     scale(x, y) {
         y = typeof (y) !== "undefined" ? y : x;
@@ -226,7 +228,7 @@ class Polygon {
      * @memberOf me.Polygon.prototype
      * @function
      * @param {me.Vector2d} v
-     * @return {me.Polygon} Reference to this object for method chaining
+     * @returns {me.Polygon} Reference to this object for method chaining
      */
     scaleV(v) {
         return this.scale(v.x, v.y);
@@ -238,7 +240,7 @@ class Polygon {
      * @name recalc
      * @memberOf me.Polygon.prototype
      * @function
-     * @return {me.Polygon} Reference to this object for method chaining
+     * @returns {me.Polygon} Reference to this object for method chaining
      */
     recalc() {
         var i;
@@ -281,7 +283,7 @@ class Polygon {
      * @name getIndices
      * @memberOf me.Polygon.prototype
      * @function
-     * @return {Array} an array of vertex indices for all triangles forming this polygon.
+     * @returns {Array} an array of vertex indices for all triangles forming this polygon.
      */
     getIndices() {
         if (this.indices.length === 0) {
@@ -295,9 +297,9 @@ class Polygon {
      * @name translate
      * @memberOf me.Polygon.prototype
      * @function
-     * @param {Number} x x offset
-     * @param {Number} y y offset
-     * @return {me.Polygon} this Polygon
+     * @param {number} x x offset
+     * @param {number} y y offset
+     * @returns {me.Polygon} this Polygon
      */
     /**
      * translate the Polygon by the specified vector
@@ -305,7 +307,7 @@ class Polygon {
      * @memberOf me.Polygon.prototype
      * @function
      * @param {me.Vector2d} v vector offset
-     * @return {me.Polygon} Reference to this object for method chaining
+     * @returns {me.Polygon} Reference to this object for method chaining
      */
     translate() {
         var _x, _y;
@@ -339,8 +341,8 @@ class Polygon {
      * @name shift
      * @memberOf me.Polygon
      * @function
-     * @param {Number} x
-     * @param {Number} y
+     * @param {number} x
+     * @param {number} y
      */
     shift() {
         var _x, _y;
@@ -366,7 +368,7 @@ class Polygon {
      * @memberOf me.Polygon.prototype
      * @function
      * @param  {me.Vector2d} point
-     * @return {boolean} true if contains
+     * @returns {boolean} true if contains
      */
 
     /**
@@ -376,9 +378,9 @@ class Polygon {
      * @name contains
      * @memberOf me.Polygon.prototype
      * @function
-     * @param  {Number} x x coordinate
-     * @param  {Number} y y coordinate
-     * @return {boolean} true if contains
+     * @param  {number} x x coordinate
+     * @param  {number} y y coordinate
+     * @returns {boolean} true if contains
      */
     contains() {
         var _x, _y;
@@ -414,7 +416,7 @@ class Polygon {
      * @name getBounds
      * @memberOf me.Polygon.prototype
      * @function
-     * @return {me.Bounds} this shape bounding box Rectangle object
+     * @returns {me.Bounds} this shape bounding box Rectangle object
      */
     getBounds() {
         if (typeof this._bounds === "undefined") {
@@ -429,7 +431,7 @@ class Polygon {
      * @name updateBounds
      * @memberOf me.Polygon.prototype
      * @function
-     * @return {me.Bounds} this shape bounding box Rectangle object
+     * @returns {me.Bounds} this shape bounding box Rectangle object
      */
     updateBounds() {
         var bounds = this.getBounds();
@@ -445,7 +447,7 @@ class Polygon {
      * @name clone
      * @memberOf me.Polygon.prototype
      * @function
-     * @return {me.Polygon} new Polygon
+     * @returns {me.Polygon} new Polygon
      */
     clone() {
         var copy = [];