melonjs 10.11.0 → 10.12.0

package/dist/melonjs.module.d.ts

@@ -184,6 +184,7 @@ export class BitmapTextData {
 /**
  * @classdesc
  * a Generic Physic Body Object with some physic properties and behavior functionality, to as a member of a Renderable.
+ * @see Renderable.body
  */
 export class Body {
     /**
@@ -431,7 +432,7 @@ export class Body {
     setCollisionType(type: number): void;
     /**
      * the built-in function to solve the collision response
-     * @param {object} response the collision response object (see {@link collision.ResponseObject})
+     * @param {object} response the collision response object (see {@link ResponseObject})
      */
     respondToCollision(response: object): void;
     /**
@@ -477,16 +478,14 @@ export class Body {
      * cap the body velocity (body.maxVel property) to the specified value<br>
      * @param {number} x max velocity on x axis
      * @param {number} y max velocity on y axis
-     * @protected
      */
-    protected setMaxVelocity(x: number, y: number): void;
+    setMaxVelocity(x: number, y: number): void;
     /**
      * set the body default friction
      * @param {number} x horizontal friction
      * @param {number} y vertical friction
-     * @protected
      */
-    protected setFriction(x?: number, y?: number): void;
+    setFriction(x?: number, y?: number): void;
     /**
      * compute the new velocity value
      * @ignore
@@ -1653,11 +1652,6 @@ export class ColorLayer extends Renderable {
      */
     public color: Color;
     onResetEvent(name: any, color: any, z?: number): void;
-    /**
-     * draw the color layer
-     * @ignore
-     */
-    draw(renderer: any, rect: any): void;
     /**
      * Destroy function
      * @ignore
@@ -1739,7 +1733,7 @@ export class Container extends Renderable {
      * @memberof Container#
      * @param {number} index added or removed child index
      */
-    onChildChange: () => void;
+    onChildChange: (index: number) => void;
     /**
      * Specify if the container bounds should automatically take in account
      * all child bounds when updated (this is expensive and disabled by default,
@@ -1780,8 +1774,10 @@ export class Container extends Renderable {
      * Adding a child to the container will automatically remove it from its other container.
      * Meaning a child can only have one parent.  This is important if you add a renderable
      * to a container then add it to the me.game.world container it will move it out of the
-     * orginal container.  Then when the me.game.world.reset() is called the renderable
-     * will not be in any container.
+     * orginal container. Then when the me.game.world.reset() is called the renderable
+     * will not be in any container. <br>
+     * if the given child implements a onActivateEvent method, that method will be called
+     * once the child is added to this container.
      * @name addChild
      * @memberof Container
      * @param {Renderable} child
@@ -1954,7 +1950,8 @@ export class Container extends Renderable {
      */
     onActivateEvent(): void;
     /**
-     * Invokes the removeChildNow in a defer, to ensure the child is removed safely after the update & draw stack has completed
+     * Invokes the removeChildNow in a defer, to ensure the child is removed safely after the update & draw stack has completed. <br>
+     * if the given child implements a onDeactivateEvent() method, that method will be called once the child is removed from this container.
      * @name removeChild
      * @memberof Container
      * @public
@@ -2041,16 +2038,6 @@ export class Container extends Renderable {
      * @ignore
      */
     _sortY(a: any, b: any): number;
-    /**
-     * draw the container. <br>
-     * automatically called by the game manager {@link game}
-     * @name draw
-     * @memberof Container
-     * @protected
-     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
-     * @param {Rect|Bounds} [rect] the area or viewport to (re)draw
-     */
-    protected draw(renderer: CanvasRenderer | WebGLRenderer, rect?: Rect | Bounds): void;
 }
 /**
  * @classdesc
@@ -2174,7 +2161,7 @@ export class DropTarget extends Renderable {
      * @memberof DropTarget
      * @param {Draggable} draggable the draggable object that is dropped
      */
-    drop(): void;
+    drop(draggable: Draggable): void;
     /**
      * Destructor
      * @name destroy
@@ -2302,7 +2289,7 @@ export class Ellipse {
      * @param {Matrix2d} matrix the transformation matrix
      * @returns {Polygon} Reference to this object for method chaining
      */
-    transform(): Polygon;
+    transform(matrix: Matrix2d): Polygon;
     /**
      * translate the circle/ellipse by the specified offset
      * @name translate
@@ -2440,17 +2427,6 @@ export class Entity extends Renderable {
      */
     onBodyUpdate(body: Body): void;
     preDraw(renderer: any): void;
-    /**
-     * object draw<br>
-     * not to be called by the end user<br>
-     * called by the game manager on each game loop
-     * @name draw
-     * @memberof Entity
-     * @protected
-     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
-     * @param {Rect} rect region to draw
-     */
-    protected draw(renderer: CanvasRenderer | WebGLRenderer, rect: Rect): void;
     /**
      * onDeactivateEvent Notification function<br>
      * Called by engine before deleting the object
@@ -2667,7 +2643,7 @@ export class GUI_Object extends Sprite {
      * @param {Pointer} event the event object
      * @returns {boolean} return false if we need to stop propagating the event
      */
-    public onClick(): boolean;
+    public onClick(event: Pointer): boolean;
     /**
      * function callback for the pointerEnter event
      * @ignore
@@ -2680,7 +2656,7 @@ export class GUI_Object extends Sprite {
      * @public
      * @param {Pointer} event the event object
      */
-    public onOver(): void;
+    public onOver(event: Pointer): void;
     /**
      * function callback for the pointerLeave event
      * @ignore
@@ -2693,7 +2669,7 @@ export class GUI_Object extends Sprite {
      * @public
      * @param {Pointer} event the event object
      */
-    public onOut(): void;
+    public onOut(event: Pointer): void;
     /**
      * function callback for the pointerup event
      * @ignore
@@ -2794,14 +2770,6 @@ export class ImageLayer extends Renderable {
     repeatX: boolean;
     repeatY: boolean;
     onActivateEvent(): void;
-    /**
-     * resize the Image Layer to match the given size
-     * @name resize
-     * @memberof ImageLayer
-     * @param {number} w new width
-     * @param {number} h new height
-     */
-    resize(w: number, h: number): void;
     /**
      * createPattern function
      * @ignore
@@ -2871,11 +2839,6 @@ export class Light2d extends Renderable {
      * @returns {Ellipse} the light visible mask
      */
     getVisibleArea(): Ellipse;
-    /**
-     * object draw (Called internally by the engine).
-     * @ignore
-     */
-    draw(renderer: any): void;
     /**
      * Destroy function<br>
      * @ignore
@@ -5220,7 +5183,7 @@ export class Pointer extends Bounds {
  * (which means that all angles are less than 180 degrees), as described here below : <br>
  * <center><img src="images/convex_polygon.png"/></center><br>
  *
- * A polygon's `winding` is clockwise iff its vertices (points) are declared turning to the right. The image above shows COUNTERCLOCKWISE winding.
+ * A polygon's `winding` is clockwise if its vertices (points) are declared turning to the right. The image above shows COUNTERCLOCKWISE winding.
  */
 export class Polygon {
     /**
@@ -5609,10 +5572,10 @@ export class Rect extends Polygon {
      * @name centerOn
      * @memberof Rect
      * @param {number} x the x coordinate around which to center this rectangle
-     * @param {number} x the y coordinate around which to center this rectangle
+     * @param {number} y the y coordinate around which to center this rectangle
      * @returns {Rect} this rectangle
      */
-    centerOn(x: number, y: any): Rect;
+    centerOn(x: number, y: number): Rect;
     /**
      * resize the rectangle
      * @name resize
@@ -6127,14 +6090,14 @@ export class Renderable extends Rect {
      */
     protected preDraw(renderer: CanvasRenderer | WebGLRenderer): void;
     /**
-     * object draw. <br>
-     * automatically called by the game manager {@link game}
+     * draw this renderable (automatically called by melonJS)
      * @name draw
      * @memberof Renderable
      * @protected
-     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
+     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer instance
+     * @param {Camera2d} [viewport] the viewport to (re)draw
      */
-    protected draw(renderer: CanvasRenderer | WebGLRenderer): void;
+    protected draw(renderer: CanvasRenderer | WebGLRenderer, viewport?: Camera2d): void;
     /**
      * restore the rendering context after drawing. <br>
      * automatically called by the game manager {@link game}
@@ -6149,7 +6112,7 @@ export class Renderable extends Rect {
      * when this renderable body is colliding with another one
      * @name onCollision
      * @memberof Renderable
-     * @param {collision.ResponseObject} response the collision response object
+     * @param {ResponseObject} response the collision response object
      * @param {Renderable} other the other renderable touching this one (a reference to response.a or response.b)
      * @returns {boolean} true if the object should respond to the collision (its position and velocity will be corrected)
      * @example
@@ -6166,7 +6129,7 @@ export class Renderable extends Rect {
      *     return true;
      * },
      */
-    onCollision(): boolean;
+    onCollision(response: ResponseObject, other: Renderable): boolean;
     /**
      * Destroy function<br>
      * @ignore
@@ -7693,11 +7656,11 @@ export class Text extends Renderable {
     setText(value?: number | string | string[]): Text;
     /**
      * measure the given text size in pixels
-     * @param {CanvasRenderer|WebGLRenderer} [renderer] reference to the active renderer
+     * @param {CanvasRenderer|WebGLRenderer} renderer reference to the active renderer
      * @param {string} [text] the text to be measured
      * @returns {TextMetrics} a TextMetrics object defining the dimensions of the given piece of text
      */
-    measureText(renderer$1?: CanvasRenderer | WebGLRenderer, text?: string): TextMetrics;
+    measureText(renderer: CanvasRenderer | WebGLRenderer, text?: string): TextMetrics;
     /**
      * draw a text at the specified coord
      * @param {CanvasRenderer|WebGLRenderer} renderer Reference to the destination renderer instance
@@ -7837,9 +7800,11 @@ export class TextureAtlas {
      * add uvs mapping for the given region
      * @param {object} atlas the atlas dictionnary where the region is define
      * @param {object} name region (or frame) name
+     * @param {number} w the width of the region
+     * @param {number} h the height of the region
      * @returns {Float32Array} the created region UVs
      */
-    addUVs(atlas: object, name: object, w: any, h: any): Float32Array;
+    addUVs(atlas: object, name: object, w: number, h: number): Float32Array;
     /**
      * Create a sprite object using the first region found using the specified name
      * @param {string} name name of the sprite
@@ -9699,12 +9664,76 @@ export var audio: Readonly<{
  * @public
  */
 export function boot(): void;
-/**
- * Collision detection (and projection-based collision response) of 2D shapes.<br>
- * Based on the Separating Axis Theorem and supports detecting collisions between simple Axis-Aligned Boxes, convex polygons and circles based shapes.
- * @namespace collision
- */
-export var collision: any;
+export namespace collision {
+    const maxChildren: number;
+    const maxDepth: number;
+    namespace types {
+        const NO_OBJECT: number;
+        const PLAYER_OBJECT: number;
+        const NPC_OBJECT: number;
+        const ENEMY_OBJECT: number;
+        const COLLECTABLE_OBJECT: number;
+        const ACTION_OBJECT: number;
+        const PROJECTILE_OBJECT: number;
+        const WORLD_SHAPE: number;
+        const USER: number;
+        const ALL_OBJECT: number;
+    }
+    /**
+     * Checks for object colliding with the given line
+     * @name rayCast
+     * @memberof collision
+     * @public
+     * @param {Line} line line to be tested for collision
+     * @param {Array.<Renderable>} [result] a user defined array that will be populated with intersecting physic objects.
+     * @returns {Array.<Renderable>} an array of intersecting physic objects
+     * @example
+     *    // define a line accross the viewport
+     *    var ray = new me.Line(
+     *        // absolute position of the line
+     *        0, 0, [
+     *        // starting point relative to the initial position
+     *        new me.Vector2d(0, 0),
+     *        // ending point
+     *        new me.Vector2d(me.game.viewport.width, me.game.viewport.height)
+     *    ]);
+     *
+     *    // check for collition
+     *    result = me.collision.rayCast(ray);
+     *
+     *    if (result.length > 0) {
+     *        // ...
+     *    }
+     */
+    function rayCast(line: Line, result?: Renderable[]): Renderable[];
+    /**
+     * Checks for object colliding with the given line
+     * @name rayCast
+     * @memberof collision
+     * @public
+     * @param {Line} line line to be tested for collision
+     * @param {Array.<Renderable>} [result] a user defined array that will be populated with intersecting physic objects.
+     * @returns {Array.<Renderable>} an array of intersecting physic objects
+     * @example
+     *    // define a line accross the viewport
+     *    var ray = new me.Line(
+     *        // absolute position of the line
+     *        0, 0, [
+     *        // starting point relative to the initial position
+     *        new me.Vector2d(0, 0),
+     *        // ending point
+     *        new me.Vector2d(me.game.viewport.width, me.game.viewport.height)
+     *    ]);
+     *
+     *    // check for collition
+     *    result = me.collision.rayCast(ray);
+     *
+     *    if (result.length > 0) {
+     *        // ...
+     *    }
+     */
+    function rayCast(line: Line, result?: Renderable[]): Renderable[];
+}
 export namespace device {
     const devicePixelRatio: number;
     const isFullscreen: boolean;
@@ -10756,17 +10785,18 @@ export namespace save {
  */
 export var skipAutoInit: boolean;
 export namespace state {
-    const LOADING: number;
-    const MENU: number;
-    const READY: number;
-    const PLAY: number;
-    const GAMEOVER: number;
-    const GAME_END: number;
-    const SCORE: number;
-    const CREDITS: number;
-    const SETTINGS: number;
-    const DEFAULT: number;
-    const USER: number;
+    export const LOADING: number;
+    export const MENU: number;
+    export const READY: number;
+    export const PLAY: number;
+    export const GAMEOVER: number;
+    export const GAME_END: number;
+    export const SCORE: number;
+    export const CREDITS: number;
+    export const SETTINGS: number;
+    export const DEFAULT: number;
+    const USER_1: number;
+    export { USER_1 as USER };
     /**
      * Stop the current stage.
      * @name stop
@@ -10774,7 +10804,7 @@ export namespace state {
      * @public
      * @param {boolean} [pauseTrack=false] pause current track on screen stop.
      */
-    function stop(pauseTrack?: boolean): void;
+    export function stop(pauseTrack?: boolean): void;
     /**
      * Stop the current stage.
      * @name stop
@@ -10782,7 +10812,7 @@ export namespace state {
      * @public
      * @param {boolean} [pauseTrack=false] pause current track on screen stop.
      */
-    function stop(pauseTrack?: boolean): void;
+    export function stop(pauseTrack?: boolean): void;
     /**
      * pause the current stage
      * @name pause
@@ -10790,7 +10820,7 @@ export namespace state {
      * @public
      * @param {boolean} [music=false] pause current music track on screen pause
      */
-    function pause(music?: boolean): void;
+    export function pause(music?: boolean): void;
     /**
      * pause the current stage
      * @name pause
@@ -10798,7 +10828,7 @@ export namespace state {
      * @public
      * @param {boolean} [music=false] pause current music track on screen pause
      */
-    function pause(music?: boolean): void;
+    export function pause(music?: boolean): void;
     /**
      * Restart the current stage from a full stop.
      * @name restart
@@ -10806,7 +10836,7 @@ export namespace state {
      * @public
      * @param {boolean} [music=false] resume current music track on screen resume
      */
-    function restart(music?: boolean): void;
+    export function restart(music?: boolean): void;
     /**
      * Restart the current stage from a full stop.
      * @name restart
@@ -10814,7 +10844,7 @@ export namespace state {
      * @public
      * @param {boolean} [music=false] resume current music track on screen resume
      */
-    function restart(music?: boolean): void;
+    export function restart(music?: boolean): void;
     /**
      * resume the current stage
      * @name resume
@@ -10822,7 +10852,7 @@ export namespace state {
      * @public
      * @param {boolean} [music=false] resume current music track on screen resume
      */
-    function resume(music?: boolean): void;
+    export function resume(music?: boolean): void;
     /**
      * resume the current stage
      * @name resume
@@ -10830,7 +10860,7 @@ export namespace state {
      * @public
      * @param {boolean} [music=false] resume current music track on screen resume
      */
-    function resume(music?: boolean): void;
+    export function resume(music?: boolean): void;
     /**
      * return the running state of the state manager
      * @name isRunning
@@ -10838,7 +10868,7 @@ export namespace state {
      * @public
      * @returns {boolean} true if a "process is running"
      */
-    function isRunning(): boolean;
+    export function isRunning(): boolean;
     /**
      * return the running state of the state manager
      * @name isRunning
@@ -10846,7 +10876,7 @@ export namespace state {
      * @public
      * @returns {boolean} true if a "process is running"
      */
-    function isRunning(): boolean;
+    export function isRunning(): boolean;
     /**
      * Return the pause state of the state manager
      * @name isPaused
@@ -10854,7 +10884,7 @@ export namespace state {
      * @public
      * @returns {boolean} true if the game is paused
      */
-    function isPaused(): boolean;
+    export function isPaused(): boolean;
     /**
      * Return the pause state of the state manager
      * @name isPaused
@@ -10862,7 +10892,7 @@ export namespace state {
      * @public
      * @returns {boolean} true if the game is paused
      */
-    function isPaused(): boolean;
+    export function isPaused(): boolean;
     /**
      * associate the specified state with a Stage
      * @name set
@@ -10908,7 +10938,7 @@ export namespace state {
      *
      * me.state.set(me.state.MENU, new MenuScreen());
      */
-    function set(state: number, stage: Stage, start?: boolean): void;
+    export function set(state: number, stage: Stage, start?: boolean): void;
     /**
      * associate the specified state with a Stage
      * @name set
@@ -10954,7 +10984,27 @@ export namespace state {
      *
      * me.state.set(me.state.MENU, new MenuScreen());
      */
-    function set(state: number, stage: Stage, start?: boolean): void;
+    export function set(state: number, stage: Stage, start?: boolean): void;
+    /**
+     * returns the stage associated with the specified state
+     * (or the current one if none is specified)
+     * @name set
+     * @memberof state
+     * @public
+     * @param {number} [state] State ID (see constants)
+     * @returns {Stage}
+     */
+    export function get(state?: number): Stage;
+    /**
+     * returns the stage associated with the specified state
+     * (or the current one if none is specified)
+     * @name set
+     * @memberof state
+     * @public
+     * @param {number} [state] State ID (see constants)
+     * @returns {Stage}
+     */
+    export function get(state?: number): Stage;
     /**
      * return a reference to the current stage<br>
      * useful to call a object specific method
@@ -10963,7 +11013,7 @@ export namespace state {
      * @public
      * @returns {Stage}
      */
-    function current(): Stage;
+    export function current(): Stage;
     /**
      * return a reference to the current stage<br>
      * useful to call a object specific method
@@ -10972,7 +11022,7 @@ export namespace state {
      * @public
      * @returns {Stage}
      */
-    function current(): Stage;
+    export function current(): Stage;
     /**
      * specify a global transition effect
      * @name transition
@@ -10982,7 +11032,7 @@ export namespace state {
      * @param {Color|string} color a CSS color value
      * @param {number} [duration=1000] expressed in milliseconds
      */
-    function transition(effect: string, color: string | Color, duration?: number): void;
+    export function transition(effect: string, color: string | Color, duration?: number): void;
     /**
      * specify a global transition effect
      * @name transition
@@ -10992,7 +11042,7 @@ export namespace state {
      * @param {Color|string} color a CSS color value
      * @param {number} [duration=1000] expressed in milliseconds
      */
-    function transition(effect: string, color: string | Color, duration?: number): void;
+    export function transition(effect: string, color: string | Color, duration?: number): void;
     /**
      * enable/disable transition for a specific state (by default enabled for all)
      * @name setTransition
@@ -11001,7 +11051,7 @@ export namespace state {
      * @param {number} state State ID (see constants)
      * @param {boolean} enable
      */
-    function setTransition(state: number, enable: boolean): void;
+    export function setTransition(state: number, enable: boolean): void;
     /**
      * enable/disable transition for a specific state (by default enabled for all)
      * @name setTransition
@@ -11010,7 +11060,7 @@ export namespace state {
      * @param {number} state State ID (see constants)
      * @param {boolean} enable
      */
-    function setTransition(state: number, enable: boolean): void;
+    export function setTransition(state: number, enable: boolean): void;
     /**
      * change the game/app state
      * @name change
@@ -11024,7 +11074,7 @@ export namespace state {
      * // "level_1" and the number 3
      * me.state.change(me.state.PLAY, "level_1", 3);
      */
-    function change(state: number, forceChange: boolean, ...args: any[]): void;
+    export function change(state: number, forceChange: boolean, ...args: any[]): void;
     /**
      * change the game/app state
      * @name change
@@ -11038,7 +11088,7 @@ export namespace state {
      * // "level_1" and the number 3
      * me.state.change(me.state.PLAY, "level_1", 3);
      */
-    function change(state: number, forceChange: boolean, ...args: any[]): void;
+    export function change(state: number, forceChange: boolean, ...args: any[]): void;
     /**
      * return true if the specified state is the current one
      * @name isCurrent
@@ -11047,7 +11097,7 @@ export namespace state {
      * @param {number} state State ID (see constants)
      * @returns {boolean} true if the specified state is the current one
      */
-    function isCurrent(state: number): boolean;
+    export function isCurrent(state: number): boolean;
     /**
      * return true if the specified state is the current one
      * @name isCurrent
@@ -11056,7 +11106,7 @@ export namespace state {
      * @param {number} state State ID (see constants)
      * @returns {boolean} true if the specified state is the current one
      */
-    function isCurrent(state: number): boolean;
+    export function isCurrent(state: number): boolean;
 }
 /**
  * the default global Timer instance
@@ -11323,6 +11373,42 @@ declare function round(num: number, dec?: number): number;
  * }
  */
 declare function toBeCloseTo(expected: number, actual: number, precision?: number): boolean;
+/**
+ * @classdesc
+ * An object representing the result of an intersection.
+ * @property {Renderable} a The first object participating in the intersection
+ * @property {Renderable} b The second object participating in the intersection
+ * @property {number} overlap Magnitude of the overlap on the shortest colliding axis
+ * @property {Vector2d} overlapV The overlap vector (i.e. `overlapN.scale(overlap, overlap)`). If this vector is subtracted from the position of a, a and b will no longer be colliding
+ * @property {Vector2d} overlapN The shortest colliding axis (unit-vector)
+ * @property {boolean} aInB Whether the first object is entirely inside the second
+ * @property {boolean} bInA Whether the second object is entirely inside the first
+ * @property {number} indexShapeA The index of the colliding shape for the object a body
+ * @property {number} indexShapeB The index of the colliding shape for the object b body
+ * @name ResponseObject
+ * @public
+ */
+declare class ResponseObject {
+    a: any;
+    b: any;
+    overlapN: Vector2d;
+    overlapV: Vector2d;
+    aInB: boolean;
+    bInA: boolean;
+    indexShapeA: number;
+    indexShapeB: number;
+    overlap: number;
+    /**
+     * Set some values of the response back to their defaults. <br>
+     * Call this between tests if you are going to reuse a single <br>
+     * Response object for multiple intersection tests <br>
+     * (recommended as it will avoid allocating extra memory) <br>
+     * @name clear
+     * @public
+     * @returns {object} this object for chaining
+     */
+    public clear(): object;
+}
 /**
  * @classdesc
  * a simplified path2d implementation, supporting only one path
@@ -11400,13 +11486,13 @@ declare class Path2D {
      * adds a circular arc to the path with the given control points and radius, connected to the previous point by a straight line.
      * @name arcTo
      * @memberof Path2D
-     * @param {number} x the x-axis coordinate of the first control point.
-     * @param {number} y the y-axis coordinate of the first control point.
-     * @param {number} x the x-axis coordinate of the second control point.
-     * @param {number} y the y-axis coordinate of the second control point.
+     * @param {number} x1 the x-axis coordinate of the first control point.
+     * @param {number} y1 the y-axis coordinate of the first control point.
+     * @param {number} x2 the x-axis coordinate of the second control point.
+     * @param {number} y2 the y-axis coordinate of the second control point.
      * @param {number} radius the arc's radius. Must be positive.
      */
-    arcTo(x1: any, y1: any, x2: any, y2: any, radius: number): void;
+    arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): void;
     /**
      * adds an elliptical arc to the path which is centered at (x, y) position with the radii radiusX and radiusY
      * starting at startAngle and ending at endAngle going in the given direction by counterclockwise.