melonjs 10.6.1 → 10.7.0

package/dist/melonjs.module.d.ts

@@ -1085,7 +1085,7 @@ export class CanvasRenderer extends Renderer {
      * <img src="images/normal-blendmode.png" width="510"/> <br>
      * - "multiply" : the pixels of the top layer are multiplied with the corresponding pixel of the bottom layer. A darker picture is the result. <br>
      * <img src="images/multiply-blendmode.png" width="510"/> <br>
-     * - "lighter" : where both content overlap the color is determined by adding color values. <br>
+     * - "additive or lighter" : where both content overlap the color is determined by adding color values. <br>
      * <img src="images/lighter-blendmode.png" width="510"/> <br>
      * - "screen" : The pixels are inverted, multiplied, and inverted again. A lighter picture is the result (opposite of multiply) <br>
      * <img src="images/screen-blendmode.png" width="510"/> <br>
@@ -1093,7 +1093,7 @@ export class CanvasRenderer extends Renderer {
      * @see https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/globalCompositeOperation
      * @memberof CanvasRenderer.prototype
      * @function
-     * @param {string} [mode="normal"] blend mode : "normal", "multiply", "lighter, "screen"
+     * @param {string} [mode="normal"] blend mode : "normal", "multiply", "lighter, "additive", "screen"
      * @param {CanvasRenderingContext2D} [context]
      */
     setBlendMode(mode?: string, context?: CanvasRenderingContext2D): void;
@@ -4053,17 +4053,18 @@ export class ObservableVector3d extends Vector3d {
 /**
  * @classdesc
  * Single Particle Object.
- * @class Particle
  * @augments Renderable
- * @param {ParticleEmitter} particle emitter
  */
 export class Particle extends Renderable {
+    /**
+     * @param {ParticleEmitter} emitter the particle emitter
+     */
+    constructor(emitter: ParticleEmitter);
     /**
      * @ignore
      */
-    constructor(emitter: any);
-    vel: Vector2d;
     onResetEvent(emitter: any, newInstance?: boolean): void;
+    vel: Vector2d;
     image: any;
     life: any;
     startLife: any;
@@ -4075,50 +4076,319 @@ export class Particle extends Renderable {
     onlyInViewport: any;
     _deltaInv: number;
     angle: number;
-    /**
-     * @ignore
-     */
-    preDraw(renderer: any): void;
     /**
      * @ignore
      */
     draw(renderer: any): void;
 }
 /**
+ * @classdesc
  * Particle Emitter Object.
- * @class
- * @augments Rect
- * @param {number} x x-position of the particle emitter
- * @param {number} y y-position of the particle emitter
- * @param {object} settings An object containing the settings for the particle emitter. See {@link ParticleEmitterSettings}
- * @example
- * // Create a basic emitter at position 100, 100
- * var emitter = new me.ParticleEmitter(100, 100);
- *
- * // Adjust the emitter properties
- * emitter.totalParticles = 200;
- * emitter.minLife = 1000;
- * emitter.maxLife = 3000;
- * emitter.z = 10;
- *
- * // Add the emitter to the game world
- * me.game.world.addChild(emitter);
- *
- * // Launch all particles one time and stop, like a explosion
- * emitter.burstParticles();
- *
- * // Launch constantly the particles, like a fountain
- * emitter.streamParticles();
- *
- * // At the end, remove emitter from the game world
- * // call this in onDestroyEvent function
- * me.game.world.removeChild(emitter);
+ * @augments Container
  */
-export class ParticleEmitter extends Rect {
+export class ParticleEmitter extends Container {
     /**
-     * @ignore
+     * @param {number} x x position of the particle emitter
+     * @param {number} y y position of the particle emitter
+     * @param {ParticleEmitterSettings} [settings=ParticleEmitterSettings] the settings for the particle emitter.
+     * @example
+     * // Create a basic emitter at position 100, 100
+     * var emitter = new ParticleEmitter(100, 100);
+     *
+     * // Adjust the emitter properties
+     * emitter.totalParticles = 200;
+     * emitter.minLife = 1000;
+     * emitter.maxLife = 3000;
+     * emitter.z = 10;
+     *
+     * // Add the emitter to the game world
+     * me.game.world.addChild(emitter);
+     *
+     * // Launch all particles one time and stop, like a explosion
+     * emitter.burstParticles();
+     *
+     * // Launch constantly the particles, like a fountain
+     * emitter.streamParticles();
+     *
+     * // At the end, remove emitter from the game world
+     * // call this in onDestroyEvent function
+     * me.game.world.removeChild(emitter);
      */
-    constructor(x: any, y: any, settings: any);
+    constructor(x: number, y: number, settings?: {
+        /**
+         * Width of the particle spawn area.
+         * @type {number}
+         * @name width
+         * @memberof ParticleEmitterSettings
+         * @default 1
+         */
+        width: number;
+        /**
+         * Height of the particle spawn area
+         * @public
+         * @type {number}
+         * @name height
+         * @memberof ParticleEmitterSettings
+         * @default 1
+         */
+        height: number;
+        /**
+         * image used for particles texture
+         * (by default melonJS will create an white 8x8 texture image)
+         * @public
+         * @type {HTMLCanvasElement}
+         * @name image
+         * @memberof ParticleEmitterSettings
+         * @default undefined
+         * @see ParticleEmitterSettings.textureSize
+         */
+        image: HTMLCanvasElement;
+        /**
+         * default texture size used for particles if no image is specified
+         * (by default melonJS will create an white 8x8 texture image)
+         * @public
+         * @type {number}
+         * @name textureSize
+         * @memberof ParticleEmitterSettings
+         * @default 8
+         * @see ParticleEmitterSettings.image
+         */
+        textureSize: number;
+        /**
+         * tint to be applied to particles
+         * @public
+         * @type {string}
+         * @name tint
+         * @memberof ParticleEmitterSettings
+         * @default "#fff"
+         */
+        tint: string;
+        /**
+         * Total number of particles in the emitter
+         * @public
+         * @type {number}
+         * @name totalParticles
+         * @default 50
+         * @memberof ParticleEmitterSettings
+         */
+        totalParticles: number;
+        /**
+         * Start angle for particle launch in Radians
+         * @public
+         * @type {number}
+         * @name angle
+         * @default Math.PI / 2
+         * @memberof ParticleEmitterSettings
+         */
+        angle: number;
+        /**
+         * Variation in the start angle for particle launch in Radians.
+         * @public
+         * @type {number}
+         * @name angleVariation
+         * @default 0
+         * @memberof ParticleEmitterSettings
+         */
+        angleVariation: number;
+        /**
+         * Minimum time each particle lives once it is emitted in ms.
+         * @public
+         * @type {number}
+         * @name minLife
+         * @default 1000
+         * @memberof ParticleEmitterSettings
+         */
+        minLife: number;
+        /**
+         * Maximum time each particle lives once it is emitted in ms.
+         * @public
+         * @type {number}
+         * @name maxLife
+         * @default 3000
+         * @memberof ParticleEmitterSettings
+         */
+        maxLife: number;
+        /**
+         * Start speed of particles.<br>
+         * @public
+         * @type {number}
+         * @name speed
+         * @default 2
+         * @memberof ParticleEmitterSettings
+         */
+        speed: number;
+        /**
+         * Variation in the start speed of particles
+         * @public
+         * @type {number}
+         * @name speedVariation
+         * @default 1
+         * @memberof ParticleEmitterSettings
+         */
+        speedVariation: number;
+        /**
+         * Minimum start rotation for particles sprites in Radians
+         * @public
+         * @type {number}
+         * @name minRotation
+         * @default 0
+         * @memberof ParticleEmitterSettings
+         */
+        minRotation: number;
+        /**
+         * Maximum start rotation for particles sprites in Radians
+         * @public
+         * @type {number}
+         * @name maxRotation
+         * @default 0
+         * @memberof ParticleEmitterSettings
+         */
+        maxRotation: number;
+        /**
+         * Minimum start scale ratio for particles (1 = no scaling)
+         * @public
+         * @type {number}
+         * @name minStartScale
+         * @default 1
+         * @memberof ParticleEmitterSettings
+         */
+        minStartScale: number;
+        /**
+         * Maximum start scale ratio for particles (1 = no scaling)
+         * @public
+         * @type {number}
+         * @name maxStartScale
+         * @default 1
+         * @memberof ParticleEmitterSettings
+         */
+        maxStartScale: number;
+        /**
+         * Minimum end scale ratio for particles
+         * @public
+         * @type {number}
+         * @name minEndScale
+         * @default 0
+         * @memberof ParticleEmitterSettings
+         */
+        minEndScale: number;
+        /**
+         * Maximum end scale ratio for particles
+         * @public
+         * @type {number}
+         * @name maxEndScale
+         * @default 0
+         * @memberof ParticleEmitterSettings
+         */
+        maxEndScale: number;
+        /**
+         * Vertical force (Gravity) for each particle
+         * @public
+         * @type {number}
+         * @name gravity
+         * @default 0
+         * @memberof ParticleEmitterSettings
+         * @see game.world.gravity
+         */
+        gravity: number;
+        /**
+         * Horizontal force (like a Wind) for each particle
+         * @public
+         * @type {number}
+         * @name wind
+         * @default 0
+         * @memberof ParticleEmitterSettings
+         */
+        wind: number;
+        /**
+         * Update the rotation of particle in accordance the particle trajectory.<br>
+         * The particle sprite should aim at zero angle (draw from left to right).<br>
+         * Override the particle minRotation and maxRotation.<br>
+         * @public
+         * @type {boolean}
+         * @name followTrajectory
+         * @default false
+         * @memberof ParticleEmitterSettings
+         */
+        followTrajectory: boolean;
+        /**
+         * Enable the Texture Additive by composite operation ("additive" blendMode)
+         * @public
+         * @type {boolean}
+         * @name textureAdditive
+         * @default false
+         * @memberof ParticleEmitterSettings
+         * @see ParticleEmitterSettings.blendMode
+         */
+        textureAdditive: boolean;
+        /**
+         * the blend mode to be applied when rendering particles.
+         * (note: this will superseed the `textureAdditive` setting if different than "normal")
+         * @public
+         * @type {string}
+         * @name blendMode
+         * @default normal
+         * @memberof ParticleEmitterSettings
+         * @see CanvasRenderer#setBlendMode
+         * @see WebGLRenderer#setBlendMode
+         */
+        blendMode: string;
+        /**
+         * Update particles only in the viewport, remove it when out of viewport.
+         * @public
+         * @type {boolean}
+         * @name onlyInViewport
+         * @default true
+         * @memberof ParticleEmitterSettings
+         */
+        onlyInViewport: boolean;
+        /**
+         * Render particles in screen space.
+         * @public
+         * @type {boolean}
+         * @name floating
+         * @default false
+         * @memberof ParticleEmitterSettings
+         */
+        floating: boolean;
+        /**
+         * Maximum number of particles launched each time in this emitter (used only if emitter is Stream).
+         * @public
+         * @type {number}
+         * @name maxParticles
+         * @default 10
+         * @memberof ParticleEmitterSettings
+         */
+        maxParticles: number;
+        /**
+         * How often a particle is emitted in ms (used only if emitter is a Stream).
+         * @public
+         * @type {number}
+         * @name frequency
+         * @default 100
+         * @memberof ParticleEmitterSettings
+         */
+        frequency: number;
+        /**
+         * Duration that the emitter releases particles in ms (used only if emitter is Stream).
+         * After this period, the emitter stop the launch of particles.
+         * @public
+         * @type {number}
+         * @name duration
+         * @default Infinity
+         * @memberof ParticleEmitterSettings
+         */
+        duration: number;
+        /**
+         * Skip n frames after updating the particle system once.
+         * This can be used to reduce the performance impact of emitters with many particles.
+         * @public
+         * @type {number}
+         * @name framesToSkip
+         * @default 0
+         * @memberof ParticleEmitterSettings
+         */
+        framesToSkip: number;
+    });
     /** @ignore */
     _stream: boolean;
     /** @ignore */
@@ -4127,95 +4397,43 @@ export class ParticleEmitter extends Rect {
     _durationTimer: number;
     /** @ignore */
     _enabled: boolean;
-    alwaysUpdate: boolean;
-    autoSort: boolean;
-    container: ParticleContainer;
-    /**
-     * @ignore
-     */
-    set z(arg: number);
-    /**
-     * @ignore
-     */
-    get z(): number;
-    set floating(arg: boolean);
-    /**
-     * Floating property for particles, value is forwarded to the particle container <br>
-     * @type {boolean}
-     * @name floating
-     * @memberof ParticleEmitter
-     */
-    get floating(): boolean;
-    /**
-     * @ignore
-     */
-    onActivateEvent(): void;
-    /**
-     * @ignore
-     */
-    onDeactivateEvent(): void;
+    _updateCount: number;
+    settings: {};
+    _dt: number;
     /**
-     * @ignore
+     * Reset the emitter with particle emitter settings.
+     * @param {object} settings [optional] object with emitter settings. See {@link ParticleEmitterSettings}
      */
-    destroy(): void;
+    reset(settings?: object): void;
     /**
-     * returns a random point inside the bounds x axis of this emitter
-     * @name getRandomPointX
-     * @memberof ParticleEmitter
-     * @function
+     * returns a random point on the x axis within the bounds of this emitter
      * @returns {number}
      */
     getRandomPointX(): number;
     /**
-     * returns a random point inside the bounds y axis of this emitter
-     * @name getRandomPointY
-     * @memberof ParticleEmitter
-     * @function
+     * returns a random point on the y axis within the bounds this emitter
      * @returns {number}
      */
     getRandomPointY(): number;
-    /**
-     * Reset the emitter with default values.<br>
-     * @function
-     * @param {object} settings [optional] object with emitter settings. See {@link ParticleEmitterSettings}
-     * @name reset
-     * @memberof ParticleEmitter
-     */
-    reset(settings: object): void;
     /** @ignore */
     addParticles(count: any): void;
     /**
-     * Emitter is of type stream and is launching particles <br>
-     * @function
+     * Emitter is of type stream and is launching particles
      * @returns {boolean} Emitter is Stream and is launching particles
-     * @name isRunning
-     * @memberof ParticleEmitter
      */
     isRunning(): boolean;
     /**
-     * Launch particles from emitter constantly <br>
-     * Particles example: Fountains
+     * Launch particles from emitter constantly (e.g. for stream)
      * @param {number} duration [optional] time that the emitter releases particles in ms
-     * @function
-     * @name streamParticles
-     * @memberof ParticleEmitter
      */
     streamParticles(duration: number): void;
-    frequency: any;
     /**
-     * Stop the emitter from generating new particles (used only if emitter is Stream) <br>
-     * @function
-     * @name stopStream
-     * @memberof ParticleEmitter
+     * Stop the emitter from generating new particles (used only if emitter is Stream)
      */
     stopStream(): void;
     /**
-     * Launch all particles from emitter and stop <br>
-     * Particles example: Explosions <br>
+     * Launch all particles from emitter and stop (e.g. for explosion)
      * @param {number} total [optional] number of particles to launch
-     * @function
-     * @name burstParticles
-     * @memberof ParticleEmitter
      */
     burstParticles(total: number): void;
     /**
@@ -4224,32 +4442,35 @@ export class ParticleEmitter extends Rect {
     update(dt: any): boolean;
 }
 export namespace ParticleEmitterSettings {
-    export const width: number;
-    export const height: number;
-    export { pixel as image };
-    export const totalParticles: number;
-    export const angle: number;
-    export const angleVariation: number;
-    export const minLife: number;
-    export const maxLife: number;
-    export const speed: number;
-    export const speedVariation: number;
-    export const minRotation: number;
-    export const maxRotation: number;
-    export const minStartScale: number;
-    export const maxStartScale: number;
-    export const minEndScale: number;
-    export const maxEndScale: number;
-    export const gravity: number;
-    export const wind: number;
-    export const followTrajectory: boolean;
-    export const textureAdditive: boolean;
-    export const onlyInViewport: boolean;
-    export const floating: boolean;
-    export const maxParticles: number;
-    export const frequency: number;
-    export const duration: number;
-    export const framesToSkip: number;
+    const width: number;
+    const height: number;
+    const image: HTMLCanvasElement;
+    const textureSize: number;
+    const tint: string;
+    const totalParticles: number;
+    const angle: number;
+    const angleVariation: number;
+    const minLife: number;
+    const maxLife: number;
+    const speed: number;
+    const speedVariation: number;
+    const minRotation: number;
+    const maxRotation: number;
+    const minStartScale: number;
+    const maxStartScale: number;
+    const minEndScale: number;
+    const maxEndScale: number;
+    const gravity: number;
+    const wind: number;
+    const followTrajectory: boolean;
+    const textureAdditive: boolean;
+    const blendMode: string;
+    const onlyInViewport: boolean;
+    const floating: boolean;
+    const maxParticles: number;
+    const frequency: number;
+    const duration: number;
+    const framesToSkip: number;
 }
 /**
  * @classdesc
@@ -4943,6 +5164,16 @@ export class Rect extends Polygon {
      * @memberof Rect
      */
     public get centerY(): number;
+    /**
+     * center the rectangle position around the given coordinates
+     * @name centerOn
+     * @memberof Rect.prototype
+     * @function
+     * @param {number} x the x coordinate around which to center this rectangle
+     * @param {number} x the y coordinate around which to center this rectangle
+     * @returns {Rect} this rectangle
+     */
+    centerOn(x: number, y: any): Rect;
     /**
      * resize the rectangle
      * @name resize
@@ -8791,7 +9022,7 @@ export class WebGLRenderer extends Renderer {
      * <img src="images/normal-blendmode.png" width="510"/> <br>
      * - "multiply" : the pixels of the top layer are multiplied with the corresponding pixel of the bottom layer. A darker picture is the result. <br>
      * <img src="images/multiply-blendmode.png" width="510"/> <br>
-     * - "lighter" : where both content overlap the color is determined by adding color values. <br>
+     * - "additive or lighter" : where both content overlap the color is determined by adding color values. <br>
      * <img src="images/lighter-blendmode.png" width="510"/> <br>
      * - "screen" : The pixels are inverted, multiplied, and inverted again. A lighter picture is the result (opposite of multiply) <br>
      * <img src="images/screen-blendmode.png" width="510"/> <br>
@@ -8799,7 +9030,7 @@ export class WebGLRenderer extends Renderer {
      * @see https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/globalCompositeOperation
      * @memberof WebGLRenderer.prototype
      * @function
-     * @param {string} [mode="normal"] blend mode : "normal", "multiply", "lighter", "screen"
+     * @param {string} [mode="normal"] blend mode : "normal", "multiply", "lighter", "additive", "screen"
      * @param {WebGLRenderingContext} [gl]
      */
     setBlendMode(mode?: string, gl?: WebGLRenderingContext): void;
@@ -9158,7 +9389,7 @@ declare namespace device$1 {
     namespace turnOnPointerLock { }
     namespace turnOffPointerLock { }
 }
-export var event: Readonly<{
+declare var event$1: Readonly<{
     __proto__: any;
     BOOT: string;
     STATE_PAUSE: string;
@@ -9191,8 +9422,8 @@ export var event: Readonly<{
     WINDOW_ONORIENTATION_CHANGE: string;
     WINDOW_ONSCROLL: string;
     VIEWPORT_ONCHANGE: string;
-    WEBGL_ONCONTEXT_LOST: string;
-    WEBGL_ONCONTEXT_RESTORED: string;
+    ONCONTEXT_LOST: string;
+    ONCONTEXT_RESTORED: string;
     emit: typeof emit;
     on: typeof on;
     once: typeof once;
@@ -11257,31 +11488,6 @@ declare function round(num: number, dec?: number): number;
  * }
  */
 declare function toBeCloseTo(expected: number, actual: number, precision?: number): boolean;
-/**
- * @classdesc
- * Particle Container Object.
- * @class ParticleContainer
- * @augments Container
- * @param {ParticleEmitter} emitter the emitter which owns this container
- */
-declare class ParticleContainer extends Container {
-    /**
-     * @ignore
-     */
-    constructor(emitter: any);
-    _updateCount: number;
-    _dt: number;
-    _emitter: any;
-    /**
-     * @ignore
-     */
-    update(dt: any): boolean;
-    /**
-     * @ignore
-     */
-    draw(renderer: any, rect: any): void;
-}
-declare var pixel: HTMLCanvasElement | OffscreenCanvas;
 /**
  * @classdesc
  * a Vertex Buffer object
@@ -11825,7 +12031,6 @@ declare function releaseAllPointerEvents(region: Rect | Polygon | Line | Ellipse
  * @memberof input
  * @public
  * @function
- * @param {Function} [success] callback if the request is successful
  * @returns {boolean} return true if the request was successfully submitted
  * @example
  * // register on the pointer lock change event
@@ -12217,7 +12422,7 @@ declare function scale(x: number, y: number): void;
  * @name prefixed
  * @function
  * @param {string} name Property name
- * @param {object} [obj=window] Object or element reference to access
+ * @param {object} [obj=globalThis] Object or element reference to access
  * @returns {string} Value of property
  * @memberof utils.agent
  */
@@ -12229,7 +12434,7 @@ declare function prefixed(name: string, obj?: object): string;
  * @function
  * @param {string} name Property name
  * @param {string} value Property value
- * @param {object} [obj=window] Object or element reference to access
+ * @param {object} [obj=globalThis] Object or element reference to access
  * @returns {boolean} true if one of the vendor-prefixed property was found
  * @memberof utils.agent
  */
@@ -12394,4 +12599,4 @@ declare function defer(func: Function, thisArg: object, ...args: any[]): number;
  * @returns {Function} the function that will be throttled
  */
 declare function throttle(fn: Function, delay: number, no_trailing: any): Function;
-export { Bounds$1 as Bounds, math as Math, device$1 as device, pooling as pool, timer$1 as timer };
+export { Bounds$1 as Bounds, math as Math, device$1 as device, event$1 as event, pooling as pool, timer$1 as timer };