melonjs 10.3.0 → 10.5.1

package/src/renderable/sprite.js

@@ -2,52 +2,46 @@ import Vector2d from "./../math/vector2.js";
 import { renderer } from "./../video/video.js";
 import pool from "./../system/pooling.js";
 import loader from "./../loader/loader.js";
-import {Texture } from "./../video/texture.js";
+import { TextureAtlas } from "./../video/texture.js";
 import Renderable from "./renderable.js";
 
-
 /**
  * @classdesc
  * An object to display a fixed or animated sprite on screen.
- * @class Sprite
- * @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
- * var sprite = new me.Sprite(0, 0, {
- *     image : "PlayerTexture",
- *     framewidth : 64,
- *     frameheight : 64,
- *     anchorPoint : new me.Vector2d(0.5, 0.5)
- * });
- *
- * // create a single sprite from a packed texture
- * game.texture = new me.video.renderer.Texture(
- *     me.loader.getJSON("texture"),
- *     me.loader.getImage("texture")
- * );
- * var sprite = new me.Sprite(0, 0, {
- *     image : game.texture,
- *     region : "npc2.png",
- * });
+ * @augments Renderable
  */
-
 class Sprite extends Renderable {
-
     /**
-     * @ignore
+     * @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 {HTMLImageElement|HTMLCanvasElement|TextureAtlas|string} settings.image reference to spritesheet image, a texture atlas 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 TextureAtlas}
+     * @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|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 {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
+     * var sprite = new me.Sprite(0, 0, {
+     *     image : "PlayerTexture",
+     *     framewidth : 64,
+     *     frameheight : 64,
+     *     anchorPoint : new me.Vector2d(0.5, 0.5)
+     * });
+     *
+     * // create a single sprite from a packed texture
+     * game.texture = new me.TextureAtlas(
+     *     me.loader.getJSON("texture"),
+     *     me.loader.getImage("texture")
+     * );
+     * var sprite = new me.Sprite(0, 0, {
+     *     image : game.texture,
+     *     region : "npc2.png",
+     * });
      */
     constructor(x, y, settings) {
 
@@ -59,7 +53,7 @@ class Sprite extends Renderable {
          * @public
          * @type {boolean}
          * @default false
-         * @name me.Sprite#animationpause
+         * @name Sprite#animationpause
          */
         this.animationpause = false;
 
@@ -68,26 +62,26 @@ class Sprite extends Renderable {
          * @public
          * @type {number}
          * @default 100
-         * @name me.Sprite#animationspeed
+         * @name Sprite#animationspeed
          */
         this.animationspeed = 100;
 
         /**
          * global offset for the position to draw from on the source image.
          * @public
-         * @type {me.Vector2d}
+         * @type {Vector2d}
          * @default <0.0,0.0>
          * @name offset
-         * @memberof me.Sprite#
+         * @memberof Sprite#
          */
         this.offset = pool.pull("Vector2d", 0, 0);
 
         /**
          * The source texture object this sprite object is using
          * @public
-         * @type {me.Renderer.Texture}
+         * @type {TextureAtlas}
          * @name source
-         * @memberof me.Sprite#
+         * @memberof Sprite#
          */
         this.source = null;
 
@@ -127,7 +121,7 @@ class Sprite extends Renderable {
         };
 
         // set the proper image/texture to use
-        if (settings.image instanceof Texture) {
+        if (settings.image instanceof TextureAtlas) {
             this.source = settings.image;
             this.image = this.source.getTexture();
             this.textureAtlas = settings.image;
@@ -216,7 +210,7 @@ class Sprite extends Renderable {
     /**
      * return the flickering state of the object
      * @name isFlickering
-     * @memberof me.Sprite.prototype
+     * @memberof Sprite.prototype
      * @function
      * @returns {boolean}
      */
@@ -227,11 +221,11 @@ class Sprite extends Renderable {
     /**
      * make the object flicker
      * @name flicker
-     * @memberof me.Sprite.prototype
+     * @memberof Sprite.prototype
      * @function
      * @param {number} duration expressed in milliseconds
      * @param {Function} callback Function to call when flickering ends
-     * @returns {me.Sprite} Reference to this object for method chaining
+     * @returns {Sprite} Reference to this object for method chaining
      * @example
      * // make the object flicker for 1 second
      * // and then remove it
@@ -258,14 +252,14 @@ class Sprite extends Renderable {
      * logic as per the following example :<br>
      * <img src="images/spritesheet_grid.png"/>
      * @name addAnimation
-     * @memberof me.Sprite.prototype
+     * @memberof Sprite.prototype
      * @function
      * @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
      * @returns {number} frame amount of frame added to the animation (delay between each frame).
-     * @see me.Sprite#animationspeed
+     * @see Sprite#animationspeed
      * @example
      * // walking animation
      * this.addAnimation("walk", [ 0, 1, 2, 3, 4, 5 ]);
@@ -358,12 +352,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 Sprite.prototype
      * @function
      * @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
+     * @returns {Sprite} Reference to this object for method chaining
      * @example
      * // set "walk" animation
      * this.setCurrentAnimation("walk");
@@ -419,11 +413,11 @@ class Sprite extends Renderable {
     /**
      * reverse the given or current animation if none is specified
      * @name reverseAnimation
-     * @memberof me.Sprite.prototype
+     * @memberof Sprite.prototype
      * @function
      * @param {string} [name] animation id
-     * @returns {me.Sprite} Reference to this object for method chaining
-     * @see me.Sprite#animationspeed
+     * @returns {Sprite} Reference to this object for method chaining
+     * @see Sprite#animationspeed
      */
     reverseAnimation(name) {
         if (typeof name !== "undefined" && typeof this.anim[name] !== "undefined") {
@@ -438,7 +432,7 @@ class Sprite extends Renderable {
     /**
      * return true if the specified animation is the current one.
      * @name isCurrentAnimation
-     * @memberof me.Sprite.prototype
+     * @memberof Sprite.prototype
      * @function
      * @param {string} name animation id
      * @returns {boolean}
@@ -453,12 +447,12 @@ class Sprite extends Renderable {
 
     /**
      * change the current texture atlas region for this sprite
-     * @see me.Texture.getRegion
+     * @see Texture.getRegion
      * @name setRegion
-     * @memberof me.Sprite.prototype
+     * @memberof Sprite.prototype
      * @function
      * @param {object} region typically returned through me.Texture.getRegion()
-     * @returns {me.Sprite} Reference to this object for method chaining
+     * @returns {Sprite} Reference to this object for method chaining
      * @example
      * // change the sprite to "shadedDark13.png";
      * mySprite.setRegion(game.texture.getRegion("shadedDark13.png"));
@@ -487,10 +481,10 @@ class Sprite extends Renderable {
     /**
      * force the current animation frame index.
      * @name setAnimationFrame
-     * @memberof me.Sprite.prototype
+     * @memberof Sprite.prototype
      * @function
      * @param {number} [idx=0] animation frame index
-     * @returns {me.Sprite} Reference to this object for method chaining
+     * @returns {Sprite} Reference to this object for method chaining
      * @example
      * // reset the current animation to the first frame
      * this.setAnimationFrame();
@@ -503,7 +497,7 @@ class Sprite extends Renderable {
     /**
      * return the current animation frame index.
      * @name getCurrentAnimationFrame
-     * @memberof me.Sprite.prototype
+     * @memberof Sprite.prototype
      * @function
      * @returns {number} current animation frame index
      */
@@ -514,7 +508,7 @@ class Sprite extends Renderable {
     /**
      * Returns the frame object by the index.
      * @name getAnimationFrameObjectByIndex
-     * @memberof me.Sprite.prototype
+     * @memberof Sprite.prototype
      * @function
      * @ignore
      * @param {number} id the frame id
@@ -526,9 +520,9 @@ class Sprite extends Renderable {
 
     /**
      * update function. <br>
-     * automatically called by the game manager {@link me.game}
+     * automatically called by the game manager {@link game}
      * @name update
-     * @memberof me.Sprite.prototype
+     * @memberof Sprite.prototype
      * @function
      * @protected
      * @param {number} dt time since the last update in milliseconds.
@@ -605,12 +599,12 @@ class Sprite extends Renderable {
 
     /**
      * sprite draw. <br>
-     * automatically called by the game manager {@link me.game}
+     * automatically called by the game manager {@link game}
      * @name draw
-     * @memberof me.Sprite.prototype
+     * @memberof Sprite.prototype
      * @function
      * @protected
-     * @param {me.CanvasRenderer|me.WebGLRenderer} renderer a renderer object
+     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
      */
     draw(renderer) {
         // do nothing if we are flickering

package/src/renderable/trigger.js

@@ -8,40 +8,35 @@ import { world, viewport } from "./../game.js";
 /**
  * @classdesc
  * trigger an event when colliding with another object
- * @class Trigger
- * @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 {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}
- * @example
- * me.game.world.addChild(new me.Trigger(
- *     x, y, {
- *         shapes: [new me.Rect(0, 0, 100, 100)],
- *         "duration" : 250,
- *         "color" : "#000",
- *         "to" : "mymap2"
- *     }
- * ));
+ * @augments Renderable
  */
-
 class Trigger extends Renderable {
-
     /**
-     * @ignore
+     * @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 {Rect[]|Polygon[]|Line[]|Ellipse[]} [settings.shapes] collision shape(s) that will trigger the event
+     * @param {string} [settings.duration] Fade duration (in ms)
+     * @param {string|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|Container} [settings.container] Target container. See {@link level.load}
+     * @param {Function} [settings.onLoaded] Level loaded callback. See {@link level.load}
+     * @param {boolean} [settings.flatten] Flatten all objects into the target container. See {@link level.load}
+     * @param {boolean} [settings.setViewportBounds] Resize the viewport to match the level. See {@link level.load}
+     * @example
+     * me.game.world.addChild(new me.Trigger(
+     *     x, y, {
+     *         shapes: [new me.Rect(0, 0, 100, 100)],
+     *         "duration" : 250,
+     *         "color" : "#000",
+     *         "to" : "mymap2"
+     *     }
+     * ));
      */
     constructor(x, y, settings) {
-
+        // call the parent constructor
         super(x, y, settings.width || 0, settings.height || 0);
 
         // for backward compatibility
@@ -103,7 +98,7 @@ class Trigger extends Renderable {
     /**
      * trigger this event
      * @name triggerEvent
-     * @memberof me.Trigger
+     * @memberof Trigger
      * @function
      * @protected
      */

package/src/state/stage.js

@@ -15,19 +15,15 @@ var default_settings = {
  * a default "Stage" object.
  * every "stage" object (title screen, credits, ingame, etc...) to be managed
  * through the state manager must inherit from this base class.
- * @class Stage
- * @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
- * @see me.state
+ * @see state
  */
 class Stage {
 
     /**
-     * @ignore
+     * @param {object} [settings] The stage` parameters
+     * @param {Camera2d[]} [settings.cameras=[new me.Camera2d()]] a list of cameras (experimental)
+     * @param {Function} [settings.onResetEvent] called by the state manager when reseting the object
+     * @param {Function} [settings.onDestroyEvent] called by the state manager before switching to another state
      */
     constructor(settings) {
         /**
@@ -37,7 +33,7 @@ class Stage {
          * @public
          * @type {Map}
          * @name cameras
-         * @memberof me.Stage
+         * @memberof Stage
          */
         this.cameras = new Map();
 
@@ -45,7 +41,7 @@ class Stage {
          * The given constructor options
          * @public
          * @name settings
-         * @memberof me.Stage
+         * @memberof Stage
          * @type {object}
          */
         this.settings = Object.assign(default_settings, settings || {});
@@ -83,7 +79,7 @@ class Stage {
     /**
      * update function
      * @name update
-     * @memberof me.Stage
+     * @memberof Stage
      * @ignore
      * @function
      * @param {number} dt time since the last update in milliseconds.
@@ -107,10 +103,10 @@ class Stage {
     /**
      * draw the current stage
      * @name draw
-     * @memberof me.Stage
+     * @memberof Stage
      * @ignore
      * @function
-     * @param {me.CanvasRenderer|me.WebGLRenderer} renderer a renderer object
+     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
      */
     draw(renderer) {
         // iterate through all cameras
@@ -136,10 +132,10 @@ 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 Stage
      * @function
      * @param {object} [...arguments] optional arguments passed when switching state
-     * @see me.state#change
+     * @see state#change
      */
     onResetEvent() {
         // execute onResetEvent function if given through the constructor
@@ -153,7 +149,7 @@ class Stage {
      * onDestroyEvent function<br>
      * called by the state manager before switching to another state
      * @name onDestroyEvent
-     * @memberof me.Stage
+     * @memberof Stage
      * @function
      */
     onDestroyEvent() {

package/src/state/state.js

@@ -150,7 +150,6 @@ event.on(event.BOOT, () => {
 /**
  * a State Manager (state machine)
  * @namespace state
- * @memberof me
  */
 
 var state = {
@@ -159,7 +158,7 @@ var state = {
      * default state ID for Loading Stage
      * @constant
      * @name LOADING
-     * @memberof me.state
+     * @memberof state
      */
     LOADING : 0,
 
@@ -167,7 +166,7 @@ var state = {
      * default state ID for Menu Stage
      * @constant
      * @name MENU
-     * @memberof me.state
+     * @memberof state
      */
     MENU : 1,
 
@@ -175,7 +174,7 @@ var state = {
      * default state ID for "Ready" Stage
      * @constant
      * @name READY
-     * @memberof me.state
+     * @memberof state
      */
     READY : 2,
 
@@ -183,7 +182,7 @@ var state = {
      * default state ID for Play Stage
      * @constant
      * @name PLAY
-     * @memberof me.state
+     * @memberof state
      */
     PLAY : 3,
 
@@ -191,7 +190,7 @@ var state = {
      * default state ID for Game Over Stage
      * @constant
      * @name GAMEOVER
-     * @memberof me.state
+     * @memberof state
      */
     GAMEOVER : 4,
 
@@ -199,7 +198,7 @@ var state = {
      * default state ID for Game End Stage
      * @constant
      * @name GAME_END
-     * @memberof me.state
+     * @memberof state
      */
     GAME_END : 5,
 
@@ -207,7 +206,7 @@ var state = {
      * default state ID for High Score Stage
      * @constant
      * @name SCORE
-     * @memberof me.state
+     * @memberof state
      */
     SCORE : 6,
 
@@ -215,7 +214,7 @@ var state = {
      * default state ID for Credits Stage
      * @constant
      * @name CREDITS
-     * @memberof me.state
+     * @memberof state
      */
     CREDITS : 7,
 
@@ -223,7 +222,7 @@ var state = {
      * default state ID for Settings Stage
      * @constant
      * @name SETTINGS
-     * @memberof me.state
+     * @memberof state
      */
     SETTINGS : 8,
 
@@ -232,7 +231,7 @@ var state = {
      * (the default stage is the one running as soon as melonJS is started)
      * @constant
      * @name SETTINGS
-     * @memberof me.state
+     * @memberof state
      */
     DEFAULT : 9,
 
@@ -240,7 +239,7 @@ var state = {
      * default state ID for user defined constants<br>
      * @constant
      * @name USER
-     * @memberof me.state
+     * @memberof state
      * @example
      * var STATE_INFO = me.state.USER + 0;
      * var STATE_WARN = me.state.USER + 1;
@@ -252,7 +251,7 @@ var state = {
     /**
      * Stop the current screen object.
      * @name stop
-     * @memberof me.state
+     * @memberof state
      * @public
      * @function
      * @param {boolean} [pauseTrack=false] pause current track on screen stop.
@@ -279,7 +278,7 @@ var state = {
     /**
      * pause the current screen object
      * @name pause
-     * @memberof me.state
+     * @memberof state
      * @public
      * @function
      * @param {boolean} [music=false] pause current music track on screen pause
@@ -305,7 +304,7 @@ var state = {
     /**
      * Restart the screen object from a full stop.
      * @name restart
-     * @memberof me.state
+     * @memberof state
      * @public
      * @function
      * @param {boolean} [music=false] resume current music track on screen resume
@@ -333,7 +332,7 @@ var state = {
     /**
      * resume the screen object
      * @name resume
-     * @memberof me.state
+     * @memberof state
      * @public
      * @function
      * @param {boolean} [music=false] resume current music track on screen resume
@@ -358,7 +357,7 @@ var state = {
     /**
      * return the running state of the state manager
      * @name isRunning
-     * @memberof me.state
+     * @memberof state
      * @public
      * @function
      * @returns {boolean} true if a "process is running"
@@ -370,7 +369,7 @@ var state = {
     /**
      * Return the pause state of the state manager
      * @name isPaused
-     * @memberof me.state
+     * @memberof state
      * @public
      * @function
      * @returns {boolean} true if the game is paused
@@ -382,11 +381,11 @@ var state = {
     /**
      * associate the specified state with a Stage
      * @name set
-     * @memberof me.state
+     * @memberof state
      * @public
      * @function
      * @param {number} state State ID (see constants)
-     * @param {me.Stage} stage Instantiated Stage to associate with state ID
+     * @param {Stage} stage Instantiated Stage to associate with state ID
      * @param {boolean} [start = false] if true the state will be changed immediately after adding it.
      * @example
      * class MenuButton extends me.GUI_Object {
@@ -442,10 +441,10 @@ var state = {
      * return a reference to the current screen object<br>
      * useful to call a object specific method
      * @name current
-     * @memberof me.state
+     * @memberof state
      * @public
      * @function
-     * @returns {me.Stage}
+     * @returns {Stage}
      */
     current() {
         if (typeof _stages[_state] !== "undefined") {
@@ -456,11 +455,11 @@ var state = {
     /**
      * specify a global transition effect
      * @name transition
-     * @memberof me.state
+     * @memberof state
      * @public
      * @function
      * @param {string} effect (only "fade" is supported for now)
-     * @param {me.Color|string} color a CSS color value
+     * @param {Color|string} color a CSS color value
      * @param {number} [duration=1000] expressed in milliseconds
      */
     transition(effect, color, duration) {
@@ -473,7 +472,7 @@ var state = {
     /**
      * enable/disable transition for a specific state (by default enabled for all)
      * @name setTransition
-     * @memberof me.state
+     * @memberof state
      * @public
      * @function
      * @param {number} state State ID (see constants)
@@ -486,7 +485,7 @@ var state = {
     /**
      * change the game/app state
      * @name change
-     * @memberof me.state
+     * @memberof state
      * @public
      * @function
      * @param {number} state State ID (see constants)
@@ -541,7 +540,7 @@ var state = {
     /**
      * return true if the specified state is the current one
      * @name isCurrent
-     * @memberof me.state
+     * @memberof state
      * @public
      * @function
      * @param {number} state State ID (see constants)