melonjs 10.1.1 → 10.2.3

package/src/renderable/container.js

@@ -23,10 +23,10 @@ var globalFloatingCounter = 0;
  * @extends me.Renderable
  * @memberOf me
  * @constructor
- * @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} [w=me.game.viewport.width] width of the container
- * @param {Number} [h=me.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} [w=me.game.viewport.width] width of the container
+ * @param {number} [h=me.game.viewport.height] height of the container
  */
 
 class Container extends Renderable {
@@ -48,7 +48,7 @@ class Container extends Renderable {
         /**
          * whether the container is the root of the scene
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @default false
          * @name root
          * @memberOf me.Container
@@ -65,7 +65,7 @@ class Container extends Renderable {
          * The property of the child object that should be used to sort on <br>
          * value : "x", "y", "z"
          * @public
-         * @type String
+         * @type {string}
          * @default me.game.sortOn
          * @name sortOn
          * @memberOf me.Container
@@ -75,7 +75,7 @@ class Container extends Renderable {
         /**
          * Specify if the children list should be automatically sorted when adding a new child
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @default true
          * @name autoSort
          * @memberOf me.Container
@@ -85,7 +85,7 @@ class Container extends Renderable {
         /**
          * Specify if the children z index should automatically be managed by the parent container
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @default true
          * @name autoDepth
          * @memberOf me.Container
@@ -95,7 +95,7 @@ class Container extends Renderable {
         /**
          * Specify if the container draw operation should clip his children to its own bounds
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @default false
          * @name clipping
          * @memberOf me.Container
@@ -107,7 +107,7 @@ class Container extends Renderable {
          * @name onChildChange
          * @memberOf me.Container#
          * @function
-         * @param {Number} index added or removed child index
+         * @param {number} index added or removed child index
          */
         this.onChildChange = function (/* index */) {
             // to be extended
@@ -118,7 +118,7 @@ class Container extends Renderable {
          * all child bounds when updated (this is expensive and disabled by default,
          * only enable if necessary)
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @default false
          * @name enableChildBoundsUpdate
          * @memberOf me.Container
@@ -187,7 +187,7 @@ class Container extends Renderable {
      * @function
      * @param {me.Renderable} child
      * @param {number} [z] forces the z index of the child to the specified value
-     * @return {me.Renderable} the added child
+     * @returns {me.Renderable} the added child
      */
     addChild(child, z) {
         if (child.ancestor instanceof Container) {
@@ -250,8 +250,8 @@ class Container extends Renderable {
      * @memberOf me.Container.prototype
      * @function
      * @param {me.Renderable} child
-     * @param {Number} index
-     * @return {me.Renderable} the added child
+     * @param {number} index
+     * @returns {me.Renderable} the added child
      */
     addChildAt(child, index) {
         if (index >= 0 && index < this.getChildren().length) {
@@ -309,7 +309,7 @@ class Container extends Renderable {
      * @memberOf me.Container.prototype
      * @function
      * @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 {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) => {
@@ -371,7 +371,8 @@ class Container extends Renderable {
      * @name getChildAt
      * @memberOf me.Container.prototype
      * @function
-     * @param {Number} index
+     * @param {number} index
+     * @returns {me.Renderable} the child at the specified index
      */
     getChildAt(index) {
         if (index >= 0 && index < this.getChildren().length) {
@@ -388,6 +389,7 @@ class Container extends Renderable {
      * @memberOf me.Container.prototype
      * @function
      * @param {me.Renderable} child
+     * @returns {number} index
      */
     getChildIndex(child) {
         return this.getChildren().indexOf(child);
@@ -399,6 +401,7 @@ class Container extends Renderable {
      * @memberOf me.Container
      * @function
      * @param {me.Renderable} child
+     * @returns {me.Renderable} child
      */
     getNextChild(child) {
         var index = this.getChildren().indexOf(child) - 1;
@@ -414,7 +417,7 @@ class Container extends Renderable {
      * @memberOf me.Container.prototype
      * @function
      * @param {me.Renderable} child
-     * @return {Boolean}
+     * @returns {boolean}
      */
     hasChild(child) {
         return this === child.ancestor;
@@ -428,9 +431,9 @@ class Container extends Renderable {
      * @memberOf me.Container.prototype
      * @public
      * @function
-     * @param {String} prop Property name
-     * @param {String|RegExp|Number|Boolean} value Value of the property
-     * @return {me.Renderable[]} Array of childs
+     * @param {string} prop Property name
+     * @param {string|RegExp|number|boolean} value Value of the property
+     * @returns {me.Renderable[]} Array of childs
      * @example
      * // get the first child object called "mainPlayer" in a specific container :
      * var ent = myContainer.getChildByProp("name", "mainPlayer");
@@ -449,6 +452,9 @@ class Container extends Renderable {
     getChildByProp(prop, value)    {
         var objList = [];
 
+        /**
+         * @ignore
+         */
         function compare(obj, prop) {
             var v = obj[prop];
             if (value instanceof RegExp && typeof(v) === "string") {
@@ -477,18 +483,18 @@ class Container extends Renderable {
      * @memberOf me.Container.prototype
      * @public
      * @function
-     * @param {Object} class type
-     * @return {me.Renderable[]} Array of children
+     * @param {object} classType
+     * @returns {me.Renderable[]} Array of children
      */
-    getChildByType(_class) {
+    getChildByType(classType) {
         var objList = [];
 
         this.forEach((child) => {
-            if (child instanceof _class) {
+            if (child instanceof classType) {
                 objList.push(child);
             }
             if (child instanceof Container) {
-                objList = objList.concat(child.getChildByType(_class));
+                objList = objList.concat(child.getChildByType(classType));
             }
         });
 
@@ -504,8 +510,8 @@ class Container extends Renderable {
      * @memberOf me.Container.prototype
      * @public
      * @function
-     * @param {String|RegExp|Number|Boolean} name child name
-     * @return {me.Renderable[]} Array of children
+     * @param {string|RegExp|number|boolean} name child name
+     * @returns {me.Renderable[]} Array of children
      */
     getChildByName(name) {
         return this.getChildByProp("name", name);
@@ -519,23 +525,21 @@ class Container extends Renderable {
      * @memberOf me.Container.prototype
      * @public
      * @function
-     * @param {String|RegExp|Number|Boolean} GUID child GUID
-     * @return {me.Renderable} corresponding child or null
+     * @param {string|RegExp|number|boolean} guid child GUID
+     * @returns {me.Renderable} corresponding child or null
      */
     getChildByGUID(guid) {
         var obj = this.getChildByProp("GUID", guid);
         return (obj.length > 0) ? obj[0] : null;
     }
 
-
     /**
      * return all child in this container
-
      * @name getChildren
      * @memberOf me.Container.prototype
      * @public
      * @function
-     * @return {me.Renderable[]} an array of renderable object
+     * @returns {me.Renderable[]} an array of renderable object
      */
     getChildren() {
         if (typeof this.children === "undefined") {
@@ -550,7 +554,7 @@ class Container extends Renderable {
      * @name updateBounds
      * @memberOf me.Renderable.prototype
      * @function
-     * @return {me.Bounds} this shape bounding box Rectangle object
+     * @returns {me.Bounds} this shape bounding box Rectangle object
      */
     updateBounds(forceUpdateChildBounds = false) {
 
@@ -579,7 +583,7 @@ class Container extends Renderable {
      * @name isAttachedToRoot
      * @memberOf me.Container.prototype
      * @function
-     * @returns Boolean
+     * @returns {boolean}
      */
     isAttachedToRoot() {
         if (this.root === true) {
@@ -598,7 +602,7 @@ class Container extends Renderable {
 
     /**
      * update the cointainer's bounding rect (private)
-     * @private
+     * @ignore
      * @name updateBoundsPos
      * @memberOf me.Container.prototype
      * @function
@@ -639,7 +643,7 @@ class Container extends Renderable {
      * @public
      * @function
      * @param {me.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)) {
@@ -658,7 +662,7 @@ class Container extends Renderable {
      * @memberOf me.Container.prototype
      * @function
      * @param {me.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)) {
@@ -710,16 +714,16 @@ class Container extends Renderable {
      * @name setChildsProperty
      * @memberOf me.Container.prototype
      * @function
-     * @param {String} property 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, val, recursive) {
+    setChildsProperty(prop, value, recursive) {
         this.forEach((child) => {
             if ((recursive === true) && (child instanceof Container)) {
-                child.setChildsProperty(prop, val, recursive);
+                child.setChildsProperty(prop, value, recursive);
             }
-            child[prop] = val;
+            child[prop] = value;
         });
     }
 
@@ -795,7 +799,7 @@ class Container extends Renderable {
      * @memberOf me.Container.prototype
      * @public
      * @function
-     * @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
@@ -884,7 +888,14 @@ class Container extends Renderable {
     }
 
     /**
-     * @ignore
+     * container update function. <br>
+     * automatically called by the game manager {@link me.game}
+     * @name update
+     * @memberOf me.Container.prototype
+     * @function
+     * @protected
+     * @param {number} dt time since the last update in milliseconds.
+     * @returns {boolean} true if the Container is dirty
      */
     update(dt) {
         var isFloating = false;
@@ -930,7 +941,14 @@ class Container extends Renderable {
     }
 
     /**
-     * @ignore
+     * draw the container. <br>
+     * automatically called by the game manager {@link me.game}
+     * @name draw
+     * @memberOf me.Container.prototype
+     * @function
+     * @protected
+     * @param {me.CanvasRenderer|me.WebGLRenderer} renderer a renderer object
+     * @param {me.Rect|me.Bounds} [rect] the area or viewport to (re)draw
      */
     draw(renderer, rect) {
         var isFloating = false;

package/src/renderable/imagelayer.js

@@ -13,16 +13,16 @@ import * as stringUtil from "./../utils/string.js";
  * @extends me.Renderable
  * @memberOf me
  * @constructor
- * @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 me.loader.getImage}
- * @param {String} [settings.name="me.ImageLayer"] layer name
- * @param {Number} [settings.z=0] z-index position
- * @param {Number|me.Vector2d} [settings.ratio=1.0] Scrolling ratio to be applied. See {@link me.ImageLayer#ratio}
- * @param {String} [settings.repeat='repeat'] define if and how an Image Layer should be repeated (accepted values are 'repeat',
+ * @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 me.loader.getImage}
+ * @param {string} [settings.name="me.ImageLayer"] layer name
+ * @param {number} [settings.z=0] z-index position
+ * @param {number|me.Vector2d} [settings.ratio=1.0] Scrolling ratio to be applied. See {@link me.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 me.ImageLayer#repeat}
- * @param {Number|me.Vector2d} [settings.anchorPoint=0.0] Image origin. See {@link me.ImageLayer#anchorPoint}
+ * @param {number|me.Vector2d} [settings.anchorPoint=0.0] Image origin. See {@link me.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, {
@@ -54,7 +54,7 @@ class ImageLayer extends Sprite {
          * - a number, to change the value for both axis <br>
          * - a json expression like `json:{"x":0.5,"y":0.5}` if you wish to specify a different value for both x and y
          * @public
-         * @type me.Vector2d
+         * @type {me.Vector2d}
          * @default <1.0,1.0>
          * @name me.ImageLayer#ratio
          */
@@ -75,14 +75,14 @@ class ImageLayer extends Sprite {
              * By default, its upper-left corner is anchored to the viewport bounds upper left corner.<br>
              * The anchorPoint is a unit vector where each component falls in range [0.0,1.0].<br>
              * Some common examples:<br>
-             * * &lt;0.0,0.0&gt; : (Default) Anchor image to the upper-left corner of viewport bounds
-             * * &lt;0.5,0.5&gt; : Center the image within viewport bounds
-             * * &lt;1.0,1.0&gt; : Anchor image to the lower-right corner of viewport bounds
+             * - &lt;0.0,0.0&gt; : (Default) Anchor image to the upper-left corner of viewport bounds
+             * - &lt;0.5,0.5&gt; : Center the image within viewport bounds
+             * - &lt;1.0,1.0&gt; : Anchor image to the lower-right corner of viewport bounds
              * To specify a value through Tiled, use one of the following format : <br>
              * - a number, to change the value for both axis <br>
              * - a json expression like `json:{"x":0.5,"y":0.5}` if you wish to specify a different value for both x and y
              * @public
-             * @type me.Vector2d
+             * @type {me.Vector2d}
              * @default <0.0,0.0>
              * @name me.ImageLayer#anchorPoint
              */
@@ -107,26 +107,20 @@ class ImageLayer extends Sprite {
      * Define if and how an Image Layer should be repeated.<br>
      * By default, an Image Layer is repeated both vertically and horizontally.<br>
      * Acceptable values : <br>
-     * * 'repeat' - The background image will be repeated both vertically and horizontally <br>
-     * * 'repeat-x' - The background image will be repeated only horizontally.<br>
-     * * 'repeat-y' - The background image will be repeated only vertically.<br>
-     * * 'no-repeat' - The background-image will not be repeated.<br>
+     * - 'repeat' - The background image will be repeated both vertically and horizontally <br>
+     * - 'repeat-x' - The background image will be repeated only horizontally.<br>
+     * - 'repeat-y' - The background image will be repeated only vertically.<br>
+     * - 'no-repeat' - The background-image will not be repeated.<br>
      * @public
-     * @type String
+     * @type {string}
      * @default 'repeat'
      * @name me.ImageLayer#repeat
      */
 
-    /**
-     * @ignore
-     */
     get repeat() {
         return this._repeat;
     }
 
-    /**
-     * @ignore
-     */
     set repeat(value) {
         this._repeat = value;
         switch (this._repeat) {
@@ -174,9 +168,9 @@ class ImageLayer extends Sprite {
      * @name resize
      * @memberOf me.ImageLayer.prototype
      * @function
-     * @param {Number} w new width
-     * @param {Number} h new height
-    */
+     * @param {number} w new width
+     * @param {number} h new height
+     */
     resize(w, h) {
         super.resize(
             this.repeatX ? Infinity : w,
@@ -243,7 +237,7 @@ class ImageLayer extends Sprite {
         this.isDirty = true;
     }
 
-   /*
+   /**
     * override the default predraw function
     * as repeat and anchor are managed directly in the draw method
     * @ignore
@@ -259,8 +253,13 @@ class ImageLayer extends Sprite {
     }
 
     /**
-     * draw the image layer
-     * @ignore
+     * draw the ImageLayer. <br>
+     * automatically called by the game manager {@link me.game}
+     * @name draw
+     * @memberOf me.ImageLayer.prototype
+     * @function
+     * @protected
+     * @param {me.CanvasRenderer|me.WebGLRenderer} renderer a renderer object
      */
     draw(renderer) {
         var width = this.width,