melonjs 10.1.1 → 10.2.3

package/src/renderable/renderable.js

@@ -13,10 +13,10 @@ import { clamp } from "./../math/math.js";
  * @extends me.Rect
  * @memberOf me
  * @constructor
- * @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
  */
 class Renderable extends Rect {
 
@@ -37,7 +37,7 @@ class Renderable extends Rect {
         /**
          * If true then physic collision and input events will not impact this renderable
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @default true
          * @name isKinematic
          * @memberOf me.Renderable
@@ -49,7 +49,6 @@ class Renderable extends Rect {
          * @public
          * @type {me.Body}
          * @see me.Body
-         * @see me.collision#check
          * @name body
          * @memberOf me.Renderable#
          * @example
@@ -89,7 +88,7 @@ class Renderable extends Rect {
         /**
          * the renderable default transformation matrix
          * @public
-         * @type me.Matrix2d
+         * @type {me.Matrix2d}
          * @name currentTransform
          * @memberOf me.Renderable#
          */
@@ -103,7 +102,7 @@ class Renderable extends Rect {
         * a GUID will be allocated for any renderable object added <br>
         * to an object container (including the `me.game.world` container)
         * @public
-        * @type String
+        * @type {string}
         * @name GUID
         * @memberOf me.Renderable
         */
@@ -112,7 +111,7 @@ class Renderable extends Rect {
         /**
          * an event handler that is called when the renderable leave or enter a camera viewport
          * @public
-         * @type function
+         * @type {Function}
          * @default undefined
          * @name onVisibilityChange
          * @memberOf me.Renderable#
@@ -128,7 +127,7 @@ class Renderable extends Rect {
         /**
          * Whether the renderable object will always update, even when outside of the viewport<br>
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @default false
          * @name alwaysUpdate
          * @memberOf me.Renderable
@@ -138,7 +137,7 @@ class Renderable extends Rect {
         /**
          * Whether to update this object when the game is paused.
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @default false
          * @name updateWhenPaused
          * @memberOf me.Renderable
@@ -148,7 +147,7 @@ class Renderable extends Rect {
         /**
          * make the renderable object persistent over level changes<br>
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @default false
          * @name isPersistent
          * @memberOf me.Renderable
@@ -159,7 +158,7 @@ class Renderable extends Rect {
          * If true, this renderable will be rendered using screen coordinates,
          * as opposed to world coordinates. Use this, for example, to define UI elements.
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @default false
          * @name floating
          * @memberOf me.Renderable
@@ -175,7 +174,7 @@ class Renderable extends Rect {
          * <i><b>Note:</b> Object created through Tiled will have their anchorPoint set to (0, 0) to match Tiled Level editor implementation.
          * To specify a value through Tiled, use a json expression like `json:{"x":0.5,"y":0.5}`. </i>
          * @public
-         * @type me.ObservableVector2d
+         * @type {me.ObservableVector2d}
          * @default <0.5,0.5>
          * @name anchorPoint
          * @memberOf me.Renderable#
@@ -190,7 +189,7 @@ class Renderable extends Rect {
          * When enabled, an object container will automatically apply
          * any defined transformation before calling the child draw method.
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @default true
          * @name autoTransform
          * @memberOf me.Renderable
@@ -214,7 +213,7 @@ class Renderable extends Rect {
          * @see me.Renderable#setOpacity
          * @see me.Renderable#getOpacity
          * @public
-         * @type Number
+         * @type {number}
          * @default 1.0
          * @name me.Renderable#alpha
          */
@@ -223,7 +222,7 @@ class Renderable extends Rect {
         /**
          * a reference to the parent object that contains this renderable
          * @public
-         * @type me.Container|me.Entity
+         * @type {me.Container|me.Entity}
          * @default undefined
          * @name me.Renderable#ancestor
          */
@@ -273,7 +272,7 @@ class Renderable extends Rect {
         /**
          * The name of the renderable
          * @public
-         * @type {String}
+         * @type {string}
          * @name name
          * @default ""
          * @memberOf me.Renderable
@@ -295,7 +294,7 @@ class Renderable extends Rect {
 
         /**
          * when true the renderable will be redrawn during the next update cycle
-         * @type {Boolean}
+         * @type {boolean}
          * @name isDirty
          * @default false
          * @memberOf me.Renderable#
@@ -315,26 +314,33 @@ class Renderable extends Rect {
         this.setOpacity(1.0);
     }
 
+    /**
+     * Whether the renderable object is floating, or contained in a floating container
+     * @public
+     * @see me.Renderable#floating
+     * @readonly
+     * @type {boolean}
+     * @name isFloating
+     * @memberOf me.Renderable
+     */
+    get isFloating() {
+        return this.floating === true || (typeof this.ancestor !== "undefined" && this.ancestor.floating === true);
+    }
+
     /**
      * Whether the renderable object is visible and within the viewport
      * @public
      * @readonly
-     * @type Boolean
+     * @type {boolean}
      * @default false
      * @name inViewport
      * @memberOf me.Renderable
      */
 
-    /**
-     * @ignore
-     */
     get inViewport() {
         return this._inViewport;
     }
 
-    /**
-     * @ignore
-     */
     set inViewport(value) {
         if (this._inViewport !== value) {
             this._inViewport = value;
@@ -348,14 +354,11 @@ class Renderable extends Rect {
      * returns true if this renderable is flipped on the horizontal axis
      * @public
      * @see me.Renderable#flipX
-     * @type {Boolean}
+     * @type {boolean}
      * @name isFlippedX
      * @memberOf me.Renderable
      */
 
-    /**
-     * @ignore
-     */
     get isFlippedX() {
         return this._flip.x === true;
     }
@@ -364,14 +367,11 @@ class Renderable extends Rect {
      * returns true if this renderable is flipped on the vertical axis
      * @public
      * @see me.Renderable#flipY
-     * @type {Boolean}
+     * @type {boolean}
      * @name isFlippedY
      * @memberOf me.Renderable
      */
 
-    /**
-     * @ignore
-     */
     get isFlippedY() {
         return this._flip.y === true;
     }
@@ -381,7 +381,7 @@ class Renderable extends Rect {
      * @name getBounds
      * @memberOf me.Renderable.prototype
      * @function
-     * @return {me.Bounds} bounding box Rectangle object
+     * @returns {me.Bounds} bounding box Rectangle object
      */
     getBounds() {
         if (typeof this._bounds === "undefined") {
@@ -402,7 +402,7 @@ class Renderable extends Rect {
      * @name getOpacity
      * @memberOf me.Renderable.prototype
      * @function
-     * @return {Number} current opacity value between 0 and 1
+     * @returns {number} current opacity value between 0 and 1
      */
     getOpacity() {
         return this.alpha;
@@ -413,7 +413,7 @@ class Renderable extends Rect {
      * @name setOpacity
      * @memberOf me.Renderable.prototype
      * @function
-     * @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") {
@@ -432,8 +432,8 @@ class Renderable extends Rect {
      * @name flipX
      * @memberOf me.Renderable.prototype
      * @function
-     * @param {Boolean} [flip=true] `true` to flip this renderable.
-     * @return {me.Renderable} Reference to this object for method chaining
+     * @param {boolean} [flip=true] `true` to flip this renderable.
+     * @returns {me.Renderable} Reference to this object for method chaining
      */
     flipX(flip = true) {
         this._flip.x = !!flip;
@@ -447,8 +447,8 @@ class Renderable extends Rect {
      * @name flipY
      * @memberOf me.Renderable.prototype
      * @function
-     * @param {Boolean} [flip=true] `true` to flip this renderable.
-     * @return {me.Renderable} Reference to this object for method chaining
+     * @param {boolean} [flip=true] `true` to flip this renderable.
+     * @returns {me.Renderable} Reference to this object for method chaining
      */
     flipY(flip = true) {
         this._flip.y = !!flip;
@@ -462,8 +462,8 @@ class Renderable extends Rect {
      * @memberOf me.Renderable.prototype
      * @see me.Renderable#currentTransform
      * @function
-     * @param {me.Matrix2d} matrix the transformation matrix
-     * @return {me.Renderable} Reference to this object for method chaining
+     * @param {me.Matrix2d} m the transformation matrix
+     * @returns {me.Renderable} Reference to this object for method chaining
      */
     transform(m) {
         this.currentTransform.multiply(m);
@@ -479,7 +479,7 @@ class Renderable extends Rect {
      * @memberOf me.Renderable
      * @function
      * @param {me.Renderable|me.Vector2d|me.Vector3d} target
-     * @return {Number} angle in radians
+     * @returns {number} angle in radians
      */
     angleTo(target) {
         var a = this.getBounds();
@@ -503,7 +503,7 @@ class Renderable extends Rect {
      * @memberOf me.Renderable
      * @function
      * @param {me.Renderable|me.Vector2d|me.Vector3d} target
-     * @return {Number} distance
+     * @returns {number} distance
      */
     distanceTo(target) {
         var a = this.getBounds();
@@ -527,7 +527,7 @@ class Renderable extends Rect {
      * @memberOf me.Renderable.prototype
      * @function
      * @param {me.Renderable|me.Vector2d|me.Vector3d} target the renderable or position to look at
-     * @return {me.Renderable} Reference to this object for method chaining
+     * @returns {me.Renderable} Reference to this object for method chaining
      */
     lookAt(target) {
         var position;
@@ -550,13 +550,13 @@ class Renderable extends Rect {
      * @name rotate
      * @memberOf me.Renderable.prototype
      * @function
-     * @param {Number} angle The angle to rotate (in radians)
+     * @param {number} angle The angle to rotate (in radians)
      * @param {me.Vector2d|me.ObservableVector2d} [v] an optional point to rotate around
-     * @return {me.Renderable} Reference to this object for method chaining
+     * @returns {me.Renderable} Reference to this object for method chaining
      */
-    rotate(angle) {
+    rotate(angle, v) {
         if (!isNaN(angle)) {
-            this.currentTransform.rotate(angle);
+            this.currentTransform.rotate(angle, v);
             //this.updateBoundsPos(this.pos.x, this.pos.y);
             this.isDirty = true;
         }
@@ -572,9 +572,9 @@ class Renderable extends Rect {
      * @name scale
      * @memberOf me.Renderable.prototype
      * @function
-     * @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.
-     * @return {me.Renderable} Reference to this object for method chaining
+     * @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 {me.Renderable} Reference to this object for method chaining
      */
     scale(x, y) {
         this.currentTransform.scale(x, y);
@@ -588,8 +588,8 @@ class Renderable extends Rect {
      * @name scaleV
      * @memberOf me.Renderable.prototype
      * @function
-     * @param {me.Vector2d} vector scaling vector
-     * @return {me.Renderable} Reference to this object for method chaining
+     * @param {me.Vector2d} v scaling vector
+     * @returns {me.Renderable} Reference to this object for method chaining
      */
     scaleV(v) {
         this.scale(v.x, v.y);
@@ -603,9 +603,9 @@ class Renderable extends Rect {
      * @memberOf me.Renderable.prototype
      * @function
      * @protected
-     * @param {Number} dt time since the last update in milliseconds.
-     * @return false
-     **/
+     * @param {number} dt time since the last update in milliseconds.
+     * @returns {boolean} true if the renderable is dirty
+     */
     update(/* dt */) {
         return this.isDirty;
     }
@@ -616,7 +616,7 @@ class Renderable extends Rect {
      * @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() {
         super.updateBounds();
@@ -662,7 +662,7 @@ class Renderable extends Rect {
       * @name getAbsolutePosition
       * @memberOf me.Renderable.prototype
       * @function
-      * @return {me.Vector2d}
+      * @returns {me.Vector2d}
       */
       getAbsolutePosition() {
           if (typeof this._absPos === "undefined") {
@@ -682,16 +682,17 @@ class Renderable extends Rect {
      * @name onAnchorUpdate
      * @memberOf me.Renderable.prototype
      * @function
+     * @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(newX, newY) {
+     onAnchorUpdate(x, y) {
          // since the callback is called before setting the new value
          // manually update the anchor point (required for updateBoundsPos)
-         this.anchorPoint.setMuted(newX, newY);
+         this.anchorPoint.setMuted(x, y);
          // then call updateBounds
          this.updateBoundsPos(this.pos.x, this.pos.y);
      }
 
-
     /**
      * prepare the rendering context before drawing
      * (apply defined transforms, anchor point). <br>
@@ -701,7 +702,7 @@ class Renderable extends Rect {
      * @function
      * @protected
      * @param {me.CanvasRenderer|me.WebGLRenderer} renderer a renderer object
-     **/
+     */
     preDraw(renderer) {
         var bounds = this.getBounds();
         var ax = bounds.width * this.anchorPoint.x,
@@ -752,7 +753,7 @@ class Renderable extends Rect {
      * @function
      * @protected
      * @param {me.CanvasRenderer|me.WebGLRenderer} renderer a renderer object
-     **/
+     */
     draw(/*renderer*/) {
         // empty one !
     }
@@ -765,7 +766,7 @@ class Renderable extends Rect {
      * @function
      * @protected
      * @param {me.CanvasRenderer|me.WebGLRenderer} renderer a renderer object
-     **/
+     */
     postDraw(renderer) {
 
         // remove the previously applied tint
@@ -791,7 +792,7 @@ class Renderable extends Rect {
      * @function
      * @param {me.collision.ResponseObject} response the collision response object
      * @param {me.Renderable} other the other renderable touching this one (a reference to response.a or response.b)
-     * @return {Boolean} true if the object should respond to the collision (its position and velocity will be corrected)
+     * @returns {boolean} true if the object should respond to the collision (its position and velocity will be corrected)
      * @example
      * // colision handler
      * onCollision(response) {

package/src/renderable/sprite.js

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