melonjs 10.2.0 → 10.3.0

package/src/renderable/sprite.js

@@ -10,20 +10,19 @@ 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
- * @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
- * @param {me.Renderer.Texture|HTMLImageElement|HTMLCanvasElement|String} settings.image reference to a texture, spritesheet image or to a texture atlas
- * @param {String} [settings.name=""] name of this object
- * @param {String} [settings.region] region name of a specific region to use when using a texture atlas, see {@link me.Renderer.Texture}
- * @param {Number} [settings.framewidth] Width of a single frame within the spritesheet
- * @param {Number} [settings.frameheight] Height of a single frame within the spritesheet
- * @param {String|me.Color} [settings.tint] a tint to be applied to this sprite
- * @param {Number} [settings.flipX] flip the sprite on the horizontal axis
- * @param {Number} [settings.flipY] flip the sprite on the vertical axis
+ * @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
+ * @param {me.Renderer.Texture|HTMLImageElement|HTMLCanvasElement|string} settings.image reference to a texture, spritesheet image or to a texture atlas
+ * @param {string} [settings.name=""] name of this object
+ * @param {string} [settings.region] region name of a specific region to use when using a texture atlas, see {@link me.Renderer.Texture}
+ * @param {number} [settings.framewidth] Width of a single frame within the spritesheet
+ * @param {number} [settings.frameheight] Height of a single frame within the spritesheet
+ * @param {string|me.Color} [settings.tint] a tint to be applied to this sprite
+ * @param {number} [settings.flipX] flip the sprite on the horizontal axis
+ * @param {number} [settings.flipY] flip the sprite on the vertical axis
  * @param {me.Vector2d} [settings.anchorPoint={x:0.5, y:0.5}] Anchor point to draw the frame at (defaults to the center of the frame).
  * @example
  * // create a single sprite from a standalone image, with anchor in the center
@@ -58,7 +57,7 @@ class Sprite extends Renderable {
         /**
          * pause and resume animation
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @default false
          * @name me.Sprite#animationpause
          */
@@ -67,7 +66,7 @@ class Sprite extends Renderable {
         /**
          * animation cycling speed (delay between frame in ms)
          * @public
-         * @type Number
+         * @type {number}
          * @default 100
          * @name me.Sprite#animationspeed
          */
@@ -76,19 +75,19 @@ class Sprite extends Renderable {
         /**
          * global offset for the position to draw from on the source image.
          * @public
-         * @type me.Vector2d
+         * @type {me.Vector2d}
          * @default <0.0,0.0>
          * @name offset
-         * @memberOf me.Sprite#
+         * @memberof me.Sprite#
          */
         this.offset = pool.pull("Vector2d", 0, 0);
 
         /**
          * The source texture object this sprite object is using
          * @public
-         * @type me.Renderer.Texture
+         * @type {me.Renderer.Texture}
          * @name source
-         * @memberOf me.Sprite#
+         * @memberof me.Sprite#
          */
         this.source = null;
 
@@ -148,7 +147,7 @@ class Sprite extends Renderable {
                 }
             }
         } else {
-            // HTMLImageElement/Canvas or String
+            // HTMLImageElement/Canvas or {string}
             this.image = (typeof settings.image === "object") ? settings.image : loader.getImage(settings.image);
             // throw an error if image ends up being null/undefined
             if (!this.image) {
@@ -217,9 +216,9 @@ class Sprite extends Renderable {
     /**
      * return the flickering state of the object
      * @name isFlickering
-     * @memberOf me.Sprite.prototype
+     * @memberof me.Sprite.prototype
      * @function
-     * @return {Boolean}
+     * @returns {boolean}
      */
     isFlickering() {
         return this._flicker.isFlickering;
@@ -228,11 +227,11 @@ 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 {number} duration expressed in milliseconds
      * @param {Function} callback Function to call when flickering ends
-     * @return {me.Sprite} Reference to this object for method chaining
+     * @returns {me.Sprite} Reference to this object for method chaining
      * @example
      * // make the object flicker for 1 second
      * // and then remove it
@@ -259,13 +258,13 @@ 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
+     * @param {string} name animation id
+     * @param {number[]|string[]|object[]} index list of sprite index or name
      * defining the animation. Can also use objects to specify delay for each frame, see below
-     * @param {Number} [animationspeed] cycling speed for animation in ms
-     * @return {Number} frame amount of frame added to the animation (delay between each frame).
+     * @param {number} [animationspeed] cycling speed for animation in ms
+     * @returns {number} frame amount of frame added to the animation (delay between each frame).
      * @see me.Sprite#animationspeed
      * @example
      * // walking animation
@@ -359,11 +358,12 @@ 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} [onComplete] animation id to switch to when complete, or callback
-     * @return {me.Sprite} Reference to this object for method chaining
+     * @param {string} name animation id
+     * @param {string|Function} [resetAnim] animation id to switch to when complete, or callback
+     * @param {boolean} [preserve_dt=false] if false will reset the elapsed time counter since last frame
+     * @returns {me.Sprite} Reference to this object for method chaining
      * @example
      * // set "walk" animation
      * this.setCurrentAnimation("walk");
@@ -393,8 +393,8 @@ class Sprite extends Renderable {
      *
      *    return false; // do not reset to first frame
      * }).bind(this));
-     **/
-    setCurrentAnimation(name, resetAnim, _preserve_dt) {
+     */
+    setCurrentAnimation(name, resetAnim, preserve_dt) {
         if (this.anim[name]) {
             this.current.name = name;
             this.current.length = this.anim[this.current.name].length;
@@ -406,7 +406,7 @@ class Sprite extends Renderable {
                 this.resetAnim = undefined;
             }
             this.setAnimationFrame(this.current.idx);
-            if (!_preserve_dt) {
+            if (!preserve_dt) {
                 this.dt = 0;
             }
             this.isDirty = true;
@@ -419,10 +419,10 @@ 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
-     * @return {me.Sprite} Reference to this object for method chaining
+     * @param {string} [name] animation id
+     * @returns {me.Sprite} Reference to this object for method chaining
      * @see me.Sprite#animationspeed
      */
     reverseAnimation(name) {
@@ -438,10 +438,10 @@ 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
-     * @return {Boolean}
+     * @param {string} name animation id
+     * @returns {boolean}
      * @example
      * if (!this.isCurrentAnimation("walk")) {
      *     // do something funny...
@@ -455,10 +455,10 @@ 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()
-     * @return {me.Sprite} Reference to this object for method chaining
+     * @param {object} region typically returned through me.Texture.getRegion()
+     * @returns {me.Sprite} Reference to this object for method chaining
      * @example
      * // change the sprite to "shadedDark13.png";
      * mySprite.setRegion(game.texture.getRegion("shadedDark13.png"));
@@ -487,10 +487,10 @@ class Sprite extends Renderable {
     /**
      * force the current animation frame index.
      * @name setAnimationFrame
-     * @memberOf me.Sprite.prototype
+     * @memberof me.Sprite.prototype
      * @function
-     * @param {Number} [index=0] animation frame index
-     * @return {me.Sprite} Reference to this object for method chaining
+     * @param {number} [idx=0] animation frame index
+     * @returns {me.Sprite} Reference to this object for method chaining
      * @example
      * // reset the current animation to the first frame
      * this.setAnimationFrame();
@@ -503,9 +503,9 @@ class Sprite extends Renderable {
     /**
      * return the current animation frame index.
      * @name getCurrentAnimationFrame
-     * @memberOf me.Sprite.prototype
+     * @memberof me.Sprite.prototype
      * @function
-     * @return {Number} current animation frame index
+     * @returns {number} current animation frame index
      */
     getCurrentAnimationFrame() {
         return this.current.idx;
@@ -514,20 +514,27 @@ class Sprite extends Renderable {
     /**
      * Returns the frame object by the index.
      * @name getAnimationFrameObjectByIndex
-     * @memberOf me.Sprite.prototype
+     * @memberof me.Sprite.prototype
      * @function
-     * @private
-     * @return {Number} if using number indices. Returns {Object} containing frame data if using texture atlas
+     * @ignore
+     * @param {number} id the frame id
+     * @returns {number} if using number indices. Returns {object} containing frame data if using texture atlas
      */
     getAnimationFrameObjectByIndex(id) {
         return this.anim[this.current.name].frames[id];
     }
 
     /**
-     * @ignore
+     * update function. <br>
+     * automatically called by the game manager {@link me.game}
+     * @name update
+     * @memberof me.Sprite.prototype
+     * @function
+     * @protected
+     * @param {number} dt time since the last update in milliseconds.
+     * @returns {boolean} true if the Sprite is dirty
      */
     update(dt) {
-
         // Update animation if necessary
         if (!this.animationpause && this.current && this.current.length > 0) {
             var duration = this.getAnimationFrameObjectByIndex(this.current.idx).delay;
@@ -597,7 +604,13 @@ class Sprite extends Renderable {
     }
 
     /**
-     * @ignore
+     * sprite draw. <br>
+     * automatically called by the game manager {@link me.game}
+     * @name draw
+     * @memberof me.Sprite.prototype
+     * @function
+     * @protected
+     * @param {me.CanvasRenderer|me.WebGLRenderer} renderer a renderer object
      */
     draw(renderer) {
         // do nothing if we are flickering

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,22 +9,21 @@ import { world, viewport } from "./../game.js";
  * @classdesc
  * trigger an event when colliding with another object
  * @class Trigger
- * @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
+ * @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
+ * @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 +101,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/state/stage.js

@@ -16,10 +16,9 @@ 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
- * @param {Object} [options] The stage` parameters
+ * @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
  * @param {Function} [options.onDestroyEvent] called by the state manager before switching to another state
@@ -38,7 +37,7 @@ class Stage {
          * @public
          * @type {Map}
          * @name cameras
-         * @memberOf me.Stage
+         * @memberof me.Stage
          */
         this.cameras = new Map();
 
@@ -46,8 +45,8 @@ class Stage {
          * The given constructor options
          * @public
          * @name settings
-         * @memberOf me.Stage
-         * @enum {Object}
+         * @memberof me.Stage
+         * @type {object}
          */
         this.settings = Object.assign(default_settings, settings || {});
     }
@@ -84,12 +83,12 @@ class Stage {
     /**
      * update function
      * @name update
-     * @memberOf me.Stage
+     * @memberof me.Stage
      * @ignore
      * @function
-     * @param {Number} dt time since the last update in milliseconds.
-     * @return false
-     **/
+     * @param {number} dt time since the last update in milliseconds.
+     * @returns {boolean}
+     */
     update(dt) {
         // update all objects (and pass the elapsed time since last frame)
         var isDirty = game.world.update(dt);
@@ -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,9 +136,9 @@ 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 {} [arguments...] optional arguments passed when switching state
+     * @param {object} [...arguments] optional arguments passed when switching state
      * @see me.state#change
      */
     onResetEvent() {
@@ -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() {