melonjs 10.10.0 → 10.11.0

package/src/renderable/GUI.js

@@ -118,7 +118,6 @@ class GUI_Object extends Sprite {
      * @name onClick
      * @memberof GUI_Object
      * @public
-     * @function
      * @param {Pointer} event the event object
      * @returns {boolean} return false if we need to stop propagating the event
      */
@@ -141,7 +140,6 @@ class GUI_Object extends Sprite {
      * @name onOver
      * @memberof GUI_Object
      * @public
-     * @function
      * @param {Pointer} event the event object
      */
     onOver(/* event */) {}
@@ -162,7 +160,6 @@ class GUI_Object extends Sprite {
      * @name onOut
      * @memberof GUI_Object
      * @public
-     * @function
      * @param {Pointer} event the event object
      */
     onOut(/* event */) {
@@ -187,7 +184,6 @@ class GUI_Object extends Sprite {
      * @name onRelease
      * @memberof GUI_Object
      * @public
-     * @function
      * @returns {boolean} return false if we need to stop propagating the event
      */
     onRelease() {
@@ -212,7 +208,6 @@ class GUI_Object extends Sprite {
      * @name onHold
      * @memberof GUI_Object
      * @public
-     * @function
      */
     onHold() {}
 

package/src/renderable/collectable.js

@@ -1,6 +1,7 @@
 import Sprite from "./sprite.js";
 import Body from "./../physics/body.js";
 import collision from "./../physics/collision.js";
+import pool from "./../system/pooling.js";
 
 /**
  * @classdesc

package/src/renderable/container.js

@@ -100,7 +100,6 @@ class Container extends Renderable {
          * a callback to be extended, triggered after a child has been added or removed
          * @name onChildChange
          * @memberof Container#
-         * @function
          * @param {number} index added or removed child index
          */
         this.onChildChange = function (/* index */) {
@@ -157,7 +156,6 @@ class Container extends Renderable {
      * reset the container, removing all childrens, and reseting transforms.
      * @name reset
      * @memberof Container
-     * @function
      */
     reset() {
         // cancel any sort operation
@@ -193,7 +191,6 @@ class Container extends Renderable {
      * will not be in any container.
      * @name addChild
      * @memberof Container
-     * @function
      * @param {Renderable} child
      * @param {number} [z] forces the z index of the child to the specified value
      * @returns {Renderable} the added child
@@ -257,7 +254,6 @@ class Container extends Renderable {
      * (the list won't be sorted after insertion)
      * @name addChildAt
      * @memberof Container
-     * @function
      * @param {Renderable} child
      * @param {number} index
      * @returns {Renderable} the added child
@@ -316,7 +312,6 @@ class Container extends Renderable {
      *    - The array forEach() was called upon. <br>
      * @name forEach
      * @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.
      * @example
@@ -353,7 +348,6 @@ class Container extends Renderable {
      * Swaps the position (z-index) of 2 children
      * @name swapChildren
      * @memberof Container
-     * @function
      * @param {Renderable} child
      * @param {Renderable} child2
      */
@@ -381,7 +375,6 @@ class Container extends Renderable {
      * Returns the Child at the specified index
      * @name getChildAt
      * @memberof Container
-     * @function
      * @param {number} index
      * @returns {Renderable} the child at the specified index
      */
@@ -398,7 +391,6 @@ class Container extends Renderable {
      * Returns the index of the given Child
      * @name getChildIndex
      * @memberof Container
-     * @function
      * @param {Renderable} child
      * @returns {number} index
      */
@@ -410,7 +402,6 @@ class Container extends Renderable {
      * Returns the next child within the container or undefined if none
      * @name getNextChild
      * @memberof Container
-     * @function
      * @param {Renderable} child
      * @returns {Renderable} child
      */
@@ -426,7 +417,6 @@ class Container extends Renderable {
      * Returns true if contains the specified Child
      * @name hasChild
      * @memberof Container
-     * @function
      * @param {Renderable} child
      * @returns {boolean}
      */
@@ -441,7 +431,6 @@ class Container extends Renderable {
      * @name getChildByProp
      * @memberof Container
      * @public
-     * @function
      * @param {string} prop Property name
      * @param {string|RegExp|number|boolean} value Value of the property
      * @returns {Renderable[]} Array of childs
@@ -493,7 +482,6 @@ class Container extends Renderable {
      * @name getChildByType
      * @memberof Container
      * @public
-     * @function
      * @param {object} classType
      * @returns {Renderable[]} Array of children
      */
@@ -520,7 +508,6 @@ class Container extends Renderable {
      * @name getChildByName
      * @memberof Container
      * @public
-     * @function
      * @param {string|RegExp|number|boolean} name child name
      * @returns {Renderable[]} Array of children
      */
@@ -535,7 +522,6 @@ class Container extends Renderable {
      * @name getChildByGUID
      * @memberof Container
      * @public
-     * @function
      * @param {string|RegExp|number|boolean} guid child GUID
      * @returns {Renderable} corresponding child or null
      */
@@ -549,7 +535,6 @@ class Container extends Renderable {
      * @name getChildren
      * @memberof Container
      * @public
-     * @function
      * @returns {Renderable[]} an array of renderable object
      */
     getChildren() {
@@ -564,7 +549,6 @@ class Container extends Renderable {
      * @ignore
      * @name updateBounds
      * @memberof Renderable
-     * @function
      * @returns {Bounds} this shape bounding box Rectangle object
      */
     updateBounds(forceUpdateChildBounds = false) {
@@ -593,7 +577,6 @@ class Container extends Renderable {
      * @private
      * @name isAttachedToRoot
      * @memberof Container
-     * @function
      * @returns {boolean}
      */
     isAttachedToRoot() {
@@ -616,7 +599,6 @@ class Container extends Renderable {
      * @ignore
      * @name updateBoundsPos
      * @memberof Container
-     * @function
      */
     updateBoundsPos(newX, newY) {
         // call the parent method
@@ -652,7 +634,6 @@ class Container extends Renderable {
      * @name removeChild
      * @memberof Container
      * @public
-     * @function
      * @param {Renderable} child
      * @param {boolean} [keepalive=False] True to prevent calling child.destroy()
      */
@@ -671,7 +652,6 @@ class Container extends Renderable {
      * Never use keepalive=true with objects from {@link pool}. Doing so will create a memory leak.
      * @name removeChildNow
      * @memberof Container
-     * @function
      * @param {Renderable} child
      * @param {boolean} [keepalive=False] True to prevent calling child.destroy()
      */
@@ -724,7 +704,6 @@ class Container extends Renderable {
      * Automatically set the specified property of all childs to the given value
      * @name setChildsProperty
      * @memberof Container
-     * @function
      * @param {string} prop property name
      * @param {object} value property value
      * @param {boolean} [recursive=false] recursively apply the value to child containers if true
@@ -742,7 +721,6 @@ class Container extends Renderable {
      * Move the child in the group one step forward (z depth).
      * @name moveUp
      * @memberof Container
-     * @function
      * @param {Renderable} child
      */
     moveUp(child) {
@@ -759,7 +737,6 @@ class Container extends Renderable {
      * Move the child in the group one step backward (z depth).
      * @name moveDown
      * @memberof Container
-     * @function
      * @param {Renderable} child
      */
     moveDown(child) {
@@ -776,7 +753,6 @@ class Container extends Renderable {
      * Move the specified child to the top(z depth).
      * @name moveToTop
      * @memberof Container
-     * @function
      * @param {Renderable} child
      */
     moveToTop(child) {
@@ -796,7 +772,6 @@ class Container extends Renderable {
      * Move the specified child the bottom (z depth).
      * @name moveToBottom
      * @memberof Container
-     * @function
      * @param {Renderable} child
      */
     moveToBottom(child) {
@@ -817,7 +792,6 @@ class Container extends Renderable {
      * @name sort
      * @memberof Container
      * @public
-     * @function
      * @param {boolean} [recursive=false] recursively sort all containers if true
      */
     sort(recursive) {
@@ -911,7 +885,6 @@ class Container extends Renderable {
      * automatically called by the game manager {@link game}
      * @name update
      * @memberof Container
-     * @function
      * @protected
      * @param {number} dt time since the last update in milliseconds.
      * @returns {boolean} true if the Container is dirty
@@ -964,7 +937,6 @@ class Container extends Renderable {
      * automatically called by the game manager {@link game}
      * @name draw
      * @memberof Container
-     * @function
      * @protected
      * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
      * @param {Rect|Bounds} [rect] the area or viewport to (re)draw

package/src/renderable/dragndrop.js

@@ -33,7 +33,6 @@ export class Draggable extends Renderable {
      * transformed events.
      * @name initEvents
      * @memberof Draggable
-     * @function
      * @private
      */
     initEvents() {
@@ -57,7 +56,6 @@ export class Draggable extends Renderable {
      * Gets called when the user starts dragging the entity
      * @name dragStart
      * @memberof Draggable
-     * @function
      * @param {object} e the pointer event
      * @returns {boolean} false if the object is being dragged
      */
@@ -74,7 +72,6 @@ export class Draggable extends Renderable {
      * Gets called when the user drags this entity around
      * @name dragMove
      * @memberof Draggable
-     * @function
      * @param {object} e the pointer event
      */
     dragMove(e) {
@@ -88,7 +85,6 @@ export class Draggable extends Renderable {
      * Gets called when the user stops dragging the entity
      * @name dragEnd
      * @memberof Draggable
-     * @function
      * @returns {boolean} false if the object stopped being dragged
      */
     dragEnd() {
@@ -102,7 +98,6 @@ export class Draggable extends Renderable {
      * Destructor
      * @name destroy
      * @memberof Draggable
-     * @function
      * @ignore
      */
     destroy() {
@@ -173,7 +168,6 @@ export class DropTarget extends Renderable {
      * Sets the collision method which is going to be used to check a valid drop
      * @name setCheckMethod
      * @memberof DropTarget
-     * @function
      * @param {string} checkMethod the checkmethod (defaults to CHECKMETHOD_OVERLAP)
      */
     setCheckMethod(checkMethod) {
@@ -188,7 +182,6 @@ export class DropTarget extends Renderable {
      * Checks if a dropped entity is dropped on the current entity
      * @name checkOnMe
      * @memberof DropTarget
-     * @function
      * @param {object} e the triggering event
      * @param {Draggable} draggable the draggable object that is dropped
      */
@@ -203,7 +196,6 @@ export class DropTarget extends Renderable {
      * Gets called when a draggable entity is dropped on the current entity
      * @name drop
      * @memberof DropTarget
-     * @function
      * @param {Draggable} draggable the draggable object that is dropped
      */
     drop() {
@@ -214,7 +206,6 @@ export class DropTarget extends Renderable {
      * Destructor
      * @name destroy
      * @memberof DropTarget
-     * @function
      * @ignore
      */
     destroy() {

package/src/renderable/imagelayer.js

@@ -75,7 +75,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 {Vector2d}
+             * @member {Vector2d}
              * @default <0.0,0.0>
              * @name ImageLayer#anchorPoint
              */
@@ -160,7 +160,6 @@ class ImageLayer extends Sprite {
      * resize the Image Layer to match the given size
      * @name resize
      * @memberof ImageLayer
-     * @function
      * @param {number} w new width
      * @param {number} h new height
      */
@@ -174,7 +173,6 @@ class ImageLayer extends Sprite {
     /**
      * createPattern function
      * @ignore
-     * @function
      */
     createPattern() {
         this._pattern = renderer.createPattern(this.image, this._repeat);
@@ -183,7 +181,6 @@ class ImageLayer extends Sprite {
     /**
      * updateLayer function
      * @ignore
-     * @function
      */
     updateLayer(vpos) {
         var rx = this.ratio.x,
@@ -250,7 +247,6 @@ class ImageLayer extends Sprite {
      * automatically called by the game manager {@link game}
      * @name draw
      * @memberof ImageLayer
-     * @function
      * @protected
      * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
      */

package/src/renderable/light2d.js

@@ -72,7 +72,7 @@ class Light2d extends Renderable {
         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.texture = pool.pull("CanvasTexture", this.width, this.height, { offscreenCanvas: false });
 
         this.anchorPoint.set(0, 0);
 
@@ -83,7 +83,6 @@ class Light2d extends Renderable {
      * returns a geometry representing the visible area of this light
      * @name getVisibleArea
      * @memberof Light2d
-     * @function
      * @returns {Ellipse} the light visible mask
      */
     getVisibleArea() {

package/src/renderable/renderable.js

@@ -381,7 +381,6 @@ class Renderable extends Rect {
      * returns the bounding box for this renderable
      * @name getBounds
      * @memberof Renderable
-     * @function
      * @returns {Bounds} bounding box Rectangle object
      */
     getBounds() {
@@ -402,7 +401,6 @@ class Renderable extends Rect {
      * get the renderable alpha channel value<br>
      * @name getOpacity
      * @memberof Renderable
-     * @function
      * @returns {number} current opacity value between 0 and 1
      */
     getOpacity() {
@@ -413,7 +411,6 @@ class Renderable extends Rect {
      * set the renderable alpha channel value<br>
      * @name setOpacity
      * @memberof Renderable
-     * @function
      * @param {number} alpha opacity value between 0.0 and 1.0
      */
     setOpacity(alpha) {
@@ -432,7 +429,6 @@ class Renderable extends Rect {
      * @see Matrix2d#scaleX
      * @name flipX
      * @memberof Renderable
-     * @function
      * @param {boolean} [flip=true] `true` to flip this renderable.
      * @returns {Renderable} Reference to this object for method chaining
      */
@@ -447,7 +443,6 @@ class Renderable extends Rect {
      * @see Matrix2d#scaleY
      * @name flipY
      * @memberof Renderable
-     * @function
      * @param {boolean} [flip=true] `true` to flip this renderable.
      * @returns {Renderable} Reference to this object for method chaining
      */
@@ -462,7 +457,6 @@ class Renderable extends Rect {
      * @name transform
      * @memberof Renderable
      * @see Renderable#currentTransform
-     * @function
      * @param {Matrix2d} m the transformation matrix
      * @returns {Renderable} Reference to this object for method chaining
      */
@@ -478,7 +472,6 @@ class Renderable extends Rect {
      * return the angle to the specified target
      * @name angleTo
      * @memberof Renderable
-     * @function
      * @param {Renderable|Vector2d|Vector3d} target
      * @returns {number} angle in radians
      */
@@ -502,7 +495,6 @@ class Renderable extends Rect {
      * return the distance to the specified target
      * @name distanceTo
      * @memberof Renderable
-     * @function
      * @param {Renderable|Vector2d|Vector3d} target
      * @returns {number} distance
      */
@@ -526,7 +518,6 @@ class Renderable extends Rect {
      * Rotate this renderable towards the given target.
      * @name lookAt
      * @memberof Renderable
-     * @function
      * @param {Renderable|Vector2d|Vector3d} target the renderable or position to look at
      * @returns {Renderable} Reference to this object for method chaining
      */
@@ -550,7 +541,6 @@ class Renderable extends Rect {
      * Rotate this renderable by the specified angle (in radians).
      * @name rotate
      * @memberof Renderable
-     * @function
      * @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
@@ -572,7 +562,6 @@ class Renderable extends Rect {
      * member will be changed.
      * @name scale
      * @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.
      * @returns {Renderable} Reference to this object for method chaining
@@ -588,7 +577,6 @@ class Renderable extends Rect {
      * scale the renderable around his anchor point
      * @name scaleV
      * @memberof Renderable
-     * @function
      * @param {Vector2d} v scaling vector
      * @returns {Renderable} Reference to this object for method chaining
      */
@@ -602,7 +590,6 @@ class Renderable extends Rect {
      * automatically called by the game manager {@link game}
      * @name update
      * @memberof Renderable
-     * @function
      * @protected
      * @param {number} dt time since the last update in milliseconds.
      * @returns {boolean} true if the renderable is dirty
@@ -616,7 +603,6 @@ class Renderable extends Rect {
      * @ignore
      * @name updateBounds
      * @memberof Renderable
-     * @function
      * @returns {Bounds} this shape bounding box Rectangle object
      */
     updateBounds() {
@@ -630,7 +616,6 @@ class Renderable extends Rect {
      * @ignore
      * @name updateBoundsPos
      * @memberof Renderable
-     * @function
      */
      updateBoundsPos(newX, newY) {
          var bounds = this.getBounds();
@@ -663,7 +648,6 @@ class Renderable extends Rect {
       * return the renderable absolute position in the game world
       * @name getAbsolutePosition
       * @memberof Renderable
-      * @function
       * @returns {Vector2d}
       */
       getAbsolutePosition() {
@@ -683,7 +667,6 @@ class Renderable extends Rect {
      * @private
      * @name onAnchorUpdate
      * @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
      */
@@ -701,7 +684,6 @@ class Renderable extends Rect {
      * automatically called by the game manager {@link game}
      * @name preDraw
      * @memberof Renderable
-     * @function
      * @protected
      * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
      */
@@ -757,7 +739,6 @@ class Renderable extends Rect {
      * automatically called by the game manager {@link game}
      * @name draw
      * @memberof Renderable
-     * @function
      * @protected
      * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
      */
@@ -770,7 +751,6 @@ class Renderable extends Rect {
      * automatically called by the game manager {@link game}
      * @name postDraw
      * @memberof Renderable
-     * @function
      * @protected
      * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
      */
@@ -795,7 +775,6 @@ class Renderable extends Rect {
      * when this renderable body is colliding with another one
      * @name onCollision
      * @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)
      * @returns {boolean} true if the object should respond to the collision (its position and velocity will be corrected)
@@ -872,7 +851,6 @@ class Renderable extends Rect {
      * Called by engine before deleting the object
      * @name onDestroyEvent
      * @memberof Renderable
-     * @function
      */
     onDestroyEvent() {
         // to be extended !

package/src/renderable/sprite.js

@@ -210,7 +210,6 @@ class Sprite extends Renderable {
      * return the flickering state of the object
      * @name isFlickering
      * @memberof Sprite
-     * @function
      * @returns {boolean}
      */
     isFlickering() {
@@ -221,7 +220,6 @@ class Sprite extends Renderable {
      * make the object flicker
      * @name flicker
      * @memberof Sprite
-     * @function
      * @param {number} duration expressed in milliseconds
      * @param {Function} callback Function to call when flickering ends
      * @returns {Sprite} Reference to this object for method chaining
@@ -252,7 +250,6 @@ class Sprite extends Renderable {
      * <img src="images/spritesheet_grid.png"/>
      * @name addAnimation
      * @memberof Sprite
-     * @function
      * @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
@@ -352,7 +349,6 @@ class Sprite extends Renderable {
      * this will always change the animation & set the frame to zero
      * @name setCurrentAnimation
      * @memberof Sprite
-     * @function
      * @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
@@ -413,7 +409,6 @@ class Sprite extends Renderable {
      * reverse the given or current animation if none is specified
      * @name reverseAnimation
      * @memberof Sprite
-     * @function
      * @param {string} [name] animation id
      * @returns {Sprite} Reference to this object for method chaining
      * @see Sprite#animationspeed
@@ -432,7 +427,6 @@ class Sprite extends Renderable {
      * return true if the specified animation is the current one.
      * @name isCurrentAnimation
      * @memberof Sprite
-     * @function
      * @param {string} name animation id
      * @returns {boolean}
      * @example
@@ -449,7 +443,6 @@ class Sprite extends Renderable {
      * @see Texture.getRegion
      * @name setRegion
      * @memberof Sprite
-     * @function
      * @param {object} region typically returned through me.Texture.getRegion()
      * @returns {Sprite} Reference to this object for method chaining
      * @example
@@ -481,7 +474,6 @@ class Sprite extends Renderable {
      * force the current animation frame index.
      * @name setAnimationFrame
      * @memberof Sprite
-     * @function
      * @param {number} [idx=0] animation frame index
      * @returns {Sprite} Reference to this object for method chaining
      * @example
@@ -497,7 +489,6 @@ class Sprite extends Renderable {
      * return the current animation frame index.
      * @name getCurrentAnimationFrame
      * @memberof Sprite
-     * @function
      * @returns {number} current animation frame index
      */
     getCurrentAnimationFrame() {
@@ -508,7 +499,6 @@ class Sprite extends Renderable {
      * Returns the frame object by the index.
      * @name getAnimationFrameObjectByIndex
      * @memberof Sprite
-     * @function
      * @ignore
      * @param {number} id the frame id
      * @returns {number} if using number indices. Returns {object} containing frame data if using texture atlas
@@ -522,7 +512,6 @@ class Sprite extends Renderable {
      * automatically called by the game manager {@link game}
      * @name update
      * @memberof Sprite
-     * @function
      * @protected
      * @param {number} dt time since the last update in milliseconds.
      * @returns {boolean} true if the Sprite is dirty
@@ -601,7 +590,6 @@ class Sprite extends Renderable {
      * automatically called by the game manager {@link game}
      * @name draw
      * @memberof Sprite
-     * @function
      * @protected
      * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
      */

package/src/renderable/trigger.js

@@ -3,6 +3,7 @@ import collision from "./../physics/collision.js";
 import Body from "./../physics/body.js";
 import level from "./../level/level.js";
 import { world, viewport } from "./../game.js";
+import pool from "./../system/pooling.js";
 
 /**
  * @classdesc
@@ -105,7 +106,6 @@ class Trigger extends Renderable {
      * trigger this event
      * @name triggerEvent
      * @memberof Trigger
-     * @function
      * @protected
      */
     triggerEvent() {

package/src/state/stage.js

@@ -116,7 +116,6 @@ class Stage {
      * @name update
      * @memberof Stage
      * @ignore
-     * @function
      * @param {number} dt time since the last update in milliseconds.
      * @returns {boolean}
      */
@@ -147,7 +146,6 @@ class Stage {
      * @name draw
      * @memberof Stage
      * @ignore
-     * @function
      * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
      */
     draw(renderer) {
@@ -203,7 +201,6 @@ class Stage {
      * this is typically where you will load a level, add renderables, etc...
      * @name onResetEvent
      * @memberof Stage
-     * @function
      * @param {object} [...arguments] optional arguments passed when switching state
      * @see state#change
      */
@@ -220,7 +217,6 @@ class Stage {
      * called by the state manager before switching to another state
      * @name onDestroyEvent
      * @memberof Stage
-     * @function
      */
     onDestroyEvent() {
         // execute onDestroyEvent function if given through the constructor