melonjs 10.9.0 → 10.10.0

package/src/renderable/container.js

@@ -18,7 +18,7 @@ var globalFloatingCounter = 0;
 
 /**
  * @classdesc
- * me.Container represents a collection of child objects
+ * Container represents a collection of child objects
  * @augments Renderable
  */
 class Container extends Renderable {
@@ -192,7 +192,7 @@ class Container extends Renderable {
      * orginal container.  Then when the me.game.world.reset() is called the renderable
      * will not be in any container.
      * @name addChild
-     * @memberof Container.prototype
+     * @memberof Container
      * @function
      * @param {Renderable} child
      * @param {number} [z] forces the z index of the child to the specified value
@@ -256,7 +256,7 @@ class Container extends Renderable {
      * Add a child to the container at the specified index<br>
      * (the list won't be sorted after insertion)
      * @name addChildAt
-     * @memberof Container.prototype
+     * @memberof Container
      * @function
      * @param {Renderable} child
      * @param {number} index
@@ -315,7 +315,7 @@ class Container extends Renderable {
      *    - The index of element in the array. <br>
      *    - The array forEach() was called upon. <br>
      * @name forEach
-     * @memberof Container.prototype
+     * @memberof Container
      * @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.
@@ -352,7 +352,7 @@ class Container extends Renderable {
     /**
      * Swaps the position (z-index) of 2 children
      * @name swapChildren
-     * @memberof Container.prototype
+     * @memberof Container
      * @function
      * @param {Renderable} child
      * @param {Renderable} child2
@@ -380,7 +380,7 @@ class Container extends Renderable {
     /**
      * Returns the Child at the specified index
      * @name getChildAt
-     * @memberof Container.prototype
+     * @memberof Container
      * @function
      * @param {number} index
      * @returns {Renderable} the child at the specified index
@@ -397,7 +397,7 @@ class Container extends Renderable {
     /**
      * Returns the index of the given Child
      * @name getChildIndex
-     * @memberof Container.prototype
+     * @memberof Container
      * @function
      * @param {Renderable} child
      * @returns {number} index
@@ -425,7 +425,7 @@ class Container extends Renderable {
     /**
      * Returns true if contains the specified Child
      * @name hasChild
-     * @memberof Container.prototype
+     * @memberof Container
      * @function
      * @param {Renderable} child
      * @returns {boolean}
@@ -439,7 +439,7 @@ class Container extends Renderable {
      * note : avoid calling this function every frame since
      * it parses the whole object tree each time
      * @name getChildByProp
-     * @memberof Container.prototype
+     * @memberof Container
      * @public
      * @function
      * @param {string} prop Property name
@@ -491,7 +491,7 @@ class Container extends Renderable {
     /**
      * returns the list of childs with the specified class type
      * @name getChildByType
-     * @memberof Container.prototype
+     * @memberof Container
      * @public
      * @function
      * @param {object} classType
@@ -518,7 +518,7 @@ class Container extends Renderable {
      * note : avoid calling this function every frame since
      * it parses the whole object list each time
      * @name getChildByName
-     * @memberof Container.prototype
+     * @memberof Container
      * @public
      * @function
      * @param {string|RegExp|number|boolean} name child name
@@ -533,7 +533,7 @@ class Container extends Renderable {
      * note : avoid calling this function every frame since
      * it parses the whole object list each time
      * @name getChildByGUID
-     * @memberof Container.prototype
+     * @memberof Container
      * @public
      * @function
      * @param {string|RegExp|number|boolean} guid child GUID
@@ -547,7 +547,7 @@ class Container extends Renderable {
     /**
      * return all child in this container
      * @name getChildren
-     * @memberof Container.prototype
+     * @memberof Container
      * @public
      * @function
      * @returns {Renderable[]} an array of renderable object
@@ -563,7 +563,7 @@ class Container extends Renderable {
      * update the bounding box for this shape.
      * @ignore
      * @name updateBounds
-     * @memberof Renderable.prototype
+     * @memberof Renderable
      * @function
      * @returns {Bounds} this shape bounding box Rectangle object
      */
@@ -592,7 +592,7 @@ class Container extends Renderable {
      * Checks if this container is root or if it's attached to the root container.
      * @private
      * @name isAttachedToRoot
-     * @memberof Container.prototype
+     * @memberof Container
      * @function
      * @returns {boolean}
      */
@@ -615,7 +615,7 @@ class Container extends Renderable {
      * update the cointainer's bounding rect (private)
      * @ignore
      * @name updateBoundsPos
-     * @memberof Container.prototype
+     * @memberof Container
      * @function
      */
     updateBoundsPos(newX, newY) {
@@ -650,7 +650,7 @@ class Container extends Renderable {
     /**
      * Invokes the removeChildNow in a defer, to ensure the child is removed safely after the update & draw stack has completed
      * @name removeChild
-     * @memberof Container.prototype
+     * @memberof Container
      * @public
      * @function
      * @param {Renderable} child
@@ -670,7 +670,7 @@ class Container extends Renderable {
      * (removal is immediate and unconditional)<br>
      * Never use keepalive=true with objects from {@link pool}. Doing so will create a memory leak.
      * @name removeChildNow
-     * @memberof Container.prototype
+     * @memberof Container
      * @function
      * @param {Renderable} child
      * @param {boolean} [keepalive=False] True to prevent calling child.destroy()
@@ -723,7 +723,7 @@ class Container extends Renderable {
     /**
      * Automatically set the specified property of all childs to the given value
      * @name setChildsProperty
-     * @memberof Container.prototype
+     * @memberof Container
      * @function
      * @param {string} prop property name
      * @param {object} value property value
@@ -741,7 +741,7 @@ class Container extends Renderable {
     /**
      * Move the child in the group one step forward (z depth).
      * @name moveUp
-     * @memberof Container.prototype
+     * @memberof Container
      * @function
      * @param {Renderable} child
      */
@@ -758,7 +758,7 @@ class Container extends Renderable {
     /**
      * Move the child in the group one step backward (z depth).
      * @name moveDown
-     * @memberof Container.prototype
+     * @memberof Container
      * @function
      * @param {Renderable} child
      */
@@ -775,7 +775,7 @@ class Container extends Renderable {
     /**
      * Move the specified child to the top(z depth).
      * @name moveToTop
-     * @memberof Container.prototype
+     * @memberof Container
      * @function
      * @param {Renderable} child
      */
@@ -795,7 +795,7 @@ class Container extends Renderable {
     /**
      * Move the specified child the bottom (z depth).
      * @name moveToBottom
-     * @memberof Container.prototype
+     * @memberof Container
      * @function
      * @param {Renderable} child
      */
@@ -815,7 +815,7 @@ class Container extends Renderable {
     /**
      * Manually trigger the sort of all the childs in the container</p>
      * @name sort
-     * @memberof Container.prototype
+     * @memberof Container
      * @public
      * @function
      * @param {boolean} [recursive=false] recursively sort all containers if true
@@ -910,7 +910,7 @@ class Container extends Renderable {
      * container update function. <br>
      * automatically called by the game manager {@link game}
      * @name update
-     * @memberof Container.prototype
+     * @memberof Container
      * @function
      * @protected
      * @param {number} dt time since the last update in milliseconds.
@@ -963,7 +963,7 @@ class Container extends Renderable {
      * draw the container. <br>
      * automatically called by the game manager {@link game}
      * @name draw
-     * @memberof Container.prototype
+     * @memberof Container
      * @function
      * @protected
      * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object

package/src/renderable/imagelayer.js

@@ -159,7 +159,7 @@ class ImageLayer extends Sprite {
     /**
      * resize the Image Layer to match the given size
      * @name resize
-     * @memberof ImageLayer.prototype
+     * @memberof ImageLayer
      * @function
      * @param {number} w new width
      * @param {number} h new height
@@ -249,7 +249,7 @@ class ImageLayer extends Sprite {
      * draw the ImageLayer. <br>
      * automatically called by the game manager {@link game}
      * @name draw
-     * @memberof ImageLayer.prototype
+     * @memberof ImageLayer
      * @function
      * @protected
      * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object

package/src/renderable/light2d.js

@@ -0,0 +1,115 @@
+import pool from "./../system/pooling.js";
+import Renderable from "./renderable.js";
+
+/** @ignore */
+function createGradient(light) {
+    var context = light.texture.context;
+    var x1 = light.texture.width / 2;
+    var y1 = light.texture.height / 2;
+    var gradient = context.createRadialGradient(x1, y1, 0, x1, y1, light.radius);
+
+    light.texture.clear();
+
+    gradient.addColorStop( 0, light.color.toRGBA(light.intensity));
+    gradient.addColorStop( 1, light.color.toRGBA(0.0));
+
+    context.beginPath();
+    context.fillStyle = gradient;
+    context.arc(x1, y1, light.radius, 0, Math.PI * 2, false);
+    context.fill();
+}
+
+/**
+ * @classdesc
+ * A 2D point light.
+ * Note: this is a very experimental and work in progress feature, that provides a simple spot light effect.
+ * The light effect is best rendered in WebGL, as they are few limitations when using the Canvas Renderer
+ * (multiple lights are not supported, alpha component of the ambient light is ignored)
+ * @see stage.lights
+ */
+class Light2d extends Renderable {
+   /**
+    * @param {number} x - The horizontal position of the light.
+    * @param {number} y - The vertical position of the light.
+    * @param {number} radius - The radius 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, radius, color = "#FFF", intensity = 0.7) {
+        // call the parent constructor
+        super(x, y, radius * 2, radius * 2);
+
+        /**
+         * the color of the light
+         * @type {Color}
+         * @default "#FFF"
+         */
+        this.color = pool.pull("Color").parseCSS(color);
+
+        /**
+         * The radius of the light
+         * @type {number}
+         */
+        this.radius = radius;
+
+        /**
+         * The intensity of the light
+         * @type {number}
+         * @default 0.7
+         */
+        this.intensity = intensity;
+
+        /**
+         * the default blend mode to be applied when rendering this light
+         * @type {string}
+         * @default "lighter"
+         * @see CanvasRenderer#setBlendMode
+         * @see WebGLRenderer#setBlendMode
+         */
+        this.blendMode = "lighter";
+
+        /** @ignore */
+        this.visibleArea = pool.pull("Ellipse", this.centerX, this.centerY, this.width, this.height);
+
+        /** @ignore */
+        this.texture = pool.pull("CanvasTexture", this.width, this.height, false);
+
+        this.anchorPoint.set(0, 0);
+
+        createGradient(this);
+    }
+
+    /**
+     * returns a geometry representing the visible area of this light
+     * @name getVisibleArea
+     * @memberof Light2d
+     * @function
+     * @returns {Ellipse} the light visible mask
+     */
+    getVisibleArea() {
+        return this.visibleArea.setShape(this.getBounds().centerX, this.getBounds().centerY, this.width, this.height);
+    }
+
+    /**
+     * object draw (Called internally by the engine).
+     * @ignore
+     */
+    draw(renderer) {
+        renderer.drawImage(this.texture.canvas, this.getBounds().x, this.getBounds().y);
+    }
+
+    /**
+     * Destroy function<br>
+     * @ignore
+     */
+    destroy() {
+        pool.push(this.color);
+        this.color = undefined;
+        pool.push(this.texture);
+        this.texture = undefined;
+        pool.push(this.visibleArea);
+        this.visibleArea = undefined;
+        super.destroy();
+    }
+};
+export default Light2d;

package/src/renderable/renderable.js

@@ -380,7 +380,7 @@ class Renderable extends Rect {
     /**
      * returns the bounding box for this renderable
      * @name getBounds
-     * @memberof Renderable.prototype
+     * @memberof Renderable
      * @function
      * @returns {Bounds} bounding box Rectangle object
      */
@@ -401,7 +401,7 @@ class Renderable extends Rect {
     /**
      * get the renderable alpha channel value<br>
      * @name getOpacity
-     * @memberof Renderable.prototype
+     * @memberof Renderable
      * @function
      * @returns {number} current opacity value between 0 and 1
      */
@@ -412,7 +412,7 @@ class Renderable extends Rect {
     /**
      * set the renderable alpha channel value<br>
      * @name setOpacity
-     * @memberof Renderable.prototype
+     * @memberof Renderable
      * @function
      * @param {number} alpha opacity value between 0.0 and 1.0
      */
@@ -431,7 +431,7 @@ class Renderable extends Rect {
      * flip the renderable on the horizontal axis (around the center of the renderable)
      * @see Matrix2d#scaleX
      * @name flipX
-     * @memberof Renderable.prototype
+     * @memberof Renderable
      * @function
      * @param {boolean} [flip=true] `true` to flip this renderable.
      * @returns {Renderable} Reference to this object for method chaining
@@ -446,7 +446,7 @@ class Renderable extends Rect {
      * flip the renderable on the vertical axis (around the center of the renderable)
      * @see Matrix2d#scaleY
      * @name flipY
-     * @memberof Renderable.prototype
+     * @memberof Renderable
      * @function
      * @param {boolean} [flip=true] `true` to flip this renderable.
      * @returns {Renderable} Reference to this object for method chaining
@@ -460,7 +460,7 @@ class Renderable extends Rect {
     /**
      * multiply the renderable currentTransform with the given matrix
      * @name transform
-     * @memberof Renderable.prototype
+     * @memberof Renderable
      * @see Renderable#currentTransform
      * @function
      * @param {Matrix2d} m the transformation matrix
@@ -525,7 +525,7 @@ class Renderable extends Rect {
     /**
      * Rotate this renderable towards the given target.
      * @name lookAt
-     * @memberof Renderable.prototype
+     * @memberof Renderable
      * @function
      * @param {Renderable|Vector2d|Vector3d} target the renderable or position to look at
      * @returns {Renderable} Reference to this object for method chaining
@@ -549,7 +549,7 @@ class Renderable extends Rect {
     /**
      * Rotate this renderable by the specified angle (in radians).
      * @name rotate
-     * @memberof Renderable.prototype
+     * @memberof Renderable
      * @function
      * @param {number} angle The angle to rotate (in radians)
      * @param {Vector2d|ObservableVector2d} [v] an optional point to rotate around
@@ -571,7 +571,7 @@ class Renderable extends Rect {
      * is an image, the image.width and image.height properties are unaltered but the currentTransform
      * member will be changed.
      * @name scale
-     * @memberof Renderable.prototype
+     * @memberof Renderable
      * @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.
@@ -587,7 +587,7 @@ class Renderable extends Rect {
     /**
      * scale the renderable around his anchor point
      * @name scaleV
-     * @memberof Renderable.prototype
+     * @memberof Renderable
      * @function
      * @param {Vector2d} v scaling vector
      * @returns {Renderable} Reference to this object for method chaining
@@ -601,7 +601,7 @@ class Renderable extends Rect {
      * update function. <br>
      * automatically called by the game manager {@link game}
      * @name update
-     * @memberof Renderable.prototype
+     * @memberof Renderable
      * @function
      * @protected
      * @param {number} dt time since the last update in milliseconds.
@@ -615,7 +615,7 @@ class Renderable extends Rect {
      * update the bounding box for this shape.
      * @ignore
      * @name updateBounds
-     * @memberof Renderable.prototype
+     * @memberof Renderable
      * @function
      * @returns {Bounds} this shape bounding box Rectangle object
      */
@@ -629,7 +629,7 @@ class Renderable extends Rect {
      * update the renderable's bounding rect (private)
      * @ignore
      * @name updateBoundsPos
-     * @memberof Renderable.prototype
+     * @memberof Renderable
      * @function
      */
      updateBoundsPos(newX, newY) {
@@ -655,13 +655,14 @@ class Renderable extends Rect {
          if (this.ancestor instanceof Container && this.floating !== true) {
              bounds.translate(this.ancestor.getAbsolutePosition());
          }
-         //return bounds;
+
+         this.isDirty = true;
      }
 
      /**
       * return the renderable absolute position in the game world
       * @name getAbsolutePosition
-      * @memberof Renderable.prototype
+      * @memberof Renderable
       * @function
       * @returns {Vector2d}
       */
@@ -681,7 +682,7 @@ class Renderable extends Rect {
      * called when the anchor point value is changed
      * @private
      * @name onAnchorUpdate
-     * @memberof Renderable.prototype
+     * @memberof Renderable
      * @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
@@ -699,7 +700,7 @@ class Renderable extends Rect {
      * (apply defined transforms, anchor point). <br>
      * automatically called by the game manager {@link game}
      * @name preDraw
-     * @memberof Renderable.prototype
+     * @memberof Renderable
      * @function
      * @protected
      * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
@@ -755,7 +756,7 @@ class Renderable extends Rect {
      * object draw. <br>
      * automatically called by the game manager {@link game}
      * @name draw
-     * @memberof Renderable.prototype
+     * @memberof Renderable
      * @function
      * @protected
      * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
@@ -768,7 +769,7 @@ class Renderable extends Rect {
      * restore the rendering context after drawing. <br>
      * automatically called by the game manager {@link game}
      * @name postDraw
-     * @memberof Renderable.prototype
+     * @memberof Renderable
      * @function
      * @protected
      * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
@@ -793,7 +794,7 @@ class Renderable extends Rect {
      * onCollision callback, triggered in case of collision,
      * when this renderable body is colliding with another one
      * @name onCollision
-     * @memberof Renderable.prototype
+     * @memberof Renderable
      * @function
      * @param {collision.ResponseObject} response the collision response object
      * @param {Renderable} other the other renderable touching this one (a reference to response.a or response.b)

package/src/renderable/sprite.js

@@ -1,7 +1,7 @@
 import { renderer } from "./../video/video.js";
 import pool from "./../system/pooling.js";
 import loader from "./../loader/loader.js";
-import { TextureAtlas } from "./../video/texture.js";
+import { TextureAtlas } from "./../video/texture/atlas.js";
 import Renderable from "./renderable.js";
 
 /**
@@ -209,7 +209,7 @@ class Sprite extends Renderable {
     /**
      * return the flickering state of the object
      * @name isFlickering
-     * @memberof Sprite.prototype
+     * @memberof Sprite
      * @function
      * @returns {boolean}
      */
@@ -220,7 +220,7 @@ class Sprite extends Renderable {
     /**
      * make the object flicker
      * @name flicker
-     * @memberof Sprite.prototype
+     * @memberof Sprite
      * @function
      * @param {number} duration expressed in milliseconds
      * @param {Function} callback Function to call when flickering ends
@@ -251,7 +251,7 @@ class Sprite extends Renderable {
      * logic as per the following example :<br>
      * <img src="images/spritesheet_grid.png"/>
      * @name addAnimation
-     * @memberof Sprite.prototype
+     * @memberof Sprite
      * @function
      * @param {string} name animation id
      * @param {number[]|string[]|object[]} index list of sprite index or name
@@ -351,7 +351,7 @@ class Sprite extends Renderable {
      * set the current animation
      * this will always change the animation & set the frame to zero
      * @name setCurrentAnimation
-     * @memberof Sprite.prototype
+     * @memberof Sprite
      * @function
      * @param {string} name animation id
      * @param {string|Function} [resetAnim] animation id to switch to when complete, or callback
@@ -412,7 +412,7 @@ class Sprite extends Renderable {
     /**
      * reverse the given or current animation if none is specified
      * @name reverseAnimation
-     * @memberof Sprite.prototype
+     * @memberof Sprite
      * @function
      * @param {string} [name] animation id
      * @returns {Sprite} Reference to this object for method chaining
@@ -431,7 +431,7 @@ class Sprite extends Renderable {
     /**
      * return true if the specified animation is the current one.
      * @name isCurrentAnimation
-     * @memberof Sprite.prototype
+     * @memberof Sprite
      * @function
      * @param {string} name animation id
      * @returns {boolean}
@@ -448,7 +448,7 @@ class Sprite extends Renderable {
      * change the current texture atlas region for this sprite
      * @see Texture.getRegion
      * @name setRegion
-     * @memberof Sprite.prototype
+     * @memberof Sprite
      * @function
      * @param {object} region typically returned through me.Texture.getRegion()
      * @returns {Sprite} Reference to this object for method chaining
@@ -480,7 +480,7 @@ class Sprite extends Renderable {
     /**
      * force the current animation frame index.
      * @name setAnimationFrame
-     * @memberof Sprite.prototype
+     * @memberof Sprite
      * @function
      * @param {number} [idx=0] animation frame index
      * @returns {Sprite} Reference to this object for method chaining
@@ -496,7 +496,7 @@ class Sprite extends Renderable {
     /**
      * return the current animation frame index.
      * @name getCurrentAnimationFrame
-     * @memberof Sprite.prototype
+     * @memberof Sprite
      * @function
      * @returns {number} current animation frame index
      */
@@ -507,7 +507,7 @@ class Sprite extends Renderable {
     /**
      * Returns the frame object by the index.
      * @name getAnimationFrameObjectByIndex
-     * @memberof Sprite.prototype
+     * @memberof Sprite
      * @function
      * @ignore
      * @param {number} id the frame id
@@ -521,7 +521,7 @@ class Sprite extends Renderable {
      * update function. <br>
      * automatically called by the game manager {@link game}
      * @name update
-     * @memberof Sprite.prototype
+     * @memberof Sprite
      * @function
      * @protected
      * @param {number} dt time since the last update in milliseconds.
@@ -600,7 +600,7 @@ class Sprite extends Renderable {
      * sprite draw. <br>
      * automatically called by the game manager {@link game}
      * @name draw
-     * @memberof Sprite.prototype
+     * @memberof Sprite
      * @function
      * @protected
      * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object