melonjs 14.0.1 → 14.1.0

package/src/renderable/container.js

@@ -23,10 +23,10 @@ var globalFloatingCounter = 0;
  */
 class Container extends Renderable {
     /**
-     * @param {number} [x=0] position of the container (accessible via the inherited pos.x property)
-     * @param {number} [y=0] position of the container (accessible via the inherited pos.y property)
-     * @param {number} [width=game.viewport.width] width of the container
-     * @param {number} [height=game.viewport.height] height of the container
+     * @param {number} [x=0] - position of the container (accessible via the inherited pos.x property)
+     * @param {number} [y=0] - position of the container (accessible via the inherited pos.y property)
+     * @param {number} [width=game.viewport.width] - width of the container
+     * @param {number} [height=game.viewport.height] - height of the container
      */
     constructor(x = 0, y = 0, width, height, root = false) {
 
@@ -104,7 +104,7 @@ class Container extends Renderable {
          * a callback to be extended, triggered after a child has been added or removed
          * @name onChildChange
          * @memberof Container#
-         * @param {number} index added or removed child index
+         * @param {number} index - added or removed child index
          */
         this.onChildChange = function (index) {   // eslint-disable-line no-unused-vars
             // to be extended
@@ -198,7 +198,7 @@ class Container extends Renderable {
      * @name addChild
      * @memberof Container
      * @param {Renderable} child
-     * @param {number} [z] forces the z index of the child to the specified value
+     * @param {number} [z] - forces the z index of the child to the specified value
      * @returns {Renderable} the added child
      */
     addChild(child, z) {
@@ -318,8 +318,8 @@ class Container extends Renderable {
      *    - The array forEach() was called upon. <br>
      * @name forEach
      * @memberof Container
-     * @param {Function} callback fnction to execute on each element
-     * @param {object} [thisArg] value to use as this(i.e reference Object) when executing callback.
+     * @param {Function} callback - fnction to execute on each element
+     * @param {object} [thisArg] - value to use as this(i.e reference Object) when executing callback.
      * @example
      * // iterate through all children of the root container
      * me.game.world.forEach((child) => {
@@ -437,8 +437,8 @@ class Container extends Renderable {
      * @name getChildByProp
      * @memberof Container
      * @public
-     * @param {string} prop Property name
-     * @param {string|RegExp|number|boolean} value Value of the property
+     * @param {string} prop - Property name
+     * @param {string|RegExp|number|boolean} value - Value of the property
      * @returns {Renderable[]} Array of childs
      * @example
      * // get the first child object called "mainPlayer" in a specific container :
@@ -514,7 +514,7 @@ class Container extends Renderable {
      * @name getChildByName
      * @memberof Container
      * @public
-     * @param {string|RegExp|number|boolean} name child name
+     * @param {string|RegExp|number|boolean} name - child name
      * @returns {Renderable[]} Array of children
      */
     getChildByName(name) {
@@ -528,7 +528,7 @@ class Container extends Renderable {
      * @name getChildByGUID
      * @memberof Container
      * @public
-     * @param {string|RegExp|number|boolean} guid child GUID
+     * @param {string|RegExp|number|boolean} guid - child GUID
      * @returns {Renderable} corresponding child or null
      */
     getChildByGUID(guid) {
@@ -642,7 +642,7 @@ class Container extends Renderable {
      * @memberof Container
      * @public
      * @param {Renderable} child
-     * @param {boolean} [keepalive=false] true to prevent calling child.destroy()
+     * @param {boolean} [keepalive=false] - true to prevent calling child.destroy()
      */
     removeChild(child, keepalive) {
         if (this.hasChild(child)) {
@@ -660,7 +660,7 @@ class Container extends Renderable {
      * @name removeChildNow
      * @memberof Container
      * @param {Renderable} child
-     * @param {boolean} [keepalive=False] True to prevent calling child.destroy()
+     * @param {boolean} [keepalive=False] - True to prevent calling child.destroy()
      */
     removeChildNow(child, keepalive) {
         if (this.hasChild(child) && (this.getChildIndex(child) >= 0)) {
@@ -711,9 +711,9 @@ class Container extends Renderable {
      * Automatically set the specified property of all childs to the given value
      * @name setChildsProperty
      * @memberof Container
-     * @param {string} prop property name
-     * @param {object} value property value
-     * @param {boolean} [recursive=false] recursively apply the value to child containers if true
+     * @param {string} prop - property name
+     * @param {object} value - property value
+     * @param {boolean} [recursive=false] - recursively apply the value to child containers if true
      */
     setChildsProperty(prop, value, recursive) {
         this.forEach((child) => {
@@ -799,7 +799,7 @@ class Container extends Renderable {
      * @name sort
      * @memberof Container
      * @public
-     * @param {boolean} [recursive=false] recursively sort all containers if true
+     * @param {boolean} [recursive=false] - recursively sort all containers if true
      */
     sort(recursive) {
         // do nothing if there is already a pending sort
@@ -893,7 +893,7 @@ class Container extends Renderable {
      * @name update
      * @memberof Container
      * @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 Container is dirty
      */
     update(dt) {
@@ -944,8 +944,8 @@ class Container extends Renderable {
      * @name draw
      * @memberof Container
      * @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) {
         var isFloating = false;

package/src/renderable/dragndrop.js

@@ -11,10 +11,10 @@ import Renderable from "./../renderable/renderable.js";
  */
 export class Draggable extends Renderable {
     /**
-     * @param {number} x the x coordinates of the draggable object
-     * @param {number} y the y coordinates of the draggable object
-     * @param {number} width draggable object width
-     * @param {number} height draggable object height
+     * @param {number} x - the x coordinates of the draggable object
+     * @param {number} y - the y coordinates of the draggable object
+     * @param {number} width - draggable object width
+     * @param {number} height - draggable object height
      */
     constructor(x, y, width, height) {
         super(x, y, width, height);
@@ -56,7 +56,7 @@ export class Draggable extends Renderable {
      * Gets called when the user starts dragging the entity
      * @name dragStart
      * @memberof Draggable
-     * @param {object} e the pointer event
+     * @param {object} e - the pointer event
      * @returns {boolean} false if the object is being dragged
      */
     dragStart(e) {
@@ -72,7 +72,7 @@ export class Draggable extends Renderable {
      * Gets called when the user drags this entity around
      * @name dragMove
      * @memberof Draggable
-     * @param {object} e the pointer event
+     * @param {object} e - the pointer event
      */
     dragMove(e) {
         if (this.dragging === true) {
@@ -119,10 +119,10 @@ export class Draggable extends Renderable {
  */
 export class DropTarget extends Renderable {
     /**
-     * @param {number} x the x coordinates of the drop target
-     * @param {number} y the y coordinates of the drop target
-     * @param {number} width drop target width
-     * @param {number} height drop target height
+     * @param {number} x - the x coordinates of the drop target
+     * @param {number} y - the y coordinates of the drop target
+     * @param {number} width - drop target width
+     * @param {number} height - drop target height
      */
     constructor(x, y, width, height) {
         super(x, y, width, height);
@@ -168,7 +168,7 @@ export class DropTarget extends Renderable {
      * Sets the collision method which is going to be used to check a valid drop
      * @name setCheckMethod
      * @memberof DropTarget
-     * @param {string} checkMethod the checkmethod (defaults to CHECKMETHOD_OVERLAP)
+     * @param {string} checkMethod - the checkmethod (defaults to CHECKMETHOD_OVERLAP)
      */
     setCheckMethod(checkMethod) {
         //  We can improve this check,
@@ -182,8 +182,8 @@ export class DropTarget extends Renderable {
      * Checks if a dropped entity is dropped on the current entity
      * @name checkOnMe
      * @memberof DropTarget
-     * @param {object} e the triggering event
-     * @param {Draggable} draggable the draggable object that is dropped
+     * @param {object} e - the triggering event
+     * @param {Draggable} draggable - the draggable object that is dropped
      */
     checkOnMe(e, draggable) {
         if (draggable && this.getBounds()[this.checkMethod](draggable.getBounds())) {
@@ -196,7 +196,7 @@ export class DropTarget extends Renderable {
      * Gets called when a draggable entity is dropped on the current entity
      * @name drop
      * @memberof DropTarget
-     * @param {Draggable} draggable the draggable object that is dropped
+     * @param {Draggable} draggable - the draggable object that is dropped
      */
     drop(draggable) {  // eslint-disable-line no-unused-vars
 

package/src/renderable/imagelayer.js

@@ -13,15 +13,15 @@ import * as stringUtil from "./../utils/string.js";
  */
 class ImageLayer extends Sprite {
     /**
-     * @param {number} x x coordinate
-     * @param {number} y y coordinate
-     * @param {object} settings ImageLayer properties
-     * @param {HTMLImageElement|HTMLCanvasElement|string} settings.image Image reference. See {@link loader.getImage}
-     * @param {string} [settings.name="me.ImageLayer"] layer name
-     * @param {number} [settings.z=0] z-index position
-     * @param {number|Vector2d} [settings.ratio=1.0] Scrolling ratio to be applied. See {@link ImageLayer#ratio}
-     * @param {string} [settings.repeat='repeat'] define if and how an Image Layer should be repeated (accepted values are 'repeat', 'repeat-x', 'repeat-y', 'no-repeat'). See {@link ImageLayer#repeat}
-     * @param {number|Vector2d} [settings.anchorPoint=0.0] Image origin. See {@link ImageLayer#anchorPoint}
+     * @param {number} x - x coordinate
+     * @param {number} y - y coordinate
+     * @param {object} settings - ImageLayer properties
+     * @param {HTMLImageElement|HTMLCanvasElement|string} settings.image - Image reference. See {@link loader.getImage}
+     * @param {string} [settings.name="me.ImageLayer"] - layer name
+     * @param {number} [settings.z=0] - z-index position
+     * @param {number|Vector2d} [settings.ratio=1.0] - Scrolling ratio to be applied. See {@link ImageLayer#ratio}
+     * @param {string} [settings.repeat='repeat'] - define if and how an Image Layer should be repeated (accepted values are 'repeat', 'repeat-x', 'repeat-y', 'no-repeat'). See {@link ImageLayer#repeat}
+     * @param {number|Vector2d} [settings.anchorPoint=0.0] - Image origin. See {@link ImageLayer#anchorPoint}
      * @example
      * // create a repetitive background pattern on the X axis using the citycloud image asset
      * me.game.world.addChild(new me.ImageLayer(0, 0, {
@@ -160,8 +160,8 @@ class ImageLayer extends Sprite {
      * resize the Image Layer to match the given size
      * @name resize
      * @memberof ImageLayer
-     * @param {number} w new width
-     * @param {number} h new height
+     * @param {number} w - new width
+     * @param {number} h - new height
      */
     resize(w, h) {
         return super.resize(
@@ -247,8 +247,8 @@ class ImageLayer extends Sprite {
      * @name draw
      * @memberof ImageLayer
      * @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) {
         var width = this.width,

package/src/renderable/light2d.js

@@ -55,7 +55,7 @@ class Light2d extends Renderable {
     * @param {number} y - The vertical position of the light.
     * @param {number} radiusX - The horizontal radius of the light.
     * @param {number} [radiusY=radiusX] - The vertical radius of the light.
-    * @param {Color|string} [color="#FFF"] the color of the light
+    * @param {Color|string} [color="#FFF"] - the color of the light
     * @param {number} [intensity=0.7] - The intensity of the light.
     */
     constructor(x, y, radiusX, radiusY = radiusX, color = "#FFF", intensity = 0.7) {
@@ -123,8 +123,8 @@ class Light2d extends Renderable {
      * @name draw
      * @memberof Light2d
      * @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
         renderer.drawImage(this.texture.canvas, this.getBounds().x, this.getBounds().y);

package/src/renderable/nineslicesprite.js

@@ -10,22 +10,22 @@ import Sprite from "./sprite.js";
  */
 class NineSliceSprite extends Sprite {
     /**
-     * @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 {number} settings.width the width of the Renderable over which the sprite needs to be stretched
-     * @param {number} settings.height the height of the Renderable over which the sprite needs to be stretched
-     * @param {number} [settings.insetx] the width of a corner over which the sprite is unscaled (default is a quarter of the sprite width)
-     * @param {number} [settings.insety] the height of a corner over which the sprite is unscaled (default is a quarter of the sprite height)
-     * @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 {number} settings.width - the width of the Renderable over which the sprite needs to be stretched
+     * @param {number} settings.height - the height of the Renderable over which the sprite needs to be stretched
+     * @param {number} [settings.insetx] - the width of a corner over which the sprite is unscaled (default is a quarter of the sprite width)
+     * @param {number} [settings.insety] - the height of a corner over which the sprite is unscaled (default is a quarter of the sprite height)
+     * @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
      * this.panelSprite = new me.NineSliceSprite(0, 0, {
      *     image : game.texture,

package/src/renderable/renderable.js

@@ -14,10 +14,10 @@ import Color from "./../math/color.js";
  */
 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 +358,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 +374,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 +386,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 +398,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 +453,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 +474,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 +493,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 +506,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 +516,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
@@ -584,8 +584,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 +600,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 +659,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 +670,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 +691,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

package/src/renderable/sprite.js

@@ -12,18 +12,18 @@ import Color from "../math/color.js";
  */
 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

package/src/renderable/trigger.js

@@ -12,19 +12,19 @@ import pool from "./../system/pooling.js";
  */
 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