custom-pixi-particles 4.0.20 → 4.0.22

package/dist/lib/behaviour/Behaviour.d.ts

@@ -1,7 +1,33 @@
 import BehaviourParser from '../parser/BehaviourParser';
+/**
+ * Creates a new Behaviour
+ *
+ * @class
+ */
 export default class Behaviour {
+    /**
+     * A protected property used to store the priority of the behaviour
+     *
+     * @protected
+     */
     protected priority: number;
+    /**
+     * Calculates the variance from a given value
+     *
+     * @param {number} value - a given value
+     * @returns {number} the variance based on the given value
+     */
     varianceFrom: (value: number) => number;
+    /**
+     * Gets the name of the behaviour
+     *
+     * @returns {string} The name of the behaviour
+     */
     getName(): void;
+    /**
+     * Gets the parser for the behaviour
+     *
+     * @returns {BehaviourParser} The parser for the behaviour
+     */
     getParser: () => BehaviourParser;
 }

package/dist/lib/behaviour/Behaviour.js

@@ -1,17 +1,43 @@
 import BehaviourParser from '../parser/BehaviourParser';
 import { Random } from '../util';
+/**
+ * Creates a new Behaviour
+ *
+ * @class
+ */
 export default class Behaviour {
     constructor() {
+        /**
+         * A protected property used to store the priority of the behaviour
+         *
+         * @protected
+         */
         this.priority = 0;
+        /**
+         * Calculates the variance from a given value
+         *
+         * @param {number} value - a given value
+         * @returns {number} the variance based on the given value
+         */
         this.varianceFrom = (value) => {
             if (value === 0)
                 return 0;
             return Random.uniform(-1.0, 1.0) * value;
         };
+        /**
+         * Gets the parser for the behaviour
+         *
+         * @returns {BehaviourParser} The parser for the behaviour
+         */
         this.getParser = () => {
             return new BehaviourParser(this);
         };
     }
+    /**
+     * Gets the name of the behaviour
+     *
+     * @returns {string} The name of the behaviour
+     */
     getName() {
         throw new Error('This method has to be overridden in subclass');
     }

package/dist/lib/behaviour/Behaviour.js.map

@@ -1 +1 @@
-{"version":3,"file":"Behaviour.js","sourceRoot":"","sources":["../../../src/lib/behaviour/Behaviour.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,MAAM,2BAA2B,CAAA;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAEhC,MAAM,CAAC,OAAO,OAAO,SAAS;IAA9B;QACY,aAAQ,GAAG,CAAC,CAAA;QAEtB,iBAAY,GAAG,CAAC,KAAa,EAAE,EAAE;YAC/B,IAAI,KAAK,KAAK,CAAC;gBAAE,OAAO,CAAC,CAAA;YACzB,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,KAAK,CAAA;QAC1C,CAAC,CAAA;QAMD,cAAS,GAAG,GAAG,EAAE;YACf,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAA;QAClC,CAAC,CAAA;IACH,CAAC;IAPC,OAAO;QACL,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;IACjE,CAAC;CAKF"}
+{"version":3,"file":"Behaviour.js","sourceRoot":"","sources":["../../../src/lib/behaviour/Behaviour.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,MAAM,2BAA2B,CAAA;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAEhC;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,SAAS;IAA9B;QACE;;;;WAIG;QACO,aAAQ,GAAG,CAAC,CAAA;QAEtB;;;;;WAKG;QACH,iBAAY,GAAG,CAAC,KAAa,EAAE,EAAE;YAC/B,IAAI,KAAK,KAAK,CAAC;gBAAE,OAAO,CAAC,CAAA;YACzB,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,KAAK,CAAA;QAC1C,CAAC,CAAA;QAWD;;;;WAIG;QACH,cAAS,GAAG,GAAG,EAAE;YACf,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAA;QAClC,CAAC,CAAA;IACH,CAAC;IAjBC;;;;OAIG;IACH,OAAO;QACL,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;IACjE,CAAC;CAUF"}

package/dist/lib/behaviour/ColorBehaviour.d.ts

@@ -10,7 +10,7 @@ export default class ColorBehaviour extends Behaviour {
     endVariance: Color;
     sinus: boolean;
     init: (particle: Particle) => void;
-    apply: (particle: Particle, deltaTime: number) => void;
+    apply: (particle: Particle) => void;
     getName(): string;
     getProps(): {
         enabled: boolean;

package/dist/lib/behaviour/ColorBehaviour.js

@@ -12,8 +12,6 @@ export default class ColorBehaviour extends Behaviour {
         this.endVariance = new Color(0, 0, 0, 0);
         this.sinus = false;
         this.init = (particle) => {
-            if (!this.enabled)
-                return;
             particle.colorStart.copyFrom(this.start);
             particle.colorStart.r += this.varianceFrom(this.startVariance.r);
             particle.colorStart.g += this.varianceFrom(this.startVariance.g);
@@ -26,18 +24,17 @@ export default class ColorBehaviour extends Behaviour {
             particle.colorEnd.alpha += this.varianceFrom(this.endVariance.alpha);
             particle.color.copyFrom(particle.colorStart);
         };
-        this.apply = (particle, deltaTime) => {
-            if (!this.enabled)
-                return;
-            particle.color.copyFrom(particle.colorStart);
-            particle.color.r += (particle.colorEnd.r - particle.colorStart.r) * particle.lifeProgress;
-            particle.color.g += (particle.colorEnd.g - particle.colorStart.g) * particle.lifeProgress;
-            particle.color.b += (particle.colorEnd.b - particle.colorStart.b) * particle.lifeProgress;
+        this.apply = (particle) => {
+            const { colorStart, lifeProgress, colorEnd } = particle;
+            particle.color.copyFrom(colorStart);
+            particle.color.r += (colorEnd.r - colorStart.r) * lifeProgress;
+            particle.color.g += (colorEnd.g - colorStart.g) * lifeProgress;
+            particle.color.b += (colorEnd.b - colorStart.b) * lifeProgress;
             if (!this.sinus) {
-                particle.color.alpha += (particle.colorEnd.alpha - particle.colorStart.alpha) * particle.lifeProgress;
+                particle.color.alpha += (colorEnd.alpha - colorStart.alpha) * lifeProgress;
             }
             else {
-                particle.color.alpha = Math.sin(particle.lifeProgress * 3.1);
+                particle.color.alpha = Math.sin(lifeProgress * 3.1);
             }
         };
     }

package/dist/lib/behaviour/ColorBehaviour.js.map

@@ -1 +1 @@
-{"version":3,"file":"ColorBehaviour.js","sourceRoot":"","sources":["../../../src/lib/behaviour/ColorBehaviour.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAC/B,OAAO,SAAS,MAAM,aAAa,CAAA;AACnC,OAAO,cAAc,MAAM,kBAAkB,CAAA;AAG7C,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,SAAS;IAArD;;QACE,YAAO,GAAG,KAAK,CAAA;QACf,aAAQ,GAAG,CAAC,CAAA;QACZ,UAAK,GAAG,IAAI,KAAK,EAAE,CAAA;QACnB,QAAG,GAAG,IAAI,KAAK,EAAE,CAAA;QACjB,kBAAa,GAAG,IAAI,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QACrC,gBAAW,GAAG,IAAI,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QACnC,UAAK,GAAG,KAAK,CAAA;QAEb,SAAI,GAAG,CAAC,QAAkB,EAAE,EAAE;YAC5B,IAAI,CAAC,IAAI,CAAC,OAAO;gBAAE,OAAM;YACzB,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YACxC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;YAChE,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;YAChE,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;YAChE,QAAQ,CAAC,UAAU,CAAC,KAAK,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;YAExE,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YACpC,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;YAC5D,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;YAC5D,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;YAC5D,QAAQ,CAAC,QAAQ,CAAC,KAAK,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;YAEpE,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;QAC9C,CAAC,CAAA;QAED,UAAK,GAAG,CAAC,QAAkB,EAAE,SAAiB,EAAE,EAAE;YAChD,IAAI,CAAC,IAAI,CAAC,OAAO;gBAAE,OAAM;YACzB,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;YAE5C,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,YAAY,CAAA;YACzF,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,YAAY,CAAA;YACzF,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,YAAY,CAAA;YAEzF,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;gBACf,QAAQ,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC,YAAY,CAAA;aACtG;iBAAM;gBACL,QAAQ,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,YAAY,GAAG,GAAG,CAAC,CAAA;aAC7D;QACH,CAAC,CAAA;IAsCH,CAAC;IApCC,OAAO;QACL,OAAO,cAAc,CAAC,eAAe,CAAA;IACvC,CAAC;IAED,QAAQ;QACN,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,KAAK,EAAE;gBACL,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK;aACzB;YACD,GAAG,EAAE;gBACH,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK;aACzB;YACD,aAAa,EAAE;gBACb,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK;aACzB;YACD,WAAW,EAAE;gBACX,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK;aACzB;YACD,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE;SACrB,CAAA;IACH,CAAC;CACF"}
+{"version":3,"file":"ColorBehaviour.js","sourceRoot":"","sources":["../../../src/lib/behaviour/ColorBehaviour.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAC/B,OAAO,SAAS,MAAM,aAAa,CAAA;AACnC,OAAO,cAAc,MAAM,kBAAkB,CAAA;AAG7C,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,SAAS;IAArD;;QACE,YAAO,GAAG,KAAK,CAAA;QACf,aAAQ,GAAG,CAAC,CAAA;QACZ,UAAK,GAAG,IAAI,KAAK,EAAE,CAAA;QACnB,QAAG,GAAG,IAAI,KAAK,EAAE,CAAA;QACjB,kBAAa,GAAG,IAAI,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QACrC,gBAAW,GAAG,IAAI,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QACnC,UAAK,GAAG,KAAK,CAAA;QAEb,SAAI,GAAG,CAAC,QAAkB,EAAE,EAAE;YAC5B,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YACxC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;YAChE,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;YAChE,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;YAChE,QAAQ,CAAC,UAAU,CAAC,KAAK,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;YAExE,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YACpC,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;YAC5D,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;YAC5D,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;YAC5D,QAAQ,CAAC,QAAQ,CAAC,KAAK,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;YAEpE,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;QAC9C,CAAC,CAAA;QAED,UAAK,GAAG,CAAC,QAAkB,EAAE,EAAE;YAC7B,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,QAAQ,CAAA;YAEvD,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;YAEnC,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,YAAY,CAAA;YAC9D,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,YAAY,CAAA;YAC9D,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,YAAY,CAAA;YAE9D,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;gBACf,QAAQ,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,YAAY,CAAA;aAC3E;iBAAM;gBACL,QAAQ,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,GAAG,CAAC,CAAA;aACpD;QACH,CAAC,CAAA;IAsCH,CAAC;IApCC,OAAO;QACL,OAAO,cAAc,CAAC,eAAe,CAAA;IACvC,CAAC;IAED,QAAQ;QACN,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,KAAK,EAAE;gBACL,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK;aACzB;YACD,GAAG,EAAE;gBACH,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK;aACzB;YACD,aAAa,EAAE;gBACb,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK;aACzB;YACD,WAAW,EAAE;gBACX,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChB,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK;aACzB;YACD,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE;SACrB,CAAA;IACH,CAAC;CACF"}

package/dist/lib/behaviour/EmitDirectionBehaviour.d.ts

@@ -1,17 +1,41 @@
 import Behaviour from './Behaviour';
 import Particle from '../Particle';
+/**
+ * The EmitDirectionBehaviour class that inherits from the Behaviour class.
+ * This class is used to set the direction of a particle when it is emitted.
+ * @export
+ * @class EmitDirectionBehaviour
+ * @extends {Behaviour}
+ */
 export default class EmitDirectionBehaviour extends Behaviour {
     enabled: boolean;
     priority: number;
     angle: number;
     variance: number;
+    /**
+     * Initializes the particle's direction.
+     * @param {Particle} particle - The particle that is being initialized.
+     * @memberof EmitDirectionBehaviour
+     */
     init: (particle: Particle) => void;
-    apply: (particle: Particle, deltaTime: number) => void;
+    /**
+     * Applies the behavior to the particle.
+     * @param {Particle} particle - The particle to which the behavior is being applied.
+     * @param {number} deltaTime - The amount of time since the behavior was last applied.
+     * @memberof EmitDirectionBehaviour
+     */
+    apply: (particle: Particle) => void;
+    /**
+     * Gets the name of the behavior.
+     * @returns {BehaviourNames.EMIT_DIRECTION}
+     * @memberof EmitDirectionBehaviour
+     */
     getName(): string;
-    get angleInDegrees(): number;
-    set angleInDegrees(value: number);
-    get varianceInDegrees(): number;
-    set varianceInDegrees(value: number);
+    /**
+     * Gets the properties of the behavior.
+     * @returns {object} - The properties of the behavior.
+     * @memberof EmitDirectionBehaviour
+     */
     getProps(): {
         enabled: boolean;
         priority: number;

package/dist/lib/behaviour/EmitDirectionBehaviour.js

@@ -1,7 +1,13 @@
 import Behaviour from './Behaviour';
 import BehaviourNames from './BehaviourNames';
-import math from '../util/maths';
 let _tmp = 0;
+/**
+ * The EmitDirectionBehaviour class that inherits from the Behaviour class.
+ * This class is used to set the direction of a particle when it is emitted.
+ * @export
+ * @class EmitDirectionBehaviour
+ * @extends {Behaviour}
+ */
 export default class EmitDirectionBehaviour extends Behaviour {
     constructor() {
         super(...arguments);
@@ -9,36 +15,42 @@ export default class EmitDirectionBehaviour extends Behaviour {
         this.priority = 0;
         this.angle = 0;
         this.variance = 0;
+        /**
+         * Initializes the particle's direction.
+         * @param {Particle} particle - The particle that is being initialized.
+         * @memberof EmitDirectionBehaviour
+         */
         this.init = (particle) => {
-            if (!this.enabled)
-                return;
             const directionAngle = this.angle + this.varianceFrom(this.variance);
             particle.directionCos = Math.cos(directionAngle);
             particle.directionSin = Math.sin(directionAngle);
         };
-        this.apply = (particle, deltaTime) => {
-            if (!this.enabled)
-                return;
-            _tmp = particle.directionCos * particle.x - particle.directionSin * particle.y;
-            particle.y = particle.directionSin * particle.x + particle.directionCos * particle.y;
+        /**
+         * Applies the behavior to the particle.
+         * @param {Particle} particle - The particle to which the behavior is being applied.
+         * @param {number} deltaTime - The amount of time since the behavior was last applied.
+         * @memberof EmitDirectionBehaviour
+         */
+        this.apply = (particle) => {
+            const { x, y, directionSin, directionCos } = particle;
+            _tmp = directionCos * x - directionSin * y;
+            particle.y = directionSin * x + directionCos * y;
             particle.x = _tmp;
         };
     }
+    /**
+     * Gets the name of the behavior.
+     * @returns {BehaviourNames.EMIT_DIRECTION}
+     * @memberof EmitDirectionBehaviour
+     */
     getName() {
         return BehaviourNames.EMIT_DIRECTION;
     }
-    get angleInDegrees() {
-        return math.radiansToDegrees(this.variance);
-    }
-    set angleInDegrees(value) {
-        this.angle = math.degreesToRadians(value);
-    }
-    get varianceInDegrees() {
-        return math.radiansToDegrees(this.variance);
-    }
-    set varianceInDegrees(value) {
-        this.variance = math.degreesToRadians(value);
-    }
+    /**
+     * Gets the properties of the behavior.
+     * @returns {object} - The properties of the behavior.
+     * @memberof EmitDirectionBehaviour
+     */
     getProps() {
         return {
             enabled: this.enabled,

package/dist/lib/behaviour/EmitDirectionBehaviour.js.map

@@ -1 +1 @@
-{"version":3,"file":"EmitDirectionBehaviour.js","sourceRoot":"","sources":["../../../src/lib/behaviour/EmitDirectionBehaviour.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,aAAa,CAAA;AACnC,OAAO,cAAc,MAAM,kBAAkB,CAAA;AAC7C,OAAO,IAAI,MAAM,eAAe,CAAA;AAGhC,IAAI,IAAI,GAAG,CAAC,CAAA;AAEZ,MAAM,CAAC,OAAO,OAAO,sBAAuB,SAAQ,SAAS;IAA7D;;QACE,YAAO,GAAG,IAAI,CAAA;QACd,aAAQ,GAAG,CAAC,CAAA;QACZ,UAAK,GAAG,CAAC,CAAA;QACT,aAAQ,GAAG,CAAC,CAAA;QAEZ,SAAI,GAAG,CAAC,QAAkB,EAAE,EAAE;YAC5B,IAAI,CAAC,IAAI,CAAC,OAAO;gBAAE,OAAM;YACzB,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YACpE,QAAQ,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;YAChD,QAAQ,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;QAClD,CAAC,CAAA;QAED,UAAK,GAAG,CAAC,QAAkB,EAAE,SAAiB,EAAE,EAAE;YAChD,IAAI,CAAC,IAAI,CAAC,OAAO;gBAAE,OAAM;YACzB,IAAI,GAAG,QAAQ,CAAC,YAAY,GAAG,QAAQ,CAAC,CAAC,GAAG,QAAQ,CAAC,YAAY,GAAG,QAAQ,CAAC,CAAC,CAAA;YAC9E,QAAQ,CAAC,CAAC,GAAG,QAAQ,CAAC,YAAY,GAAG,QAAQ,CAAC,CAAC,GAAG,QAAQ,CAAC,YAAY,GAAG,QAAQ,CAAC,CAAC,CAAA;YACpF,QAAQ,CAAC,CAAC,GAAG,IAAI,CAAA;QACnB,CAAC,CAAA;IA+BH,CAAC;IA7BC,OAAO;QACL,OAAO,cAAc,CAAC,cAAc,CAAA;IACtC,CAAC;IAED,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IAC7C,CAAC;IAED,IAAI,cAAc,CAAC,KAAa;QAC9B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;IAC3C,CAAC;IAED,IAAI,iBAAiB;QACnB,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IAC7C,CAAC;IAED,IAAI,iBAAiB,CAAC,KAAa;QACjC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;IAC9C,CAAC;IAED,QAAQ;QACN,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE;SACrB,CAAA;IACH,CAAC;CACF"}
+{"version":3,"file":"EmitDirectionBehaviour.js","sourceRoot":"","sources":["../../../src/lib/behaviour/EmitDirectionBehaviour.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,aAAa,CAAA;AACnC,OAAO,cAAc,MAAM,kBAAkB,CAAA;AAG7C,IAAI,IAAI,GAAG,CAAC,CAAA;AAEZ;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,OAAO,sBAAuB,SAAQ,SAAS;IAA7D;;QACE,YAAO,GAAG,IAAI,CAAA;QACd,aAAQ,GAAG,CAAC,CAAA;QACZ,UAAK,GAAG,CAAC,CAAA;QACT,aAAQ,GAAG,CAAC,CAAA;QAEZ;;;;WAIG;QACH,SAAI,GAAG,CAAC,QAAkB,EAAE,EAAE;YAC5B,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YACpE,QAAQ,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;YAChD,QAAQ,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;QAClD,CAAC,CAAA;QAED;;;;;WAKG;QACH,UAAK,GAAG,CAAC,QAAkB,EAAE,EAAE;YAC7B,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,QAAQ,CAAA;YAErD,IAAI,GAAG,YAAY,GAAG,CAAC,GAAG,YAAY,GAAG,CAAC,CAAA;YAC1C,QAAQ,CAAC,CAAC,GAAG,YAAY,GAAG,CAAC,GAAG,YAAY,GAAG,CAAC,CAAA;YAChD,QAAQ,CAAC,CAAC,GAAG,IAAI,CAAA;QACnB,CAAC,CAAA;IAyBH,CAAC;IAvBC;;;;OAIG;IACH,OAAO;QACL,OAAO,cAAc,CAAC,cAAc,CAAA;IACtC,CAAC;IAED;;;;OAIG;IACH,QAAQ;QACN,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE;SACrB,CAAA;IACH,CAAC;CACF"}

package/dist/lib/behaviour/EmitterBehaviours.d.ts

@@ -1,13 +1,55 @@
 import Particle from '../Particle';
-import Model from "../Model";
+import Model from '../Model';
+/**
+ * EmitterBehaviours class manages the behaviour of particles
+ */
 export default class EmitterBehaviours {
     behaviours: any;
+    /**
+     * Gets all the enabled behaviours
+     *
+     * @return {any[]} The enabled behaviours
+     */
     getAll: () => any;
-    isEmpty: () => boolean;
+    /**
+     * Clears all the stored behaviours
+     */
     clear: () => void;
+    /**
+     * Adds a behaviour
+     *
+     * @param {any} behaviour The behaviour to add
+     *
+     * @return {any} The added behaviour
+     */
     add: (behaviour: any) => any;
+    /**
+     * Gets a behaviour by name
+     *
+     * @param {string} name The name of the behaviour to get
+     *
+     * @return {any | null} The behaviour with the given name or null if not found
+     */
     getByName: (name: string) => any;
+    /**
+     * Removes a behaviour by name
+     *
+     * @param {string} name The name of the behaviour to remove
+     */
     removeByName: (name: string) => void;
+    /**
+     * Initialises the behaviours
+     *
+     * @param {Particle} particle The particle
+     * @param {Model} model The model
+     */
     init: (particle: Particle, model: Model) => void;
+    /**
+     * Applies the behaviours
+     *
+     * @param {Particle} particle The particle
+     * @param {number} deltaTime The delta time
+     * @param {Model} model The model
+     */
     apply: (particle: Particle, deltaTime: number, model: Model) => void;
 }

package/dist/lib/behaviour/EmitterBehaviours.js

@@ -1,18 +1,33 @@
 // tslint:disable:prefer-for-of
+/**
+ * EmitterBehaviours class manages the behaviour of particles
+ */
 export default class EmitterBehaviours {
     constructor() {
         this.behaviours = [];
+        /**
+         * Gets all the enabled behaviours
+         *
+         * @return {any[]} The enabled behaviours
+         */
         this.getAll = () => {
             return this.behaviours.filter((behaviour) => {
                 return behaviour.enabled;
             });
         };
-        this.isEmpty = () => {
-            return this.getAll().length === 0;
-        };
+        /**
+         * Clears all the stored behaviours
+         */
         this.clear = () => {
             this.behaviours = [];
         };
+        /**
+         * Adds a behaviour
+         *
+         * @param {any} behaviour The behaviour to add
+         *
+         * @return {any} The added behaviour
+         */
         this.add = (behaviour) => {
             if (this.getByName(behaviour.getName()) !== null) {
                 throw new Error('Emitter duplicate');
@@ -23,6 +38,13 @@ export default class EmitterBehaviours {
             });
             return behaviour;
         };
+        /**
+         * Gets a behaviour by name
+         *
+         * @param {string} name The name of the behaviour to get
+         *
+         * @return {any | null} The behaviour with the given name or null if not found
+         */
         this.getByName = (name) => {
             for (let i = 0; i < this.behaviours.length; ++i) {
                 if (this.behaviours[i].getName() === name) {
@@ -31,6 +53,11 @@ export default class EmitterBehaviours {
             }
             return null;
         };
+        /**
+         * Removes a behaviour by name
+         *
+         * @param {string} name The name of the behaviour to remove
+         */
         this.removeByName = (name) => {
             const behaviours = [];
             for (let i = 0; i < this.behaviours.length; ++i) {
@@ -40,11 +67,24 @@ export default class EmitterBehaviours {
             }
             this.behaviours = behaviours;
         };
+        /**
+         * Initialises the behaviours
+         *
+         * @param {Particle} particle The particle
+         * @param {Model} model The model
+         */
         this.init = (particle, model) => {
             for (let i = 0; i < this.behaviours.length; ++i) {
                 this.behaviours[i].init(particle, model);
             }
         };
+        /**
+         * Applies the behaviours
+         *
+         * @param {Particle} particle The particle
+         * @param {number} deltaTime The delta time
+         * @param {Model} model The model
+         */
         this.apply = (particle, deltaTime, model) => {
             for (let i = 0; i < this.behaviours.length; ++i) {
                 model.updateCamera(deltaTime);

package/dist/lib/behaviour/EmitterBehaviours.js.map

@@ -1 +1 @@
-{"version":3,"file":"EmitterBehaviours.js","sourceRoot":"","sources":["../../../src/lib/behaviour/EmitterBehaviours.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAK/B,MAAM,CAAC,OAAO,OAAO,iBAAiB;IAAtC;QACE,eAAU,GAAQ,EAAE,CAAA;QAEpB,WAAM,GAAG,GAAG,EAAE;YACZ,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,SAAc,EAAE,EAAE;gBAC/C,OAAO,SAAS,CAAC,OAAO,CAAA;YAC1B,CAAC,CAAC,CAAA;QACJ,CAAC,CAAA;QAED,YAAO,GAAG,GAAG,EAAE;YACb,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,MAAM,KAAK,CAAC,CAAA;QACnC,CAAC,CAAA;QAED,UAAK,GAAG,GAAG,EAAE;YACX,IAAI,CAAC,UAAU,GAAG,EAAE,CAAA;QACtB,CAAC,CAAA;QAED,QAAG,GAAG,CAAC,SAAc,EAAE,EAAE;YACvB,IAAI,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,KAAK,IAAI,EAAE;gBAChD,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;aACrC;YAED,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YAC/B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAM,EAAE,CAAM,EAAE,EAAE;gBACtC,OAAO,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAA;YAChC,CAAC,CAAC,CAAA;YAEF,OAAO,SAAS,CAAA;QAClB,CAAC,CAAA;QAED,cAAS,GAAG,CAAC,IAAY,EAAE,EAAE;YAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;gBAC/C,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;oBACzC,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;iBAC1B;aACF;YAED,OAAO,IAAI,CAAA;QACb,CAAC,CAAA;QAED,iBAAY,GAAG,CAAC,IAAY,EAAE,EAAE;YAC9B,MAAM,UAAU,GAAG,EAAE,CAAA;YACrB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;gBAC/C,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;oBACzC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;iBACpC;aACF;YAED,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC9B,CAAC,CAAA;QAED,SAAI,GAAG,CAAC,QAAkB,EAAE,KAAY,EAAE,EAAE;YAC1C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;gBAC/C,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;aACzC;QACH,CAAC,CAAA;QAED,UAAK,GAAG,CAAC,QAAkB,EAAE,SAAiB,EAAE,KAAY,EAAE,EAAE;YAC9D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;gBAC/C,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;gBAC9B,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,SAAS,EAAE,KAAK,CAAC,CAAA;aACrD;QACH,CAAC,CAAA;IACH,CAAC;CAAA"}
+{"version":3,"file":"EmitterBehaviours.js","sourceRoot":"","sources":["../../../src/lib/behaviour/EmitterBehaviours.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAK/B;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAiB;IAAtC;QACE,eAAU,GAAQ,EAAE,CAAA;QAEpB;;;;WAIG;QACH,WAAM,GAAG,GAAG,EAAE;YACZ,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,SAAc,EAAE,EAAE;gBAC/C,OAAO,SAAS,CAAC,OAAO,CAAA;YAC1B,CAAC,CAAC,CAAA;QACJ,CAAC,CAAA;QAED;;WAEG;QACH,UAAK,GAAG,GAAG,EAAE;YACX,IAAI,CAAC,UAAU,GAAG,EAAE,CAAA;QACtB,CAAC,CAAA;QAED;;;;;;WAMG;QACH,QAAG,GAAG,CAAC,SAAc,EAAE,EAAE;YACvB,IAAI,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,KAAK,IAAI,EAAE;gBAChD,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;aACrC;YAED,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YAC/B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAM,EAAE,CAAM,EAAE,EAAE;gBACtC,OAAO,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAA;YAChC,CAAC,CAAC,CAAA;YAEF,OAAO,SAAS,CAAA;QAClB,CAAC,CAAA;QAED;;;;;;WAMG;QACH,cAAS,GAAG,CAAC,IAAY,EAAE,EAAE;YAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;gBAC/C,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;oBACzC,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;iBAC1B;aACF;YAED,OAAO,IAAI,CAAA;QACb,CAAC,CAAA;QAED;;;;WAIG;QACH,iBAAY,GAAG,CAAC,IAAY,EAAE,EAAE;YAC9B,MAAM,UAAU,GAAG,EAAE,CAAA;YACrB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;gBAC/C,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;oBACzC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;iBACpC;aACF;YAED,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC9B,CAAC,CAAA;QAED;;;;;WAKG;QACH,SAAI,GAAG,CAAC,QAAkB,EAAE,KAAY,EAAE,EAAE;YAC1C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;gBAC/C,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;aACzC;QACH,CAAC,CAAA;QAED;;;;;;WAMG;QACH,UAAK,GAAG,CAAC,QAAkB,EAAE,SAAiB,EAAE,KAAY,EAAE,EAAE;YAC9D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;gBAC/C,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,CAAA;gBAC7B,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,SAAS,EAAE,KAAK,CAAC,CAAA;aACrD;QACH,CAAC,CAAA;IACH,CAAC;CAAA"}

package/dist/lib/behaviour/LifeBehaviour.d.ts

@@ -1,13 +1,62 @@
 import { Behaviour } from './index';
 import Particle from '../Particle';
+/**
+ * This class is responsible for managing the lifetimes of particles.
+ * It sets the maximum lifetime of the particle and updates its progress.
+ *
+ * @extends Behaviour
+ */
 export default class LifeBehaviour extends Behaviour {
+    /**
+     * Whether or not this behaviour is enabled.
+     *
+     * @type {boolean}
+     */
     enabled: boolean;
+    /**
+     * The priority of this behaviour.
+     *
+     * @type {number}
+     */
     priority: number;
+    /**
+     * The maximum life time of the particle that this behaviour will set.
+     *
+     * @type {number}
+     */
     maxLifeTime: number;
+    /**
+     * The variance of the particle's life time.
+     *
+     * @type {number}
+     */
     timeVariance: number;
+    /**
+     * Sets the particle's life time and maximum life time.
+     *
+     * @param {Particle} particle - The particle to set the life time of.
+     * @returns {void}
+     */
     init: (particle: Particle) => void;
+    /**
+     * Updates the particle's life time and progress.
+     *
+     * @param {Particle} particle - The particle to update.
+     * @param {number} deltaTime - The time since the last update.
+     * @returns {void}
+     */
     apply: (particle: Particle, deltaTime: number) => void;
+    /**
+     * Returns the name of this behaviour.
+     *
+     * @returns {string} - The name of the behaviour.
+     */
     getName(): string;
+    /**
+     * Returns the properties of the behaviour.
+     *
+     * @returns {Object} - The properties of the behaviour.
+     */
     getProps(): {
         enabled: boolean;
         priority: number;

package/dist/lib/behaviour/LifeBehaviour.js

@@ -1,27 +1,77 @@
 import { Behaviour, BehaviourNames } from './index';
+/**
+ * This class is responsible for managing the lifetimes of particles.
+ * It sets the maximum lifetime of the particle and updates its progress.
+ *
+ * @extends Behaviour
+ */
 export default class LifeBehaviour extends Behaviour {
     constructor() {
         super(...arguments);
+        /**
+         * Whether or not this behaviour is enabled.
+         *
+         * @type {boolean}
+         */
         this.enabled = true;
+        /**
+         * The priority of this behaviour.
+         *
+         * @type {number}
+         */
         this.priority = 10000;
+        /**
+         * The maximum life time of the particle that this behaviour will set.
+         *
+         * @type {number}
+         */
         this.maxLifeTime = 0;
+        /**
+         * The variance of the particle's life time.
+         *
+         * @type {number}
+         */
         this.timeVariance = 0;
+        /**
+         * Sets the particle's life time and maximum life time.
+         *
+         * @param {Particle} particle - The particle to set the life time of.
+         * @returns {void}
+         */
         this.init = (particle) => {
             particle.lifeTime = 0;
             particle.lifeProgress = 0;
-            particle.maxLifeTime = this.maxLifeTime + this.varianceFrom(this.timeVariance);
-            particle.maxLifeTime = Math.max(particle.maxLifeTime, 0.0);
+            particle.maxLifeTime = Math.max(this.maxLifeTime + this.varianceFrom(this.timeVariance), 0.0);
         };
+        /**
+         * Updates the particle's life time and progress.
+         *
+         * @param {Particle} particle - The particle to update.
+         * @param {number} deltaTime - The time since the last update.
+         * @returns {void}
+         */
         this.apply = (particle, deltaTime) => {
-            particle.lifeTime += deltaTime;
-            if (particle.maxLifeTime > 0) {
-                particle.lifeProgress = Math.min(1.0, particle.lifeTime / particle.maxLifeTime);
+            const { maxLifeTime } = particle;
+            const lifeTime = particle.lifeTime + deltaTime;
+            particle.lifeTime = lifeTime;
+            if (maxLifeTime > 0) {
+                particle.lifeProgress = Math.min(1.0, lifeTime / maxLifeTime);
             }
         };
     }
+    /**
+     * Returns the name of this behaviour.
+     *
+     * @returns {string} - The name of the behaviour.
+     */
     getName() {
         return BehaviourNames.LIFE_BEHAVIOUR;
     }
+    /**
+     * Returns the properties of the behaviour.
+     *
+     * @returns {Object} - The properties of the behaviour.
+     */
     getProps() {
         return {
             enabled: this.enabled,

package/dist/lib/behaviour/LifeBehaviour.js.map

@@ -1 +1 @@
-{"version":3,"file":"LifeBehaviour.js","sourceRoot":"","sources":["../../../src/lib/behaviour/LifeBehaviour.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAGnD,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,SAAS;IAApD;;QACE,YAAO,GAAG,IAAI,CAAA;QACd,aAAQ,GAAG,KAAK,CAAA;QAChB,gBAAW,GAAG,CAAC,CAAA;QACf,iBAAY,GAAG,CAAC,CAAA;QAEhB,SAAI,GAAG,CAAC,QAAkB,EAAE,EAAE;YAC5B,QAAQ,CAAC,QAAQ,GAAG,CAAC,CAAA;YACrB,QAAQ,CAAC,YAAY,GAAG,CAAC,CAAA;YAEzB,QAAQ,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;YAC9E,QAAQ,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,EAAE,GAAG,CAAC,CAAA;QAC5D,CAAC,CAAA;QAED,UAAK,GAAG,CAAC,QAAkB,EAAE,SAAiB,EAAE,EAAE;YAChD,QAAQ,CAAC,QAAQ,IAAI,SAAS,CAAA;YAE9B,IAAI,QAAQ,CAAC,WAAW,GAAG,CAAC,EAAE;gBAC5B,QAAQ,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAA;aAChF;QACH,CAAC,CAAA;IAeH,CAAC;IAbC,OAAO;QACL,OAAO,cAAc,CAAC,cAAc,CAAA;IACtC,CAAC;IAED,QAAQ;QACN,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE;SACrB,CAAA;IACH,CAAC;CACF"}
+{"version":3,"file":"LifeBehaviour.js","sourceRoot":"","sources":["../../../src/lib/behaviour/LifeBehaviour.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAGnD;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,SAAS;IAApD;;QACE;;;;WAIG;QACH,YAAO,GAAG,IAAI,CAAA;QAEd;;;;WAIG;QACH,aAAQ,GAAG,KAAK,CAAA;QAEhB;;;;WAIG;QACH,gBAAW,GAAG,CAAC,CAAA;QAEf;;;;WAIG;QACH,iBAAY,GAAG,CAAC,CAAA;QAEhB;;;;;WAKG;QACH,SAAI,GAAG,CAAC,QAAkB,EAAE,EAAE;YAC5B,QAAQ,CAAC,QAAQ,GAAG,CAAC,CAAA;YACrB,QAAQ,CAAC,YAAY,GAAG,CAAC,CAAA;YACzB,QAAQ,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,CAAA;QAC/F,CAAC,CAAA;QAED;;;;;;WAMG;QACH,UAAK,GAAG,CAAC,QAAkB,EAAE,SAAiB,EAAE,EAAE;YAChD,MAAM,EAAE,WAAW,EAAE,GAAG,QAAQ,CAAA;YAChC,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,GAAG,SAAS,CAAA;YAE9C,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAA;YAE5B,IAAI,WAAW,GAAG,CAAC,EAAE;gBACnB,QAAQ,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,GAAG,WAAW,CAAC,CAAA;aAC9D;QACH,CAAC,CAAA;IAyBH,CAAC;IAvBC;;;;OAIG;IACH,OAAO;QACL,OAAO,cAAc,CAAC,cAAc,CAAA;IACtC,CAAC;IAED;;;;OAIG;IACH,QAAQ;QACN,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE;SACrB,CAAA;IACH,CAAC;CACF"}

package/dist/lib/behaviour/PositionBehaviour.d.ts

@@ -1,7 +1,7 @@
 import { Point } from '../util';
 import { Behaviour } from './index';
 import Particle from '../Particle';
-import Model from "../Model";
+import Model from '../Model';
 export default class PositionBehaviour extends Behaviour {
     enabled: boolean;
     priority: number;
@@ -26,11 +26,43 @@ export default class PositionBehaviour extends Behaviour {
     warpFov: number;
     warpStretch: number;
     warpDistanceScaleConverter: number;
+    warpDistanceToCenter: boolean;
+    /**
+     * Function that initializes a particle
+     * @param {Particle} particle - The particle to be initialized
+     * @param {Model} model - The model of the particle
+     */
     init: (particle: Particle, model: Model) => void;
+    /**
+     * Restarts the warp of a particle
+     * @param {Particle} particle - The particle to restart the warp on
+     * @param {boolean} initial - True if this is the initial warp, false if it is a subsequent one
+     * @param {Model} model - The model containing the camera Z property
+     */
     restartWarp: (particle: Particle, initial: boolean, model: Model) => void;
+    /**
+     * Adds a random variance to the given value
+     * @param {number} value - The value to calculate
+     * @param {number} variance - The random variance to add
+     * @returns {number} The calculated value
+     */
     calculate: (value: number, variance: number) => number;
+    /**
+     * Applies the particle's velocity and acceleration to move it and calculate its size, rotation, and position.
+     * @param {Particle} particle - The particle to be moved
+     * @param {number} deltaTime - The time delta for the movement calculation
+     * @param {Model} model - The model containing information about the particle's movement
+     */
     apply: (particle: Particle, deltaTime: number, model: Model) => void;
+    /**
+     * Gets the name of the behaviour
+     * @return {BehaviourNames} The name of the behaviour
+     */
     getName(): string;
+    /**
+     * @description Retrieves the properties of the object.
+     * @returns {Object} The properties of the object.
+     */
     getProps(): {
         enabled: boolean;
         priority: number;
@@ -73,6 +105,7 @@ export default class PositionBehaviour extends Behaviour {
         warpFov: number;
         warpStretch: number;
         warpDistanceScaleConverter: number;
+        warpDistanceToCenter: boolean;
         name: string;
     };
 }