melonjs 14.0.2 → 14.1.1

package/dist/melonjs.mjs/particles/emitter.js

@@ -0,0 +1,265 @@
+/*!
+ * melonJS Game Engine - v14.1.1
+ * http://www.melonjs.org
+ * melonjs is licensed under the MIT License.
+ * http://www.opensource.org/licenses/mit-license
+ * @copyright (C) 2011 - 2022 Olivier Biot (AltByte Pte Ltd)
+ */
+import pool from '../system/pooling.js';
+import ParticleEmitterSettings from './settings.js';
+import { randomFloat } from '../math/math.js';
+import Container from '../renderable/container.js';
+
+/**
+ * @ignore
+ */
+function createDefaultParticleTexture(w = 8, h = 8) {
+    var defaultParticleTexture = pool.pull("CanvasTexture", w, h, { offscreenCanvas: true });
+
+    defaultParticleTexture.context.fillStyle = "#fff";
+    defaultParticleTexture.context.fillRect(0, 0, w, h);
+
+    return defaultParticleTexture;
+}
+
+/**
+ * @classdesc
+ * Particle Emitter Object.
+ * @augments Container
+ */
+ class ParticleEmitter extends Container {
+    /**
+     * @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 particle emitter at position 100, 100
+     * var emitter = new ParticleEmitter(100, 100, {
+     *     width: 16,
+     *     height : 16,
+     *     tint: "#f00",
+     *     totalParticles: 32,
+     *     angle: 0,
+     *     angleVariation: 6.283185307179586,
+     *     maxLife: 5,
+     *     speed: 3
+     * });
+     *
+     * // 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, y, settings = {}) {
+        // call the super constructor
+        super(
+            x, y,
+            settings.width | 1,
+            settings.height | 1
+        );
+
+        /**
+         * the current (active) emitter settings
+         * @public
+         * @type {ParticleEmitterSettings}
+         * @name settings
+         * @memberof ParticleEmitter
+         */
+        this.settings = {};
+
+        // center the emitter around the given coordinates
+        this.centerOn(x, y);
+
+        // Emitter is Stream, launch particles constantly
+        /** @ignore */
+        this._stream = false;
+
+        // Frequency timer (in ms) for emitter launch new particles
+        // used only in stream emitter
+        /** @ignore */
+        this._frequencyTimer = 0;
+
+        // Time of live (in ms) for emitter launch new particles
+        // used only in stream emitter
+        /** @ignore */
+        this._durationTimer = 0;
+
+        // Emitter is emitting particles
+        /** @ignore */
+        this._enabled = false;
+
+        // Emitter will always update
+        this.alwaysUpdate = true;
+
+        // don't sort the particles by z-index
+        this.autoSort = false;
+
+        // count the updates
+        this._updateCount = 0;
+
+        // internally store how much time was skipped when frames are skipped
+        this._dt = 0;
+
+        //this.anchorPoint.set(0, 0);
+
+        // Reset the emitter to defaults
+        this.reset(settings);
+    }
+
+    /**
+     * Reset the emitter with particle emitter settings.
+     * @param {ParticleEmitterSettings} settings - [optional] object with emitter settings. See {@link ParticleEmitterSettings}
+     */
+    reset(settings = {}) {
+        Object.assign(this.settings, ParticleEmitterSettings, settings);
+
+        if (typeof this.settings.image === "undefined") {
+            this._defaultParticle = createDefaultParticleTexture(settings.textureSize, settings.textureSize);
+            this.settings.image = this._defaultParticle.canvas;
+        }
+
+        this.floating = this.settings.floating;
+
+        this.isDirty = true;
+    }
+
+    /**
+     * returns a random point on the x axis within the bounds of this emitter
+     * @returns {number}
+     */
+    getRandomPointX() {
+        return randomFloat(0, this.getBounds().width);
+    }
+
+    /**
+     * returns a random point on the y axis within the bounds this emitter
+     * @returns {number}
+     */
+    getRandomPointY() {
+        return randomFloat(0, this.getBounds().height);
+    }
+
+    // Add count particles in the game world
+    /** @ignore */
+    addParticles(count) {
+        for (var i = 0; i < count; i++) {
+            // Add particle to the container
+            this.addChild(pool.pull("Particle", this), this.pos.z);
+        }
+        this.isDirty = true;
+    }
+
+    /**
+     * Emitter is of type stream and is launching particles
+     * @returns {boolean} Emitter is Stream and is launching particles
+     */
+    isRunning() {
+        return this._enabled && this._stream;
+    }
+
+    /**
+     * Launch particles from emitter constantly (e.g. for stream)
+     * @param {number} duration - [optional] time that the emitter releases particles in ms
+     */
+    streamParticles(duration) {
+        this._enabled = true;
+        this._stream = true;
+        this.settings.frequency = Math.max(1, this.settings.frequency);
+        this._durationTimer = (typeof duration === "number") ? duration : this.settings.duration;
+    }
+
+    /**
+     * Stop the emitter from generating new particles (used only if emitter is Stream)
+     */
+    stopStream() {
+        this._enabled = false;
+    }
+
+    /**
+     * Launch all particles from emitter and stop (e.g. for explosion)
+     * @param {number} total - [optional] number of particles to launch
+     */
+    burstParticles(total) {
+        this._enabled = true;
+        this._stream = false;
+        this.addParticles((typeof total === "number") ? total : this.settings.totalParticles);
+        this._enabled = false;
+    }
+
+    /**
+     * @ignore
+     */
+    update(dt) {
+        // skip frames if necessary
+        if (++this._updateCount > this.settings.framesToSkip) {
+            this._updateCount = 0;
+        }
+        if (this._updateCount > 0) {
+            this._dt += dt;
+            return this.isDirty;
+        }
+
+        // apply skipped delta time
+        dt += this._dt;
+        this._dt = 0;
+
+        // Update particles
+        this.isDirty |= super.update(dt);
+
+        // Launch new particles, if emitter is Stream
+        if ((this._enabled) && (this._stream)) {
+            // Check if the emitter has duration set
+            if (this._durationTimer !== Infinity) {
+                this._durationTimer -= dt;
+
+                if (this._durationTimer <= 0) {
+                    this.stopStream();
+                    return this.isDirty;
+                }
+            }
+
+            // Increase the emitter launcher timer
+            this._frequencyTimer += dt;
+
+            // Check for new particles launch
+            var particlesCount = this.children.length;
+            if ((particlesCount < this.settings.totalParticles) && (this._frequencyTimer >= this.settings.frequency)) {
+                if ((particlesCount + this.settings.maxParticles) <= this.settings.totalParticles) {
+                    this.addParticles(this.settings.maxParticles);
+                }
+                else {
+                    this.addParticles(this.settings.totalParticles - particlesCount);
+                }
+                this._frequencyTimer = 0;
+                this.isDirty = true;
+            }
+        }
+        return this.isDirty;
+    }
+
+    /**
+     * Destroy function
+     * @ignore
+     */
+    destroy() {
+        // call the parent destroy method
+        super.destroy(arguments);
+        // clean emitter specific Properties
+        if (typeof this._defaultParticle !== "undefined") {
+            pool.push(this._defaultParticle);
+            this._defaultParticle = undefined;
+        }
+        this.settings.image = undefined;
+        this.settings = undefined;
+    }
+}
+
+export { ParticleEmitter as default };

package/dist/melonjs.mjs/particles/particle.js

@@ -0,0 +1,186 @@
+/*!
+ * melonJS Game Engine - v14.1.1
+ * http://www.melonjs.org
+ * melonjs is licensed under the MIT License.
+ * http://www.opensource.org/licenses/mit-license
+ * @copyright (C) 2011 - 2022 Olivier Biot (AltByte Pte Ltd)
+ */
+import pool from '../system/pooling.js';
+import timer from '../system/timer.js';
+import { randomFloat, clamp } from '../math/math.js';
+import Renderable from '../renderable/renderable.js';
+
+/**
+ * @classdesc
+ * Single Particle Object.
+ * @augments Renderable
+ */
+ class Particle extends Renderable {
+    /**
+     * @param {ParticleEmitter} emitter - the particle emitter
+     */
+    constructor(emitter) {
+        // Call the super constructor
+        super(
+            emitter.getRandomPointX(),
+            emitter.getRandomPointY(),
+            emitter.settings.image.width,
+            emitter.settings.image.height
+        );
+        this.onResetEvent(emitter, true);
+    }
+
+    /**
+     * @ignore
+     */
+    onResetEvent(emitter, newInstance = false) {
+        if (newInstance === false) {
+            this.pos.set(
+                emitter.getRandomPointX(),
+                emitter.getRandomPointY()
+            );
+            this.resize(
+                emitter.settings.image.width,
+                emitter.settings.image.height
+            );
+            this.currentTransform.identity();
+        } else {
+            // particle velocity
+            this.vel = pool.pull("Vector2d");
+        }
+
+        this.image = emitter.settings.image;
+
+        // Particle will always update
+        this.alwaysUpdate = true;
+
+        if (typeof emitter.settings.tint === "string") {
+            this.tint.parseCSS(emitter.settings.tint);
+        }
+
+        if (emitter.settings.textureAdditive === true) {
+            this.blendMode = "additive";
+        }
+
+        if (emitter.settings.blendMode !== "normal") {
+            this.blendMode = emitter.settings.blendMode;
+        }
+
+        // Set the start particle Angle and Speed as defined in emitter
+        var angle = emitter.settings.angle + ((emitter.settings.angleVariation > 0) ? (randomFloat(0, 2) - 1) * emitter.settings.angleVariation : 0);
+        var speed = emitter.settings.speed + ((emitter.settings.speedVariation > 0) ? (randomFloat(0, 2) - 1) * emitter.settings.speedVariation : 0);
+
+        // Set the start particle Velocity
+        this.vel.set(speed * Math.cos(angle), -speed * Math.sin(angle));
+
+        // Set the start particle Time of Life as defined in emitter
+        this.life = randomFloat(emitter.settings.minLife, emitter.settings.maxLife);
+        this.startLife = this.life;
+
+        // Set the start and end particle Scale as defined in emitter
+        // clamp the values as minimum and maximum scales range
+        this.startScale = clamp(
+            randomFloat(emitter.settings.minStartScale, emitter.settings.maxStartScale),
+            emitter.settings.minStartScale,
+            emitter.settings.maxStartScale
+        );
+        this.endScale = clamp(
+            randomFloat(emitter.settings.minEndScale, emitter.settings.maxEndScale),
+            emitter.settings.minEndScale,
+            emitter.settings.maxEndScale
+        );
+
+        // Set the particle Gravity and Wind (horizontal gravity) as defined in emitter
+        this.gravity = emitter.settings.gravity;
+        this.wind = emitter.settings.wind;
+
+        // Set if the particle update the rotation in accordance the trajectory
+        this.followTrajectory = emitter.settings.followTrajectory;
+
+        // Set if the particle update only in Viewport
+        this.onlyInViewport = emitter.settings.onlyInViewport;
+
+        // cache inverse of the expected delta time
+        this._deltaInv = timer.maxfps / 1000;
+
+        // Set the start particle rotation as defined in emitter
+        // if the particle not follow trajectory
+        if (!emitter.settings.followTrajectory) {
+            this.angle = randomFloat(emitter.settings.minRotation, emitter.settings.maxRotation);
+        }
+    }
+
+    /**
+     * Update the Particle <br>
+     * This is automatically called by the game manager {@link game}
+     * @ignore
+     * @param {number} dt - time since the last update in milliseconds
+     */
+    update(dt) {
+        // move things forward independent of the current frame rate
+        var skew = dt * this._deltaInv;
+
+        // Decrease particle life
+        this.life = this.life > dt ? this.life - dt : 0;
+
+        if (this.life <= 0) {
+            this.ancestor.removeChild(this);
+            return false;
+        }
+
+        // Calculate the particle Age Ratio
+        var ageRatio = this.life / this.startLife;
+
+        // Resize the particle as particle Age Ratio
+        var scale = this.startScale;
+        if (this.startScale > this.endScale) {
+            scale *= ageRatio;
+            scale = (scale < this.endScale) ? this.endScale : scale;
+        }
+        else if (this.startScale < this.endScale) {
+            scale /= ageRatio;
+            scale = (scale > this.endScale) ? this.endScale : scale;
+        }
+
+        // Set the particle opacity as Age Ratio
+        this.alpha = ageRatio;
+
+        // Adjust the particle velocity
+        this.vel.x += this.wind * skew;
+        this.vel.y += this.gravity * skew;
+
+        // If necessary update the rotation of particle in accordance the particle trajectory
+        var angle = this.followTrajectory ? Math.atan2(this.vel.y, this.vel.x) : this.angle;
+
+        this.pos.x += this.vel.x * skew;
+        this.pos.y += this.vel.y * skew;
+
+        // Update particle transform
+        this.currentTransform.setTransform(
+            scale, 0, 0,
+            0, scale, 0,
+            this.pos.x, this.pos.y, 1
+        ).rotate(angle);
+
+        // mark as dirty if the particle is not dead yet
+        this.isDirty = this.inViewport || !this.onlyInViewport;
+
+        return super.update(dt);
+    }
+
+    /**
+     * @ignore
+     */
+    draw(renderer) {
+        var w = this.width, h = this.height;
+        renderer.drawImage(
+            this.image,
+            0, 0,
+            w, h,
+            -w / 2, -h / 2,
+            w, h
+        );
+    }
+}
+
+export { Particle as default };