melonjs 14.0.2 → 14.1.1

package/src/renderable/renderable.js

@@ -1,7 +1,6 @@
 import ObservableVector2d from "./../math/observable_vector2.js";
 import ObservableVector3d from "./../math/observable_vector3.js";
 import Rect from "./../geometries/rectangle.js";
-import Container from "./container.js";
 import pool from "./../system/pooling.js";
 import { releaseAllPointerEvents } from "./../input/input.js";
 import { clamp } from "./../math/math.js";
@@ -12,12 +11,12 @@ import Color from "./../math/color.js";
  * A base class for renderable objects.
  * @augments Rect
  */
-class Renderable extends Rect {
+ export default class Renderable extends Rect {
     /**
-     * @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
-     * @param {number} height object height
+     * @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
+     * @param {number} height - object height
      */
     constructor(x, y, width, height) {
 
@@ -358,7 +357,7 @@ class Renderable extends Rect {
 
     /**
      * set the renderable alpha channel value<br>
-     * @param {number} alpha opacity value between 0.0 and 1.0
+     * @param {number} alpha - opacity value between 0.0 and 1.0
      */
     setOpacity(alpha) {
         if (typeof (alpha) === "number") {
@@ -374,7 +373,7 @@ class Renderable extends Rect {
     /**
      * flip the renderable on the horizontal axis (around the center of the renderable)
      * @see Matrix2d#scaleX
-     * @param {boolean} [flip=true] `true` to flip this renderable.
+     * @param {boolean} [flip=true] - `true` to flip this renderable.
      * @returns {Renderable} Reference to this object for method chaining
      */
     flipX(flip = true) {
@@ -386,7 +385,7 @@ class Renderable extends Rect {
     /**
      * flip the renderable on the vertical axis (around the center of the renderable)
      * @see Matrix2d#scaleY
-     * @param {boolean} [flip=true] `true` to flip this renderable.
+     * @param {boolean} [flip=true] - `true` to flip this renderable.
      * @returns {Renderable} Reference to this object for method chaining
      */
     flipY(flip = true) {
@@ -398,7 +397,7 @@ class Renderable extends Rect {
     /**
      * multiply the renderable currentTransform with the given matrix
      * @see Renderable#currentTransform
-     * @param {Matrix2d} m the transformation matrix
+     * @param {Matrix2d} m - the transformation matrix
      * @returns {Renderable} Reference to this object for method chaining
      */
     transform(m) {
@@ -453,7 +452,7 @@ class Renderable extends Rect {
 
     /**
      * Rotate this renderable towards the given target.
-     * @param {Renderable|Vector2d|Vector3d} target the renderable or position to look at
+     * @param {Renderable|Vector2d|Vector3d} target - the renderable or position to look at
      * @returns {Renderable} Reference to this object for method chaining
      */
     lookAt(target) {
@@ -474,8 +473,8 @@ class Renderable extends Rect {
 
     /**
      * Rotate this renderable by the specified angle (in radians).
-     * @param {number} angle The angle to rotate (in radians)
-     * @param {Vector2d|ObservableVector2d} [v] an optional point to rotate around
+     * @param {number} angle - The angle to rotate (in radians)
+     * @param {Vector2d|ObservableVector2d} [v] - an optional point to rotate around
      * @returns {Renderable} Reference to this object for method chaining
      */
     rotate(angle, v) {
@@ -493,8 +492,8 @@ class Renderable extends Rect {
      * when rendering.  It does not scale the object itself.  For example if the renderable
      * is an image, the image.width and image.height properties are unaltered but the currentTransform
      * member will be changed.
-     * @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.
+     * @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.
      * @returns {Renderable} Reference to this object for method chaining
      */
     scale(x, y) {
@@ -506,7 +505,7 @@ class Renderable extends Rect {
 
     /**
      * scale the renderable around his anchor point
-     * @param {Vector2d} v scaling vector
+     * @param {Vector2d} v - scaling vector
      * @returns {Renderable} Reference to this object for method chaining
      */
     scaleV(v) {
@@ -516,7 +515,7 @@ class Renderable extends Rect {
 
     /**
      * update function (automatically called by melonJS).
-     * @param {number} dt time since the last update in milliseconds.
+     * @param {number} dt - time since the last update in milliseconds.
      * @returns {boolean} true if the renderable is dirty
      */
     update(dt) { // eslint-disable-line no-unused-vars
@@ -558,7 +557,7 @@ class Renderable extends Rect {
          */
 
          // XXX: This is called from the constructor, before it gets an ancestor
-         if (this.ancestor instanceof Container && this.floating !== true) {
+         if (typeof this.ancestor !== "undefined" && typeof this.ancestor.addChild === "function" && this.floating !== true) {
              bounds.translate(this.ancestor.getAbsolutePosition());
          }
 
@@ -575,7 +574,7 @@ class Renderable extends Rect {
           }
           // XXX Cache me or something
           this._absPos.set(this.pos.x, this.pos.y);
-          if (this.ancestor instanceof Container && this.floating !== true) {
+          if (typeof this.ancestor !== "undefined" && typeof this.ancestor.addChild === "function" && this.floating !== true) {
               this._absPos.add(this.ancestor.getAbsolutePosition());
           }
           return this._absPos;
@@ -584,8 +583,8 @@ class Renderable extends Rect {
     /**
      * called when the anchor point value is changed
      * @private
-     * @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
+     * @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
      */
      onAnchorUpdate(x, y) {
          // since the callback is called before setting the new value
@@ -600,7 +599,7 @@ class Renderable extends Rect {
      * This will apply any defined transforms, anchor point, tint or blend mode and translate the context accordingly to this renderable position.
      * @see Renderable#draw
      * @see Renderable#postDraw
-     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
+     * @param {CanvasRenderer|WebGLRenderer} renderer - a renderer object
      */
     preDraw(renderer) {
         var bounds = this.getBounds();
@@ -659,8 +658,8 @@ class Renderable extends Rect {
      * from the draw method, you should make sure that your draw it at the 0, 0 coordinates.
      * @see Renderable#preDraw
      * @see Renderable#postDraw
-     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer instance
-     * @param {Camera2d} [viewport] the viewport to (re)draw
+     * @param {CanvasRenderer|WebGLRenderer} renderer - a renderer instance
+     * @param {Camera2d} [viewport] - the viewport to (re)draw
      */
     draw(renderer, viewport) {  // eslint-disable-line no-unused-vars
         // empty one !
@@ -670,7 +669,7 @@ class Renderable extends Rect {
      * restore the rendering context after drawing (automatically called by melonJS).
      * @see Renderable#preDraw
      * @see Renderable#draw
-     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
+     * @param {CanvasRenderer|WebGLRenderer} renderer - a renderer object
      */
     postDraw(renderer) {
         // remove the previously applied tint
@@ -691,8 +690,8 @@ class Renderable extends Rect {
     /**
      * onCollision callback, triggered in case of collision,
      * when this renderable body is colliding with another one
-     * @param {ResponseObject} response the collision response object
-     * @param {Renderable} other the other renderable touching this one (a reference to response.a or response.b)
+     * @param {ResponseObject} response - the collision response object
+     * @param {Renderable} other - the other renderable touching this one (a reference to response.a or response.b)
      * @returns {boolean} true if the object should respond to the collision (its position and velocity will be corrected)
      * @example
      * // colision handler
@@ -771,4 +770,3 @@ class Renderable extends Rect {
     }
 
 }
-export default Renderable;

package/src/renderable/sprite.js

@@ -10,20 +10,20 @@ import Color from "../math/color.js";
  * An object to display a fixed or animated sprite on screen.
  * @augments Renderable
  */
-class Sprite extends Renderable {
+ export default class Sprite extends Renderable {
     /**
-     * @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).
+     * @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, {
@@ -226,8 +226,8 @@ class Sprite extends Renderable {
      * make the object flicker
      * @name flicker
      * @memberof Sprite
-     * @param {number} duration expressed in milliseconds
-     * @param {Function} callback Function to call when flickering ends
+     * @param {number} duration - expressed in milliseconds
+     * @param {Function} callback - Function to call when flickering ends
      * @returns {Sprite} Reference to this object for method chaining
      * @example
      * // make the object flicker for 1 second
@@ -256,10 +256,10 @@ class Sprite extends Renderable {
      * <img src="images/spritesheet_grid.png"/>
      * @name addAnimation
      * @memberof Sprite
-     * @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
+     * @param {number} [animationspeed] - cycling speed for animation in ms
      * @returns {number} frame amount of frame added to the animation (delay between each frame).
      * @see Sprite#animationspeed
      * @example
@@ -355,9 +355,9 @@ class Sprite extends Renderable {
      * this will always change the animation & set the frame to zero
      * @name setCurrentAnimation
      * @memberof Sprite
-     * @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
+     * @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 {Sprite} Reference to this object for method chaining
      * @example
      * // set "walk" animation
@@ -415,7 +415,7 @@ class Sprite extends Renderable {
      * reverse the given or current animation if none is specified
      * @name reverseAnimation
      * @memberof Sprite
-     * @param {string} [name] animation id
+     * @param {string} [name] - animation id
      * @returns {Sprite} Reference to this object for method chaining
      * @see Sprite#animationspeed
      */
@@ -433,7 +433,7 @@ class Sprite extends Renderable {
      * return true if the specified animation is the current one.
      * @name isCurrentAnimation
      * @memberof Sprite
-     * @param {string} name animation id
+     * @param {string} name - animation id
      * @returns {boolean}
      * @example
      * if (!this.isCurrentAnimation("walk")) {
@@ -449,7 +449,7 @@ class Sprite extends Renderable {
      * @see Texture.getRegion
      * @name setRegion
      * @memberof Sprite
-     * @param {object} region typically returned through me.Texture.getRegion()
+     * @param {object} region - typically returned through me.Texture.getRegion()
      * @returns {Sprite} Reference to this object for method chaining
      * @example
      * // change the sprite to "shadedDark13.png";
@@ -480,7 +480,7 @@ class Sprite extends Renderable {
      * force the current animation frame index.
      * @name setAnimationFrame
      * @memberof Sprite
-     * @param {number} [idx=0] animation frame index
+     * @param {number} [idx=0] - animation frame index
      * @returns {Sprite} Reference to this object for method chaining
      * @example
      * // reset the current animation to the first frame
@@ -506,7 +506,7 @@ class Sprite extends Renderable {
      * @name getAnimationFrameObjectByIndex
      * @memberof Sprite
      * @ignore
-     * @param {number} id the frame id
+     * @param {number} id - the frame id
      * @returns {number} if using number indices. Returns {object} containing frame data if using texture atlas
      */
     getAnimationFrameObjectByIndex(id) {
@@ -519,7 +519,7 @@ class Sprite extends Renderable {
      * @name update
      * @memberof Sprite
      * @protected
-     * @param {number} dt time since the last update in milliseconds.
+     * @param {number} dt - time since the last update in milliseconds.
      * @returns {boolean} true if the Sprite is dirty
      */
     update(dt) {
@@ -596,8 +596,8 @@ class Sprite extends Renderable {
      * @name draw
      * @memberof Sprite
      * @protected
-     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer instance
-     * @param {Camera2d} [viewport] the viewport to (re)draw
+     * @param {CanvasRenderer|WebGLRenderer} renderer - a renderer instance
+     * @param {Camera2d} [viewport] - the viewport to (re)draw
      */
     draw(renderer, viewport) {   // eslint-disable-line no-unused-vars
         // do nothing if we are flickering
@@ -642,4 +642,3 @@ class Sprite extends Renderable {
         );
     }
 }
-export default Sprite;

package/src/renderable/trigger.js

@@ -10,21 +10,21 @@ import pool from "./../system/pooling.js";
  * trigger an event when colliding with another object
  * @augments Renderable
  */
-class Trigger extends Renderable {
+ export default class Trigger extends Renderable {
     /**
-     * @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}
+     * @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, {
@@ -133,8 +133,8 @@ class Trigger extends Renderable {
      * onCollision callback, triggered in case of collision with this trigger
      * @name onCollision
      * @memberof Trigger
-     * @param {ResponseObject} response the collision response object
-     * @param {Renderable} other the other renderable touching this one (a reference to response.a or response.b)
+     * @param {ResponseObject} response - the collision response object
+     * @param {Renderable} other - the other renderable touching this one (a reference to response.a or response.b)
      * @returns {boolean} true if the object should respond to the collision (its position and velocity will be corrected)
      */
     onCollision(response, other) { // eslint-disable-line no-unused-vars
@@ -145,4 +145,3 @@ class Trigger extends Renderable {
     }
 
 }
-export default Trigger;

package/src/renderable/ui/uibaseelement.js

@@ -9,13 +9,13 @@ import { registerPointerEvent, releasePointerEvent} from "./../../input/input.js
  * text and images.
  * @augments Container
  */
-class UIBaseElement extends Container {
+ export default class UIBaseElement extends Container {
     /**
      *
-     * @param {number} x The x position of the container
-     * @param {number} y The y position of the container
-     * @param {number} w width of the container (default: viewport width)
-     * @param {number} h height of the container (default: viewport height)
+     * @param {number} x - The x position of the container
+     * @param {number} y - The y position of the container
+     * @param {number} w - width of the container (default: viewport width)
+     * @param {number} h - height of the container (default: viewport height)
      */
     constructor(x, y, w, h) {
         super(x, y, w, h);
@@ -83,7 +83,7 @@ class UIBaseElement extends Container {
 
     /**
      * function called when the object is pressed (to be extended)
-     * @param {Pointer} event the event object
+     * @param {Pointer} event - the event object
      * @returns {boolean} return false if we need to stop propagating the event
      */
     onClick(event) { // eslint-disable-line no-unused-vars
@@ -102,7 +102,7 @@ class UIBaseElement extends Container {
 
     /**
      * function called when the pointer is over the object
-     * @param {Pointer} event the event object
+     * @param {Pointer} event - the event object
      */
     onOver(event) { // eslint-disable-line no-unused-vars
         // to be extended
@@ -121,7 +121,7 @@ class UIBaseElement extends Container {
 
     /**
      * function called when the pointer is leaving the object area
-     * @param {Pointer} event the event object
+     * @param {Pointer} event - the event object
      */
     onOut(event) { // eslint-disable-line no-unused-vars
         // to be extended
@@ -201,4 +201,3 @@ class UIBaseElement extends Container {
         timer.clearTimeout(this.holdTimeout);
     }
 }
-export default UIBaseElement;

package/src/renderable/ui/uispriteelement.js

@@ -7,11 +7,11 @@ import { registerPointerEvent, releasePointerEvent} from "./../../input/input.js
  *  This is a basic sprite based button which you can use in your Game UI.
  * @augments Sprite
  */
-class UISpriteElement extends Sprite {
+ export default class UISpriteElement extends Sprite {
     /**
-     * @param {number} x the x coordinate of the GUI Object
-     * @param {number} y the y coordinate of the GUI Object
-     * @param {object} settings See {@link Sprite}
+     * @param {number} x - the x coordinate of the GUI Object
+     * @param {number} y - the y coordinate of the GUI Object
+     * @param {object} settings - See {@link Sprite}
      * @example
      * // create a basic GUI Object
      * class myButton extends UISpriteElement {
@@ -104,7 +104,7 @@ class UISpriteElement extends Sprite {
 
     /**
      * function called when the object is pressed (to be extended)
-     * @param {Pointer} event the event object
+     * @param {Pointer} event - the event object
      * @returns {boolean} return false if we need to stop propagating the event
      */
     onClick(event) { // eslint-disable-line no-unused-vars
@@ -123,7 +123,7 @@ class UISpriteElement extends Sprite {
 
     /**
      * function called when the pointer is over the object
-     * @param {Pointer} event the event object
+     * @param {Pointer} event - the event object
      */
     onOver(event) { // eslint-disable-line no-unused-vars
         // to be extended
@@ -142,7 +142,7 @@ class UISpriteElement extends Sprite {
 
     /**
      * function called when the pointer is leaving the object area
-     * @param {Pointer} event the event object
+     * @param {Pointer} event - the event object
      */
     onOut(event) { // eslint-disable-line no-unused-vars
         // to be extended
@@ -214,4 +214,4 @@ class UISpriteElement extends Sprite {
         timer.clearTimeout(this.holdTimeout);
     }
 }
-export default UISpriteElement;
+

package/src/renderable/ui/uitextbutton.js

@@ -9,25 +9,25 @@ import UIBaseElement from "./uibaseelement.js";
  * This is a basic base text button which you can use in your Game UI.
  * @augments UIBaseElement
  */
-class UITextButton extends UIBaseElement {
+ export default class UITextButton extends UIBaseElement {
     /**
      * A Text Button with an outlined background border, filled with background color.
      * It uses a RoundRect as background and changes the background color on hovering over.
      * The background will be drawn with 0.5 opacity, so that the background of the button is
      * slightly shining through.
-     * @param {number} x x pos of the button
-     * @param {number} y y pos of the button
-     * @param {string} [settings.font] The name of the BitmapText font to use
-     * @param {number} [settings.size] The scale factor of the font (default: 1)
-     * @param {string} [settings.text] The text to display (default: 'click me')
-     * @param {string} [settings.bindKey] The key to bind the action to (default: none)
-     * @param {string} [settings.backgroundColor] The css value of a background color
-     * @param {string} [settings.hoverColor] The css value of a color to be used if the pointer hovers over the button
-     * @param {string} [settings.borderStrokeColor] The css value of a color to be used to draw the border
-     * @param {boolean} [settings.offScreenCanvas] Weather to use an offScreen canvas or not
-     * @param {string} [settings.fillStyle] The css value of a tint color to be used to tint the text
-     * @param {number} [settings.borderWidth] Width of the button
-     * @param {number} [settings.borderHeight] Height of the button
+     * @param {number} x - x pos of the button
+     * @param {number} y - y pos of the button
+     * @param {string} [settings.font] - The name of the BitmapText font to use
+     * @param {number} [settings.size] - The scale factor of the font (default: 1)
+     * @param {string} [settings.text] - The text to display (default: 'click me')
+     * @param {string} [settings.bindKey] - The key to bind the action to (default: none)
+     * @param {string} [settings.backgroundColor] - The css value of a background color
+     * @param {string} [settings.hoverColor] - The css value of a color to be used if the pointer hovers over the button
+     * @param {string} [settings.borderStrokeColor] - The css value of a color to be used to draw the border
+     * @param {boolean} [settings.offScreenCanvas] - Weather to use an offScreen canvas or not
+     * @param {string} [settings.fillStyle] - The css value of a tint color to be used to tint the text
+     * @param {number} [settings.borderWidth] - Width of the button
+     * @param {number} [settings.borderHeight] - Height of the button
      * @example
      * // Create a new Button
      * class PlayButton extends BaseTextButton {
@@ -117,5 +117,5 @@ class UITextButton extends UIBaseElement {
         );
     }
 }
-export default UITextButton;
+
 

package/src/state/stage.js

@@ -18,13 +18,13 @@ var default_settings = {
  * through the state manager must inherit from this base class.
  * @see state
  */
-class Stage {
+ export default class Stage {
 
     /**
-     * @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
+     * @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) {
         /**
@@ -116,7 +116,7 @@ class Stage {
      * @name update
      * @memberof Stage
      * @ignore
-     * @param {number} dt time since the last update in milliseconds.
+     * @param {number} dt - time since the last update in milliseconds.
      * @returns {boolean}
      */
     update(dt) {
@@ -146,7 +146,7 @@ class Stage {
      * @name draw
      * @memberof Stage
      * @ignore
-     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
+     * @param {CanvasRenderer|WebGLRenderer} renderer - a renderer object
      */
     draw(renderer) {
         // iterate through all cameras
@@ -201,7 +201,7 @@ class Stage {
      * this is typically where you will load a level, add renderables, etc...
      * @name onResetEvent
      * @memberof Stage
-     * @param {object} [...arguments] optional arguments passed when switching state
+     * @param {object} [...arguments] - optional arguments passed when switching state
      * @see state#change
      */
     onResetEvent() {
@@ -225,4 +225,3 @@ class Stage {
         }
     }
 }
-export default Stage;