custom-pixi-particles 4.0.20 → 4.0.22

package/dist/lib/emission/RandomEmission.js

@@ -1,14 +1,33 @@
 import { AbstractEmission, EmissionTypes } from './index';
 import { Random } from '../util';
+/**
+ * RandomEmission class to generate random particles
+ * @extends AbstractEmission
+ */
 export default class RandomEmission extends AbstractEmission {
     constructor() {
         super(...arguments);
+        /**
+         * Maximum number of particles
+         */
         this._maxParticles = 0;
+        /**
+         * Emission rate
+         */
         this._emissionRate = 0;
+        /**
+         * Gets the name of the emission type
+         * @returns {string} Emission type
+         */
         this.getName = () => {
             return EmissionTypes.RANDOM;
         };
     }
+    /**
+     * Calculates how many particles to emit
+     * @param {number} deltaTime - how much time is passed
+     * @param {number} particlesCount - current number of particles
+     */
     howMany(deltaTime, particlesCount) {
         if (particlesCount < this.maxParticles) {
             const count = Math.round(Random.uniform(0, Math.ceil(this.emissionRate * deltaTime)));
@@ -17,15 +36,29 @@ export default class RandomEmission extends AbstractEmission {
         }
         return 0;
     }
+    /**
+     * Gets the emission rate
+     */
     get emissionRate() {
         return this._emissionRate;
     }
+    /**
+     * Sets the emission rate
+     * @param {number} value - the emission rate to set
+     */
     set emissionRate(value) {
         this._emissionRate = Math.max(0, value);
     }
+    /**
+     * Gets the maximum number of particles
+     */
     get maxParticles() {
         return this._maxParticles;
     }
+    /**
+     * Sets the maximum number of particles
+     * @param {number} value - the maximum number of particles to set
+     */
     set maxParticles(value) {
         this._maxParticles = Math.max(0, value);
     }

package/dist/lib/emission/RandomEmission.js.map

@@ -1 +1 @@
-{"version":3,"file":"RandomEmission.js","sourceRoot":"","sources":["../../../src/lib/emission/RandomEmission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAEhC,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,gBAAgB;IAA5D;;QACE,kBAAa,GAAG,CAAC,CAAA;QACjB,kBAAa,GAAG,CAAC,CAAA;QA4BjB,YAAO,GAAG,GAAG,EAAE;YACb,OAAO,aAAa,CAAC,MAAM,CAAA;QAC7B,CAAC,CAAA;IACH,CAAC;IA7BC,OAAO,CAAC,SAAiB,EAAE,cAAsB;QAC/C,IAAI,cAAc,GAAG,IAAI,CAAC,YAAY,EAAE;YACtC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA;YACrF,MAAM,KAAK,GAAG,cAAc,GAAG,KAAK,CAAA;YACpC,OAAO,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,GAAG,cAAc,CAAC,CAAC,CAAC,KAAK,CAAA;SAC/E;QAED,OAAO,CAAC,CAAA;IACV,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,aAAa,CAAA;IAC3B,CAAC;IAED,IAAI,YAAY,CAAC,KAAa;QAC5B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;IACzC,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,aAAa,CAAA;IAC3B,CAAC;IAED,IAAI,YAAY,CAAC,KAAa;QAC5B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;IACzC,CAAC;CAKF"}
+{"version":3,"file":"RandomEmission.js","sourceRoot":"","sources":["../../../src/lib/emission/RandomEmission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAEhC;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,gBAAgB;IAA5D;;QACE;;WAEG;QACH,kBAAa,GAAG,CAAC,CAAA;QAEjB;;WAEG;QACH,kBAAa,GAAG,CAAC,CAAA;QA+CjB;;;WAGG;QACH,YAAO,GAAG,GAAG,EAAE;YACb,OAAO,aAAa,CAAC,MAAM,CAAA;QAC7B,CAAC,CAAA;IACH,CAAC;IApDC;;;;OAIG;IACH,OAAO,CAAC,SAAiB,EAAE,cAAsB;QAC/C,IAAI,cAAc,GAAG,IAAI,CAAC,YAAY,EAAE;YACtC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA;YACrF,MAAM,KAAK,GAAG,cAAc,GAAG,KAAK,CAAA;YACpC,OAAO,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,GAAG,cAAc,CAAC,CAAC,CAAC,KAAK,CAAA;SAC/E;QAED,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;OAEG;IACH,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,aAAa,CAAA;IAC3B,CAAC;IAED;;;OAGG;IACH,IAAI,YAAY,CAAC,KAAa;QAC5B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;IACzC,CAAC;IAED;;OAEG;IACH,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,aAAa,CAAA;IAC3B,CAAC;IAED;;;OAGG;IACH,IAAI,YAAY,CAAC,KAAa;QAC5B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;IACzC,CAAC;CASF"}

package/dist/lib/emission/StandardEmission.d.ts

@@ -1,12 +1,61 @@
 import { AbstractEmission } from './index';
+/**
+ * The StandardEmission class is an abstract class extending from AbstractEmission.
+ *
+ * It provides methods for calculating the number of particles emitted in an interval of time and setting/getting the emission rate and maximum number of particles.
+ *
+ * @abstract
+ */
 export default class StandardEmission extends AbstractEmission {
+    /**
+     * The maxParticles field stores the maximum number of particles allowed to be emitted.
+     * @private
+     * @type {number}
+     */
     _maxParticles: number;
+    /**
+     * The emissionRate field stores the current rate of emission.
+     * @private
+     * @type {number}
+     */
     _emissionRate: number;
+    /**
+     * The emitCounter field stores the counter for emission rate.
+     * @private
+     * @type {number}
+     */
     _emitCounter: number;
+    /**
+     * howMany() calculates how many particles should be emitted in the given interval of time.
+     *
+     * @param {number} deltaTime - The amount of time elapsed since the last emission.
+     * @param {number} particlesCount - The current number of particles.
+     * @return {number} - The number of particles to be emitted.
+     */
     howMany(deltaTime: number, particlesCount: number): number;
+    /**
+     * Getter for the emissionRate field.
+     * @return {number} - The current emission rate.
+     */
     get emissionRate(): number;
+    /**
+     * Setter for the emissionRate field.
+     * @param {number} value - The new emission rate.
+     */
     set emissionRate(value: number);
+    /**
+     * Getter for the maxParticles field.
+     * @return {number} - The maximum number of particles allowed to be emitted.
+     */
     get maxParticles(): number;
+    /**
+     * Setter for the maxParticles field.
+     * @param {number} value - The new maximum number of particles allowed to be emitted.
+     */
     set maxParticles(value: number);
+    /**
+     * GetName() returns the type of the emission.
+     * @return {EmissionTypes} - The type of the emission.
+     */
     getName: () => string;
 }

package/dist/lib/emission/StandardEmission.js

@@ -1,14 +1,47 @@
 import { AbstractEmission, EmissionTypes } from './index';
+/**
+ * The StandardEmission class is an abstract class extending from AbstractEmission.
+ *
+ * It provides methods for calculating the number of particles emitted in an interval of time and setting/getting the emission rate and maximum number of particles.
+ *
+ * @abstract
+ */
 export default class StandardEmission extends AbstractEmission {
     constructor() {
         super(...arguments);
+        /**
+         * The maxParticles field stores the maximum number of particles allowed to be emitted.
+         * @private
+         * @type {number}
+         */
         this._maxParticles = 0;
+        /**
+         * The emissionRate field stores the current rate of emission.
+         * @private
+         * @type {number}
+         */
         this._emissionRate = 0;
+        /**
+         * The emitCounter field stores the counter for emission rate.
+         * @private
+         * @type {number}
+         */
         this._emitCounter = 0;
+        /**
+         * GetName() returns the type of the emission.
+         * @return {EmissionTypes} - The type of the emission.
+         */
         this.getName = () => {
             return EmissionTypes.UNIFORM;
         };
     }
+    /**
+     * howMany() calculates how many particles should be emitted in the given interval of time.
+     *
+     * @param {number} deltaTime - The amount of time elapsed since the last emission.
+     * @param {number} particlesCount - The current number of particles.
+     * @return {number} - The number of particles to be emitted.
+     */
     howMany(deltaTime, particlesCount) {
         const rate = 1.0 / this.emissionRate;
         let count = 0;
@@ -21,15 +54,31 @@ export default class StandardEmission extends AbstractEmission {
         }
         return count;
     }
+    /**
+     * Getter for the emissionRate field.
+     * @return {number} - The current emission rate.
+     */
     get emissionRate() {
         return this._emissionRate;
     }
+    /**
+     * Setter for the emissionRate field.
+     * @param {number} value - The new emission rate.
+     */
     set emissionRate(value) {
         this._emissionRate = Math.max(0, value);
     }
+    /**
+     * Getter for the maxParticles field.
+     * @return {number} - The maximum number of particles allowed to be emitted.
+     */
     get maxParticles() {
         return this._maxParticles;
     }
+    /**
+     * Setter for the maxParticles field.
+     * @param {number} value - The new maximum number of particles allowed to be emitted.
+     */
     set maxParticles(value) {
         this._maxParticles = Math.max(0, value);
     }

package/dist/lib/emission/StandardEmission.js.map

@@ -1 +1 @@
-{"version":3,"file":"StandardEmission.js","sourceRoot":"","sources":["../../../src/lib/emission/StandardEmission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAEzD,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,gBAAgB;IAA9D;;QACE,kBAAa,GAAG,CAAC,CAAA;QACjB,kBAAa,GAAG,CAAC,CAAA;QACjB,iBAAY,GAAG,CAAC,CAAA;QAiChB,YAAO,GAAG,GAAG,EAAE;YACb,OAAO,aAAa,CAAC,OAAO,CAAA;QAC9B,CAAC,CAAA;IACH,CAAC;IAlCC,OAAO,CAAC,SAAiB,EAAE,cAAsB;QAC/C,MAAM,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,YAAY,CAAA;QACpC,IAAI,KAAK,GAAG,CAAC,CAAA;QACb,IAAI,cAAc,GAAG,IAAI,CAAC,YAAY,EAAE;YACtC,IAAI,CAAC,YAAY,IAAI,SAAS,CAAA;SAC/B;QAED,OAAO,cAAc,GAAG,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,GAAG,IAAI,EAAE;YACrE,KAAK,EAAE,CAAA;YACP,IAAI,CAAC,YAAY,IAAI,IAAI,CAAA;SAC1B;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,aAAa,CAAA;IAC3B,CAAC;IAED,IAAI,YAAY,CAAC,KAAa;QAC5B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;IACzC,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,aAAa,CAAA;IAC3B,CAAC;IAED,IAAI,YAAY,CAAC,KAAa;QAC5B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;IACzC,CAAC;CAKF"}
+{"version":3,"file":"StandardEmission.js","sourceRoot":"","sources":["../../../src/lib/emission/StandardEmission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAEzD;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,gBAAgB;IAA9D;;QACE;;;;WAIG;QACH,kBAAa,GAAG,CAAC,CAAA;QAEjB;;;;WAIG;QACH,kBAAa,GAAG,CAAC,CAAA;QAEjB;;;;WAIG;QACH,iBAAY,GAAG,CAAC,CAAA;QAwDhB;;;WAGG;QACH,YAAO,GAAG,GAAG,EAAE;YACb,OAAO,aAAa,CAAC,OAAO,CAAA;QAC9B,CAAC,CAAA;IACH,CAAC;IA7DC;;;;;;OAMG;IACH,OAAO,CAAC,SAAiB,EAAE,cAAsB;QAC/C,MAAM,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,YAAY,CAAA;QACpC,IAAI,KAAK,GAAG,CAAC,CAAA;QACb,IAAI,cAAc,GAAG,IAAI,CAAC,YAAY,EAAE;YACtC,IAAI,CAAC,YAAY,IAAI,SAAS,CAAA;SAC/B;QAED,OAAO,cAAc,GAAG,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,GAAG,IAAI,EAAE;YACrE,KAAK,EAAE,CAAA;YACP,IAAI,CAAC,YAAY,IAAI,IAAI,CAAA;SAC1B;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;OAGG;IACH,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,aAAa,CAAA;IAC3B,CAAC;IAED;;;OAGG;IACH,IAAI,YAAY,CAAC,KAAa;QAC5B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;IACzC,CAAC;IAED;;;OAGG;IACH,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,aAAa,CAAA;IAC3B,CAAC;IAED;;;OAGG;IACH,IAAI,YAAY,CAAC,KAAa;QAC5B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;IACzC,CAAC;CASF"}

package/dist/lib/emission/UniformEmission.d.ts

@@ -1,14 +1,56 @@
 import { AbstractEmission } from './index';
+/**
+ * UniformEmission class is the implementation of the abstract class AbstractEmission.
+ * It implements the method howMany and has other methods to set and get the related data.
+ *
+ * @class UniformEmission
+ * @extends AbstractEmission
+ */
 export default class UniformEmission extends AbstractEmission {
     _maxParticles: number;
     _maxLife: number;
     _emitPerSecond: number;
     _frames: number;
+    /**
+     * Calculates the number of particles to emit.
+     *
+     * @param {number} deltaTime - The elapsed time between frames.
+     * @param {number} particlesCount - The current number of particles on the screen.
+     * @returns {number} The number of particles to emit in the current frame.
+     */
     howMany(deltaTime: number, particlesCount: number): number;
+    /**
+     * Recalculates the emitPerSecond value based on the maxParticles and maxLife values.
+     */
     refresh(): void;
+    /**
+     * Sets the maxLife value and calls refresh() to recalculate the emitPerSecond.
+     *
+     * @param {number} value - The new maxLife value.
+     */
     set maxLife(value: number);
+    /**
+     * Sets the maxParticles value and calls refresh() to recalculate the emitPerSecond.
+     *
+     * @param {number} value - The new maxParticles value.
+     */
     set maxParticles(value: number);
+    /**
+     * Returns the emitPerSecond value.
+     *
+     * @returns {number} The emitPerSecond value.
+     */
     get emitPerSecond(): number;
+    /**
+     * Sets the emitPerSecond value.
+     *
+     * @param {number} value - The new emitPerSecond value.
+     */
     set emitPerSecond(value: number);
+    /**
+     * Returns EmissionTypes.DEFAULT.
+     *
+     * @returns {string} EmissionTypes.DEFAULT.
+     */
     getName: () => string;
 }

package/dist/lib/emission/UniformEmission.js

@@ -1,4 +1,11 @@
 import { AbstractEmission, EmissionTypes } from './index';
+/**
+ * UniformEmission class is the implementation of the abstract class AbstractEmission.
+ * It implements the method howMany and has other methods to set and get the related data.
+ *
+ * @class UniformEmission
+ * @extends AbstractEmission
+ */
 export default class UniformEmission extends AbstractEmission {
     constructor() {
         super(...arguments);
@@ -6,10 +13,22 @@ export default class UniformEmission extends AbstractEmission {
         this._maxLife = 1;
         this._emitPerSecond = 0;
         this._frames = 0;
+        /**
+         * Returns EmissionTypes.DEFAULT.
+         *
+         * @returns {string} EmissionTypes.DEFAULT.
+         */
         this.getName = () => {
             return EmissionTypes.DEFAULT;
         };
     }
+    /**
+     * Calculates the number of particles to emit.
+     *
+     * @param {number} deltaTime - The elapsed time between frames.
+     * @param {number} particlesCount - The current number of particles on the screen.
+     * @returns {number} The number of particles to emit in the current frame.
+     */
     howMany(deltaTime, particlesCount) {
         const ratio = this._emitPerSecond * deltaTime;
         this._frames += ratio;
@@ -20,20 +39,43 @@ export default class UniformEmission extends AbstractEmission {
         }
         return numberToEmit;
     }
+    /**
+     * Recalculates the emitPerSecond value based on the maxParticles and maxLife values.
+     */
     refresh() {
         this.emitPerSecond = this._maxParticles / this._maxLife;
     }
+    /**
+     * Sets the maxLife value and calls refresh() to recalculate the emitPerSecond.
+     *
+     * @param {number} value - The new maxLife value.
+     */
     set maxLife(value) {
         this._maxLife = Math.max(value, 1);
         this.refresh();
     }
+    /**
+     * Sets the maxParticles value and calls refresh() to recalculate the emitPerSecond.
+     *
+     * @param {number} value - The new maxParticles value.
+     */
     set maxParticles(value) {
         this._maxParticles = Math.max(value, 0);
         this.refresh();
     }
+    /**
+     * Returns the emitPerSecond value.
+     *
+     * @returns {number} The emitPerSecond value.
+     */
     get emitPerSecond() {
         return this._emitPerSecond;
     }
+    /**
+     * Sets the emitPerSecond value.
+     *
+     * @param {number} value - The new emitPerSecond value.
+     */
     set emitPerSecond(value) {
         this._emitPerSecond = Math.max(value, 0);
     }

package/dist/lib/emission/UniformEmission.js.map

@@ -1 +1 @@
-{"version":3,"file":"UniformEmission.js","sourceRoot":"","sources":["../../../src/lib/emission/UniformEmission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAEzD,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,gBAAgB;IAA7D;;QACE,kBAAa,GAAG,CAAC,CAAA;QACjB,aAAQ,GAAG,CAAC,CAAA;QACZ,mBAAc,GAAG,CAAC,CAAA;QAClB,YAAO,GAAG,CAAC,CAAA;QAqCX,YAAO,GAAG,GAAG,EAAE;YACb,OAAO,aAAa,CAAC,OAAO,CAAA;QAC9B,CAAC,CAAA;IACH,CAAC;IAtCC,OAAO,CAAC,SAAiB,EAAE,cAAsB;QAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,GAAG,SAAS,CAAA;QAC7C,IAAI,CAAC,OAAO,IAAI,KAAK,CAAA;QAErB,IAAI,YAAY,GAAG,CAAC,CAAA;QACpB,IAAI,IAAI,CAAC,OAAO,IAAI,GAAG,EAAE;YACvB,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YACvC,IAAI,CAAC,OAAO,GAAG,CAAC,CAAA;SACjB;QAED,OAAO,YAAY,CAAA;IACrB,CAAC;IAED,OAAO;QACL,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAA;IACzD,CAAC;IAED,IAAI,OAAO,CAAC,KAAa;QACvB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;QAClC,IAAI,CAAC,OAAO,EAAE,CAAA;IAChB,CAAC;IAED,IAAI,YAAY,CAAC,KAAa;QAC5B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;QACvC,IAAI,CAAC,OAAO,EAAE,CAAA;IAChB,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,cAAc,CAAA;IAC5B,CAAC;IAED,IAAI,aAAa,CAAC,KAAa;QAC7B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;IAC1C,CAAC;CAKF"}
+{"version":3,"file":"UniformEmission.js","sourceRoot":"","sources":["../../../src/lib/emission/UniformEmission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAEzD;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,gBAAgB;IAA7D;;QACE,kBAAa,GAAG,CAAC,CAAA;QACjB,aAAQ,GAAG,CAAC,CAAA;QACZ,mBAAc,GAAG,CAAC,CAAA;QAClB,YAAO,GAAG,CAAC,CAAA;QAmEX;;;;WAIG;QACH,YAAO,GAAG,GAAG,EAAE;YACb,OAAO,aAAa,CAAC,OAAO,CAAA;QAC9B,CAAC,CAAA;IACH,CAAC;IAzEC;;;;;;OAMG;IACH,OAAO,CAAC,SAAiB,EAAE,cAAsB;QAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,GAAG,SAAS,CAAA;QAC7C,IAAI,CAAC,OAAO,IAAI,KAAK,CAAA;QAErB,IAAI,YAAY,GAAG,CAAC,CAAA;QACpB,IAAI,IAAI,CAAC,OAAO,IAAI,GAAG,EAAE;YACvB,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YACvC,IAAI,CAAC,OAAO,GAAG,CAAC,CAAA;SACjB;QAED,OAAO,YAAY,CAAA;IACrB,CAAC;IAED;;OAEG;IACH,OAAO;QACL,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAA;IACzD,CAAC;IAED;;;;OAIG;IACH,IAAI,OAAO,CAAC,KAAa;QACvB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;QAClC,IAAI,CAAC,OAAO,EAAE,CAAA;IAChB,CAAC;IAED;;;;OAIG;IACH,IAAI,YAAY,CAAC,KAAa;QAC5B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;QACvC,IAAI,CAAC,OAAO,EAAE,CAAA;IAChB,CAAC;IAED;;;;OAIG;IACH,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,cAAc,CAAA;IAC5B,CAAC;IAED;;;;OAIG;IACH,IAAI,aAAa,CAAC,KAAa;QAC7B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;IAC1C,CAAC;CAUF"}

package/dist/lib/emitter/Duration.d.ts

@@ -2,9 +2,26 @@ export default class Duration {
     maxTime: number;
     private _stop;
     private _elapsedTime;
+    /**
+     * Checks if the time has elapsed.
+     * @returns {boolean} Returns true if the time is elapsed, false otherwise.
+     */
     isTimeElapsed: () => boolean;
+    /**
+     * Updates the elapsed time.
+     * @param {number} deltaTime - The amount of time that has passed since the last update.
+     */
     update: (deltaTime: number) => void;
+    /**
+     * Resets the elapsed time.
+     */
     reset: () => void;
+    /**
+     * Stops the elapsed time.
+     */
     stop: () => void;
+    /**
+     * Starts the elapsed time.
+     */
     start: () => void;
 }

package/dist/lib/emitter/Duration.js

@@ -3,19 +3,36 @@ export default class Duration {
         this.maxTime = -1;
         this._stop = false;
         this._elapsedTime = 0;
+        /**
+         * Checks if the time has elapsed.
+         * @returns {boolean} Returns true if the time is elapsed, false otherwise.
+         */
         this.isTimeElapsed = () => {
             return this._stop || (this.maxTime > 0 && this._elapsedTime >= this.maxTime);
         };
+        /**
+         * Updates the elapsed time.
+         * @param {number} deltaTime - The amount of time that has passed since the last update.
+         */
         this.update = (deltaTime) => {
             this._elapsedTime += deltaTime;
         };
+        /**
+         * Resets the elapsed time.
+         */
         this.reset = () => {
             this._stop = false;
             this._elapsedTime = 0;
         };
+        /**
+         * Stops the elapsed time.
+         */
         this.stop = () => {
             this._stop = true;
         };
+        /**
+         * Starts the elapsed time.
+         */
         this.start = () => {
             this._stop = false;
         };

package/dist/lib/emitter/Duration.js.map

@@ -1 +1 @@
-{"version":3,"file":"Duration.js","sourceRoot":"","sources":["../../../src/lib/emitter/Duration.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,QAAQ;IAA7B;QACE,YAAO,GAAW,CAAC,CAAC,CAAA;QACZ,UAAK,GAAY,KAAK,CAAA;QACtB,iBAAY,GAAW,CAAC,CAAA;QAEhC,kBAAa,GAAG,GAAG,EAAE;YACnB,OAAO,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,OAAO,CAAC,CAAA;QAC9E,CAAC,CAAA;QAED,WAAM,GAAG,CAAC,SAAiB,EAAE,EAAE;YAC7B,IAAI,CAAC,YAAY,IAAI,SAAS,CAAA;QAChC,CAAC,CAAA;QAED,UAAK,GAAG,GAAG,EAAE;YACX,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;YAClB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAA;QACvB,CAAC,CAAA;QAED,SAAI,GAAG,GAAG,EAAE;YACV,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACnB,CAAC,CAAA;QAED,UAAK,GAAG,GAAG,EAAE;YACX,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QACpB,CAAC,CAAA;IACH,CAAC;CAAA"}
+{"version":3,"file":"Duration.js","sourceRoot":"","sources":["../../../src/lib/emitter/Duration.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,QAAQ;IAA7B;QACE,YAAO,GAAW,CAAC,CAAC,CAAA;QACZ,UAAK,GAAY,KAAK,CAAA;QACtB,iBAAY,GAAW,CAAC,CAAA;QAEhC;;;WAGG;QACH,kBAAa,GAAG,GAAG,EAAE;YACnB,OAAO,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,OAAO,CAAC,CAAA;QAC9E,CAAC,CAAA;QAED;;;WAGG;QACH,WAAM,GAAG,CAAC,SAAiB,EAAE,EAAE;YAC7B,IAAI,CAAC,YAAY,IAAI,SAAS,CAAA;QAChC,CAAC,CAAA;QAED;;WAEG;QACH,UAAK,GAAG,GAAG,EAAE;YACX,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;YAClB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAA;QACvB,CAAC,CAAA;QAED;;WAEG;QACH,SAAI,GAAG,GAAG,EAAE;YACV,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACnB,CAAC,CAAA;QAED;;WAEG;QACH,UAAK,GAAG,GAAG,EAAE;YACX,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QACpB,CAAC,CAAA;IACH,CAAC;CAAA"}

package/dist/lib/emitter/Emitter.d.ts

@@ -33,20 +33,80 @@ export default class Emitter extends eventemitter3 {
     private _play;
     private _model;
     constructor(model: Model);
+    /**
+     * Updates the emitter, emits particles and updates the particles.
+     * Triggers the COMPLETE event when the duration is elapsed and the list is empty.
+     * @param {number} deltaTime - Time elapsed since the last update
+     */
     update(deltaTime: number): Promise<void>;
+    /**
+     * Emits particles if the duration is not elapsed.
+     * @param {number} deltaTime - Time elapsed since the last update
+     */
     emitParticles(deltaTime: number): void;
+    /**
+     * Creates the particles to be emitted.
+     * Triggers the CREATE event when a particle is created.
+     * @param {number} deltaTime - Time elapsed since the last update
+     */
     createParticles(deltaTime: number): void;
+    /**
+     * Updates the list of particles
+     * @param {number} deltaTime - The amount of time that has passed since the last update
+     */
     updateParticles(deltaTime: number): void;
+    /**
+     * Updates a single particle
+     * @param {Particle} particle - The particle to update
+     * @param {number} deltaTime - The amount of time that has passed since the last update
+     */
     updateParticle(particle: Particle, deltaTime: number): void;
+    /**
+     * Removes a particle from the list and reset it
+     * @param {Particle} particle - The particle to remove
+     */
     removeParticle(particle: Particle): void;
+    /**
+     * Gets a parser to parse the emitter and it's particles
+     * @returns {EmitterParser} - The parser for this emitter
+     */
     getParser(): EmitterParser;
+    /**
+     * Creates props for a behaviour
+     * @param {string} name - The name of the behaviour
+     * @returns {Object} - The props for the behaviour
+     */
     createBehaviourProps(name: string): any;
+    /**
+     * Starts the emitter playing
+     */
     play(): void;
+    /**
+     * Resets the emitter and starts playing
+     */
     resetAndPlay(): void;
+    /**
+     * Resets the emitter without removing the particles and starts playing
+     */
     resetWithoutRemovingAndPlay(): void;
+    /**
+     * Resets the emitter and removes all the particles
+     */
     reset(): void;
+    /**
+     * Resets the emitter without removing the particles
+     */
     resetWithoutRemoving(): void;
+    /**
+     * Stops the emitter and removes all the particles
+     */
     stop(): void;
+    /**
+     * Stops the emitter without killing the particles
+     */
     stopWithoutKilling(): void;
+    /**
+     * Removes all the particles from the list
+     */
     removeParticles(): void;
 }

package/dist/lib/emitter/Emitter.js

@@ -29,6 +29,11 @@ export default class Emitter extends eventemitter3 {
         // @ts-ignore
         this.emitController = new emission[emission.EmissionTypes.DEFAULT]();
     }
+    /**
+     * Updates the emitter, emits particles and updates the particles.
+     * Triggers the COMPLETE event when the duration is elapsed and the list is empty.
+     * @param {number} deltaTime - Time elapsed since the last update
+     */
     update(deltaTime) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!this._play)
@@ -44,11 +49,20 @@ export default class Emitter extends eventemitter3 {
             }
         });
     }
+    /**
+     * Emits particles if the duration is not elapsed.
+     * @param {number} deltaTime - Time elapsed since the last update
+     */
     emitParticles(deltaTime) {
         if (!this.duration.isTimeElapsed()) {
             this.createParticles(deltaTime);
         }
     }
+    /**
+     * Creates the particles to be emitted.
+     * Triggers the CREATE event when a particle is created.
+     * @param {number} deltaTime - Time elapsed since the last update
+     */
     createParticles(deltaTime) {
         const particlesToEmit = this.emitController.howMany(deltaTime, this.list.length);
         for (let i = 0; i < particlesToEmit; ++i) {
@@ -57,11 +71,20 @@ export default class Emitter extends eventemitter3 {
             this.emit(Emitter.CREATE, particle);
         }
     }
+    /**
+     * Updates the list of particles
+     * @param {number} deltaTime - The amount of time that has passed since the last update
+     */
     updateParticles(deltaTime) {
         this.list.forEach((particle) => {
             this.updateParticle(particle, deltaTime);
         });
     }
+    /**
+     * Updates a single particle
+     * @param {Particle} particle - The particle to update
+     * @param {number} deltaTime - The amount of time that has passed since the last update
+     */
     updateParticle(particle, deltaTime) {
         if (particle.isDead()) {
             this.removeParticle(particle);
@@ -76,6 +99,10 @@ export default class Emitter extends eventemitter3 {
             this.emit(Emitter.UPDATE, particle);
         }
     }
+    /**
+     * Removes a particle from the list and reset it
+     * @param {Particle} particle - The particle to remove
+     */
     removeParticle(particle) {
         this.emit(Emitter.REMOVE, particle);
         this.list.remove(particle);
@@ -83,44 +110,77 @@ export default class Emitter extends eventemitter3 {
         ParticlePool.global.push(particle);
         turbulencePool.list.remove(particle);
     }
+    /**
+     * Gets a parser to parse the emitter and it's particles
+     * @returns {EmitterParser} - The parser for this emitter
+     */
     getParser() {
         return new EmitterParser(this);
     }
+    /**
+     * Creates props for a behaviour
+     * @param {string} name - The name of the behaviour
+     * @returns {Object} - The props for the behaviour
+     */
     createBehaviourProps(name) {
         return this.getParser().createBehaviourProps(name);
     }
+    /**
+     * Starts the emitter playing
+     */
     play() {
         this.duration.start();
         this._play = true;
         this.emit(Emitter.PLAY);
     }
+    /**
+     * Resets the emitter and starts playing
+     */
     resetAndPlay() {
         this.reset();
         this.play();
     }
+    /**
+     * Resets the emitter without removing the particles and starts playing
+     */
     resetWithoutRemovingAndPlay() {
         this.resetWithoutRemoving();
         this.play();
     }
+    /**
+     * Resets the emitter and removes all the particles
+     */
     reset() {
         this.emitController.reset();
         this.duration.reset();
         this.removeParticles();
         this.emit(Emitter.RESET);
     }
+    /**
+     * Resets the emitter without removing the particles
+     */
     resetWithoutRemoving() {
         this.emitController.reset();
         this.duration.reset();
         this.emit(Emitter.RESET);
     }
+    /**
+     * Stops the emitter and removes all the particles
+     */
     stop() {
         this._play = false;
         this.removeParticles();
         this.emit(Emitter.STOP);
     }
+    /**
+     * Stops the emitter without killing the particles
+     */
     stopWithoutKilling() {
         this.duration.stop();
     }
+    /**
+     * Removes all the particles from the list
+     */
     removeParticles() {
         this.list.forEach((particle) => {
             this.removeParticle(particle);