custom-pixi-particles 4.0.21 → 4.0.23

package/README.md

@@ -1,16 +1,17 @@
-CustomPIXIParticles by [@lukasz-okuniewicz](http://github.com/lukasz-okuniewicz)
-=========
+# CustomPIXIParticles by [@lukasz-okuniewicz](http://github.com/lukasz-okuniewicz)
 
 Custom PIXI Particles.
 
 Editor for particles: [custom-pixi-particles-editor](https://github.com/lukasz-okuniewicz/custom-pixi-particles-editor)
 
 How to use:
+
 ```
 npm install custom-pixi-particles
 ```
 
 then:
+
 ```javascript
 const customPIXIParticles = require('custom-pixi-particles')
 // or
@@ -43,3 +44,10 @@ const newTextures = ['texture3.png', 'texture4.png']
 // Change textures
 this.particles.setTextures(newTextures)
 ```
+
+```javascript
+// Update config
+emitController.duration = 3
+emitController._emitPerSecond = 200
+this.particles.updateConfig(emitterConfig)
+```

package/dist/index.d.ts

@@ -1,6 +1,11 @@
 import Renderer from './lib/pixi/Renderer';
 import TestRenderer from './lib/pixi/TestRenderer';
 import { ICustomPixiParticlesSettings } from './lib/customPixiParticlesSettingsInterface';
+/**
+ * Constructs a renderer for custom pixi particles
+ * @class Renderer
+ * @param {ICustomPixiParticlesSettings} settings The settings for the renderer
+ */
 declare const customPixiParticles: {
     create(settings: ICustomPixiParticlesSettings): Renderer;
     createTest(settings: ICustomPixiParticlesSettings): TestRenderer;

package/dist/index.js

@@ -1,13 +1,30 @@
 import Renderer from './lib/pixi/Renderer';
 import TestRenderer from './lib/pixi/TestRenderer';
+/**
+ * Constructs a renderer for custom pixi particles
+ * @class Renderer
+ * @param {ICustomPixiParticlesSettings} settings The settings for the renderer
+ */
 const customPixiParticles = {
     create(settings) {
-        const { textures, emitterConfig, animatedSpriteZeroPad = 2, animatedSpriteIndexToStart = 0, finishingTextures = [] } = settings;
-        return new Renderer({ textures, animatedSpriteZeroPad, animatedSpriteIndexToStart, emitterConfig, finishingTextures });
+        const { textures, emitterConfig, animatedSpriteZeroPad = 2, animatedSpriteIndexToStart = 0, finishingTextures = [], } = settings;
+        return new Renderer({
+            textures,
+            animatedSpriteZeroPad,
+            animatedSpriteIndexToStart,
+            emitterConfig,
+            finishingTextures,
+        });
     },
     createTest(settings) {
-        const { textures, emitterConfig, animatedSpriteZeroPad = 2, animatedSpriteIndexToStart = 0, finishingTextures = [] } = settings;
-        return new TestRenderer({ textures, animatedSpriteZeroPad, animatedSpriteIndexToStart, emitterConfig, finishingTextures });
+        const { textures, emitterConfig, animatedSpriteZeroPad = 2, animatedSpriteIndexToStart = 0, finishingTextures = [], } = settings;
+        return new TestRenderer({
+            textures,
+            animatedSpriteZeroPad,
+            animatedSpriteIndexToStart,
+            emitterConfig,
+            finishingTextures,
+        });
     },
 };
 export { Renderer, customPixiParticles };

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,qBAAqB,CAAA;AAC1C,OAAO,YAAY,MAAM,yBAAyB,CAAA;AAGlD,MAAM,mBAAmB,GAAG;IAC1B,MAAM,CAAC,QAAsC;QAC3C,MAAM,EACJ,QAAQ,EAAE,aAAa,EAAE,qBAAqB,GAAG,CAAC,EAAE,0BAA0B,GAAG,CAAC,EAAE,iBAAiB,GAAG,EAAE,EAC3G,GAAG,QAAQ,CAAA;QACZ,OAAO,IAAI,QAAQ,CAAC,EAAC,QAAQ,EAAE,qBAAqB,EAAE,0BAA0B,EAAE,aAAa,EAAE,iBAAiB,EAAC,CAAC,CAAA;IACtH,CAAC;IACD,UAAU,CAAC,QAAsC;QAC/C,MAAM,EACJ,QAAQ,EAAE,aAAa,EAAE,qBAAqB,GAAG,CAAC,EAAE,0BAA0B,GAAG,CAAC,EAAE,iBAAiB,GAAG,EAAE,EAC3G,GAAG,QAAQ,CAAA;QACZ,OAAO,IAAI,YAAY,CAAC,EAAC,QAAQ,EAAE,qBAAqB,EAAE,0BAA0B,EAAE,aAAa,EAAE,iBAAiB,EAAC,CAAC,CAAA;IAC1H,CAAC;CACF,CAAA;AAED,OAAO,EAAE,QAAQ,EAAE,mBAAmB,EAAgC,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,qBAAqB,CAAA;AAC1C,OAAO,YAAY,MAAM,yBAAyB,CAAA;AAGlD;;;;GAIG;AACH,MAAM,mBAAmB,GAAG;IAC1B,MAAM,CAAC,QAAsC;QAC3C,MAAM,EACJ,QAAQ,EACR,aAAa,EACb,qBAAqB,GAAG,CAAC,EACzB,0BAA0B,GAAG,CAAC,EAC9B,iBAAiB,GAAG,EAAE,GACvB,GAAG,QAAQ,CAAA;QACZ,OAAO,IAAI,QAAQ,CAAC;YAClB,QAAQ;YACR,qBAAqB;YACrB,0BAA0B;YAC1B,aAAa;YACb,iBAAiB;SAClB,CAAC,CAAA;IACJ,CAAC;IACD,UAAU,CAAC,QAAsC;QAC/C,MAAM,EACJ,QAAQ,EACR,aAAa,EACb,qBAAqB,GAAG,CAAC,EACzB,0BAA0B,GAAG,CAAC,EAC9B,iBAAiB,GAAG,EAAE,GACvB,GAAG,QAAQ,CAAA;QACZ,OAAO,IAAI,YAAY,CAAC;YACtB,QAAQ;YACR,qBAAqB;YACrB,0BAA0B;YAC1B,aAAa;YACb,iBAAiB;SAClB,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,OAAO,EAAE,QAAQ,EAAE,mBAAmB,EAAgC,CAAA"}

package/dist/lib/Model.d.ts

@@ -1,9 +1,32 @@
 export default class Model {
+    /**
+     * Boolean value indicating whether warping is enabled
+     */
     warp: boolean;
+    /**
+     * The Z position of the camera
+     */
     cameraZ: number;
+    /**
+     * The conversion rate for cameraZ
+     */
     cameraZConverter: number;
+    /**
+     * The speed of warp
+     */
     warpSpeed: number;
+    /**
+     * The base speed of warp
+     */
     warpBaseSpeed: number;
+    /**
+     * Update the model with the behaviour object
+     * @param {Object} behaviour - The behaviour object
+     */
     update(behaviour: any): void;
+    /**
+     * Update the camera position based on the delta time
+     * @param {number} deltaTime - The delta time
+     */
     updateCamera(deltaTime: number): void;
 }

package/dist/lib/Model.js

@@ -1,17 +1,40 @@
 export default class Model {
     constructor() {
+        /**
+         * Boolean value indicating whether warping is enabled
+         */
         this.warp = false;
+        /**
+         * The Z position of the camera
+         */
         this.cameraZ = 0;
+        /**
+         * The conversion rate for cameraZ
+         */
         this.cameraZConverter = 0;
+        /**
+         * The speed of warp
+         */
         this.warpSpeed = 0;
+        /**
+         * The base speed of warp
+         */
         this.warpBaseSpeed = 0;
     }
+    /**
+     * Update the model with the behaviour object
+     * @param {Object} behaviour - The behaviour object
+     */
     update(behaviour) {
         this.warp = behaviour.warp || false;
         this.cameraZConverter = behaviour.cameraZConverter;
         this.warpSpeed = behaviour.warpSpeed;
         this.warpBaseSpeed = behaviour.warpBaseSpeed;
     }
+    /**
+     * Update the camera position based on the delta time
+     * @param {number} deltaTime - The delta time
+     */
     updateCamera(deltaTime) {
         if (!this.warp)
             return;

package/dist/lib/Model.js.map

@@ -1 +1 @@
-{"version":3,"file":"Model.js","sourceRoot":"","sources":["../../src/lib/Model.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,KAAK;IAA1B;QACI,SAAI,GAAY,KAAK,CAAA;QACrB,YAAO,GAAW,CAAC,CAAA;QACnB,qBAAgB,GAAW,CAAC,CAAA;QAC5B,cAAS,GAAW,CAAC,CAAA;QACrB,kBAAa,GAAW,CAAC,CAAA;IAa7B,CAAC;IAXG,MAAM,CAAC,SAAc;QACjB,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI,IAAI,KAAK,CAAC;QACpC,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC,gBAAgB,CAAC;QACnD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,SAAS,CAAC;QACrC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC,aAAa,CAAC;IACjD,CAAC;IAED,YAAY,CAAC,SAAiB;QAC1B,IAAI,CAAC,IAAI,CAAC,IAAI;YAAE,OAAO;QACvB,IAAI,CAAC,OAAO,IAAI,SAAS,GAAG,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,aAAa,CAAA;IAC3F,CAAC;CACJ"}
+{"version":3,"file":"Model.js","sourceRoot":"","sources":["../../src/lib/Model.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,KAAK;IAA1B;QACE;;WAEG;QACH,SAAI,GAAY,KAAK,CAAA;QAErB;;WAEG;QACH,YAAO,GAAW,CAAC,CAAA;QAEnB;;WAEG;QACH,qBAAgB,GAAW,CAAC,CAAA;QAE5B;;WAEG;QACH,cAAS,GAAW,CAAC,CAAA;QAErB;;WAEG;QACH,kBAAa,GAAW,CAAC,CAAA;IAqB3B,CAAC;IAnBC;;;OAGG;IACH,MAAM,CAAC,SAAc;QACnB,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI,IAAI,KAAK,CAAA;QACnC,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC,gBAAgB,CAAA;QAClD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,SAAS,CAAA;QACpC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC,aAAa,CAAA;IAC9C,CAAC;IAED;;;OAGG;IACH,YAAY,CAAC,SAAiB;QAC5B,IAAI,CAAC,IAAI,CAAC,IAAI;YAAE,OAAM;QACtB,IAAI,CAAC,OAAO,IAAI,SAAS,GAAG,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,aAAa,CAAA;IACzF,CAAC;CACF"}

package/dist/lib/Particle.d.ts

@@ -1,54 +1,200 @@
 import { Sprite } from 'pixi.js-legacy';
 import { Color, Point } from './util';
+/**
+ * Represents a particle object used in particle system simulations
+ */
 export default class Particle {
     static _UID: {
         value: number;
     };
     next: Particle | null;
     prev: Particle | null;
+    /**
+     * Stores the unique ID of the particle
+     */
     uid: number;
+    /**
+     * Stores the movement of the particle
+     */
     movement: Point;
+    /**
+     * Stores the acceleration of the particle
+     */
     acceleration: Point;
+    /**
+     * Stores the velocity of the particle
+     */
     velocity: Point;
+    /**
+     * Stores the size of the particle
+     */
     size: Point;
+    /**
+     * Stores the starting size of the particle
+     */
     sizeStart: Point;
+    /**
+     * Stores the starting warp size of the particle
+     */
     warpSizeStart: Point;
+    /**
+     * Stores the ending size of the particle
+     */
     sizeEnd: Point;
+    /**
+     * Stores the x value of the particle for sin wave
+     */
     sinXVal: Point;
+    /**
+     * Stores the y value of the particle for sin wave
+     */
     sinYVal: Point;
+    /**
+     * Stores the color of the particle
+     */
     color: Color;
+    /**
+     * Stores the starting color of the particle
+     */
     colorStart: Color;
+    /**
+     * Stores the ending color of the particle
+     */
     colorEnd: Color;
+    /**
+     * Stores the maximum life time of the particle
+     */
     maxLifeTime: number;
+    /**
+     * Stores the current life time of the particle
+     */
     lifeTime: number;
+    /**
+     * Stores the current life progress of the particle
+     */
     lifeProgress: number;
+    /**
+     * Stores the x position of the particle
+     */
     x: number;
+    /**
+     * Stores the y position of the particle
+     */
     y: number;
+    /**
+     * Stores the z position of the particle
+     */
     z: number;
+    /**
+     * Stores the velocity angle of the particle
+     */
     velocityAngle: number;
+    /**
+     * Stores the radians per second of the particle
+     */
     radiansPerSecond: number;
+    /**
+     * Stores the radius of the particle
+     */
     radius: number;
+    /**
+     * Stores the starting radius of the particle
+     */
     radiusStart: number;
+    /**
+     * Stores the ending radius of the particle
+     */
     radiusEnd: number;
+    /**
+     * Stores the cosine of the direction of the particle
+     */
     directionCos: number;
+    /**
+     * Stores the sine of the direction of the particle
+     */
     directionSin: number;
+    /**
+     * Stores the rotation of the particle
+     */
     rotation: number;
+    /**
+     * Stores the rotation delta of the particle
+     */
     rotationDelta: number;
+    /**
+     * Stores the angle of the particle
+     */
     angle: number;
+    /**
+     * Stores the sprite of the particle
+     */
     sprite: Sprite;
+    /**
+     * Stores whether the vortices are shown
+     */
     showVortices: boolean;
+    /**
+     * Stores whether the turbulence is enabled
+     */
     turbulence: boolean;
+    /**
+     * Stores the finishing texture of the particle
+     */
     finishingTexture: number;
+    /**
+     * Stores the camera z position of the particle
+     */
     cameraZ: number;
+    /**
+     * Stores the camera z position converter of the particle
+     */
     cameraZConverter: number;
+    /**
+     * Stores the warp speed of the particle
+     */
     warpSpeed: number;
+    /**
+     * Stores the warp base speed of the particle
+     */
     warpBaseSpeed: number;
+    /**
+     * Stores the warp field of view of the particle
+     */
     warpFov: number;
+    /**
+     * Stores the warp stretch of the particle
+     */
     warpStretch: number;
+    /**
+     * Stores the warp distance scale converter of the particle
+     */
     warpDistanceScaleConverter: number;
+    sizeDifference: {
+        x: number;
+        y: number;
+    };
+    /**
+     * Constructs a particle object
+     */
     constructor();
+    /**
+     * Resets the particle object
+     */
     reset(): void;
+    /**
+     * Checks if the particle is almost dead
+     *
+     * @return {boolean} True if the particle is almost dead, otherwise false
+     */
     isAlmostDead(): boolean;
+    /**
+     * Checks if the particle is dead
+     *
+     * @return {boolean} True if the particle is dead, otherwise false
+     */
     isDead(): boolean;
+    /**
+     * Hides the particle
+     */
     hide(): void;
 }

package/dist/lib/Particle.js

@@ -1,23 +1,71 @@
 import { Color, Point } from './util';
+/**
+ * Represents a particle object used in particle system simulations
+ */
 export default class Particle {
+    /**
+     * Constructs a particle object
+     */
     constructor() {
         this.next = null;
         this.prev = null;
+        /**
+         * Stores the unique ID of the particle
+         */
         this.uid = Particle._UID.value++;
+        /**
+         * Stores the movement of the particle
+         */
         this.movement = new Point();
+        /**
+         * Stores the acceleration of the particle
+         */
         this.acceleration = new Point();
+        /**
+         * Stores the velocity of the particle
+         */
         this.velocity = new Point();
+        /**
+         * Stores the size of the particle
+         */
         this.size = new Point();
+        /**
+         * Stores the starting size of the particle
+         */
         this.sizeStart = new Point();
+        /**
+         * Stores the starting warp size of the particle
+         */
         this.warpSizeStart = new Point();
+        /**
+         * Stores the ending size of the particle
+         */
         this.sizeEnd = new Point();
+        /**
+         * Stores the x value of the particle for sin wave
+         */
         this.sinXVal = new Point();
+        /**
+         * Stores the y value of the particle for sin wave
+         */
         this.sinYVal = new Point();
+        /**
+         * Stores the color of the particle
+         */
         this.color = new Color();
+        /**
+         * Stores the starting color of the particle
+         */
         this.colorStart = new Color();
+        /**
+         * Stores the ending color of the particle
+         */
         this.colorEnd = new Color();
         this.reset();
     }
+    /**
+     * Resets the particle object
+     */
     reset() {
         this.maxLifeTime = 0;
         this.lifeTime = 0;
@@ -57,12 +105,25 @@ export default class Particle {
         this.warpStretch = 5;
         this.warpDistanceScaleConverter = 2000;
     }
+    /**
+     * Checks if the particle is almost dead
+     *
+     * @return {boolean} True if the particle is almost dead, otherwise false
+     */
     isAlmostDead() {
         return this.lifeTime >= this.maxLifeTime - 0.1;
     }
+    /**
+     * Checks if the particle is dead
+     *
+     * @return {boolean} True if the particle is dead, otherwise false
+     */
     isDead() {
         return this.lifeTime >= this.maxLifeTime;
     }
+    /**
+     * Hides the particle
+     */
     hide() {
         if (!this.sprite)
             return;

package/dist/lib/Particle.js.map

@@ -1 +1 @@
-{"version":3,"file":"Particle.js","sourceRoot":"","sources":["../../src/lib/Particle.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAA;AAErC,MAAM,CAAC,OAAO,OAAO,QAAQ;IA6C3B;QA3CA,SAAI,GAAoB,IAAI,CAAA;QAC5B,SAAI,GAAoB,IAAI,CAAA;QAC5B,QAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAA;QAC3B,aAAQ,GAAG,IAAI,KAAK,EAAE,CAAA;QACtB,iBAAY,GAAG,IAAI,KAAK,EAAE,CAAA;QAC1B,aAAQ,GAAG,IAAI,KAAK,EAAE,CAAA;QACtB,SAAI,GAAG,IAAI,KAAK,EAAE,CAAA;QAClB,cAAS,GAAG,IAAI,KAAK,EAAE,CAAA;QACvB,kBAAa,GAAG,IAAI,KAAK,EAAE,CAAA;QAC3B,YAAO,GAAG,IAAI,KAAK,EAAE,CAAA;QACrB,YAAO,GAAG,IAAI,KAAK,EAAE,CAAA;QACrB,YAAO,GAAG,IAAI,KAAK,EAAE,CAAA;QACrB,UAAK,GAAG,IAAI,KAAK,EAAE,CAAA;QACnB,eAAU,GAAG,IAAI,KAAK,EAAE,CAAA;QACxB,aAAQ,GAAG,IAAI,KAAK,EAAE,CAAA;QA8BpB,IAAI,CAAC,KAAK,EAAE,CAAA;IACd,CAAC;IAED,KAAK;QACH,IAAI,CAAC,WAAW,GAAG,CAAC,CAAA;QACpB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAA;QACjB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAA;QACrB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAA;QACV,IAAI,CAAC,CAAC,GAAG,CAAC,CAAA;QACV,IAAI,CAAC,CAAC,GAAG,CAAC,CAAA;QAEV,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACvB,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAC3B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACvB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACtB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAEtB,IAAI,CAAC,aAAa,GAAG,CAAC,CAAA;QACtB,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAA;QACzB,IAAI,CAAC,MAAM,GAAG,CAAC,CAAA;QACf,IAAI,CAAC,WAAW,GAAG,CAAC,CAAA;QACpB,IAAI,CAAC,SAAS,GAAG,CAAC,CAAA;QAElB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAA;QACrB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAA;QAErB,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAA;QAEzB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAA;QACzB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;QAEvB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAA;QACjB,IAAI,CAAC,aAAa,GAAG,CAAC,CAAA;QAEtB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACnB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACxB,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAC5B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAEtB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;QAChC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QAC/B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QAE7B,IAAI,CAAC,OAAO,GAAG,CAAC,CAAA;QAChB,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAA;QAC1B,IAAI,CAAC,SAAS,GAAG,CAAC,CAAA;QAClB,IAAI,CAAC,aAAa,GAAG,CAAC,CAAA;QACtB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;QACjB,IAAI,CAAC,WAAW,GAAG,CAAC,CAAA;QACpB,IAAI,CAAC,0BAA0B,GAAG,IAAI,CAAA;IACxC,CAAC;IAED,YAAY;QACV,OAAO,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,WAAW,GAAG,GAAG,CAAA;IAChD,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,WAAW,CAAA;IAC1C,CAAC;IAED,IAAI;QACF,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,OAAM;QACxB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO;YAAE,OAAM;QAChC,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG,KAAK,CAAA;IAC7B,CAAC;;AA7GM,aAAI,GAAsB,EAAE,KAAK,EAAE,CAAC,EAAE,CAAA"}
+{"version":3,"file":"Particle.js","sourceRoot":"","sources":["../../src/lib/Particle.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAA;AAErC;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IA+M3B;;OAEG;IACH;QAhNA,SAAI,GAAoB,IAAI,CAAA;QAC5B,SAAI,GAAoB,IAAI,CAAA;QAE5B;;WAEG;QACH,QAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAA;QAE3B;;WAEG;QACH,aAAQ,GAAG,IAAI,KAAK,EAAE,CAAA;QAEtB;;WAEG;QACH,iBAAY,GAAG,IAAI,KAAK,EAAE,CAAA;QAE1B;;WAEG;QACH,aAAQ,GAAG,IAAI,KAAK,EAAE,CAAA;QAEtB;;WAEG;QACH,SAAI,GAAG,IAAI,KAAK,EAAE,CAAA;QAElB;;WAEG;QACH,cAAS,GAAG,IAAI,KAAK,EAAE,CAAA;QAEvB;;WAEG;QACH,kBAAa,GAAG,IAAI,KAAK,EAAE,CAAA;QAE3B;;WAEG;QACH,YAAO,GAAG,IAAI,KAAK,EAAE,CAAA;QAErB;;WAEG;QACH,YAAO,GAAG,IAAI,KAAK,EAAE,CAAA;QAErB;;WAEG;QACH,YAAO,GAAG,IAAI,KAAK,EAAE,CAAA;QAErB;;WAEG;QACH,UAAK,GAAG,IAAI,KAAK,EAAE,CAAA;QAEnB;;WAEG;QACH,eAAU,GAAG,IAAI,KAAK,EAAE,CAAA;QAExB;;WAEG;QACH,aAAQ,GAAG,IAAI,KAAK,EAAE,CAAA;QA+IpB,IAAI,CAAC,KAAK,EAAE,CAAA;IACd,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,WAAW,GAAG,CAAC,CAAA;QACpB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAA;QACjB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAA;QACrB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAA;QACV,IAAI,CAAC,CAAC,GAAG,CAAC,CAAA;QACV,IAAI,CAAC,CAAC,GAAG,CAAC,CAAA;QAEV,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACvB,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAC3B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACvB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACtB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAEtB,IAAI,CAAC,aAAa,GAAG,CAAC,CAAA;QACtB,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAA;QACzB,IAAI,CAAC,MAAM,GAAG,CAAC,CAAA;QACf,IAAI,CAAC,WAAW,GAAG,CAAC,CAAA;QACpB,IAAI,CAAC,SAAS,GAAG,CAAC,CAAA;QAElB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAA;QACrB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAA;QAErB,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAA;QAEzB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAA;QACzB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;QAEvB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAA;QACjB,IAAI,CAAC,aAAa,GAAG,CAAC,CAAA;QAEtB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACnB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACxB,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAC5B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAEtB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;QAChC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QAC/B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QAE7B,IAAI,CAAC,OAAO,GAAG,CAAC,CAAA;QAChB,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAA;QAC1B,IAAI,CAAC,SAAS,GAAG,CAAC,CAAA;QAClB,IAAI,CAAC,aAAa,GAAG,CAAC,CAAA;QACtB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;QACjB,IAAI,CAAC,WAAW,GAAG,CAAC,CAAA;QACpB,IAAI,CAAC,0BAA0B,GAAG,IAAI,CAAA;IACxC,CAAC;IAED;;;;OAIG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,WAAW,GAAG,GAAG,CAAA;IAChD,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,WAAW,CAAA;IAC1C,CAAC;IAED;;OAEG;IACH,IAAI;QACF,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,OAAM;QACxB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO;YAAE,OAAM;QAChC,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG,KAAK,CAAA;IAC7B,CAAC;;AAlSM,aAAI,GAAsB,EAAE,KAAK,EAAE,CAAC,EAAE,CAAA"}

package/dist/lib/ParticlePool.d.ts

@@ -1,9 +1,37 @@
 import Particle from './Particle';
+/**
+ * @class ParticlePool
+ * A class for managing a pool of particles.
+ */
 export default class ParticlePool {
+    /**
+     * A static global instance of ParticlePool.
+     */
     static global: ParticlePool;
+    /**
+     * The first element in the pool.
+     */
     first: Particle | null;
+    /**
+     * Removes a particle from the pool and returns it.
+     *
+     * @returns {Particle} The removed particle.
+     */
     pop(): Particle;
+    /**
+     * Creates a new particle.
+     *
+     * @returns {Particle} The newly created particle.
+     */
     create(): Particle;
+    /**
+     * Adds a particle to the pool.
+     *
+     * @param {Particle} particle The particle to add.
+     */
     push(particle: Particle): void;
+    /**
+     * Resets the particle pool.
+     */
     reset(): void;
 }

package/dist/lib/ParticlePool.js

@@ -1,8 +1,20 @@
 import Particle from './Particle';
+/**
+ * @class ParticlePool
+ * A class for managing a pool of particles.
+ */
 export default class ParticlePool {
     constructor() {
+        /**
+         * The first element in the pool.
+         */
         this.first = null;
     }
+    /**
+     * Removes a particle from the pool and returns it.
+     *
+     * @returns {Particle} The removed particle.
+     */
     pop() {
         if (!this.first)
             return this.create();
@@ -11,17 +23,33 @@ export default class ParticlePool {
         current.next = null;
         return current;
     }
+    /**
+     * Creates a new particle.
+     *
+     * @returns {Particle} The newly created particle.
+     */
     create() {
         return new Particle();
     }
+    /**
+     * Adds a particle to the pool.
+     *
+     * @param {Particle} particle The particle to add.
+     */
     push(particle) {
         particle.next = this.first;
         this.first = particle;
     }
+    /**
+     * Resets the particle pool.
+     */
     reset() {
         this.first = null;
         ParticlePool.global = new ParticlePool();
     }
 }
+/**
+ * A static global instance of ParticlePool.
+ */
 ParticlePool.global = new ParticlePool();
 //# sourceMappingURL=ParticlePool.js.map

package/dist/lib/ParticlePool.js.map

@@ -1 +1 @@
-{"version":3,"file":"ParticlePool.js","sourceRoot":"","sources":["../../src/lib/ParticlePool.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,YAAY,CAAA;AAEjC,MAAM,CAAC,OAAO,OAAO,YAAY;IAAjC;QAEE,UAAK,GAAoB,IAAI,CAAA;IAwB/B,CAAC;IAtBC,GAAG;QACD,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC,MAAM,EAAE,CAAA;QAErC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAA;QAC1B,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,CAAA;QACzB,OAAO,CAAC,IAAI,GAAG,IAAI,CAAA;QACnB,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,QAAQ,EAAE,CAAA;IACvB,CAAC;IAED,IAAI,CAAC,QAAkB;QACrB,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAA;QAC1B,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAA;IACvB,CAAC;IAED,KAAK;QACH,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACjB,YAAY,CAAC,MAAM,GAAG,IAAI,YAAY,EAAE,CAAA;IAC1C,CAAC;;AAxBM,mBAAM,GAAG,IAAI,YAAY,EAAE,CAAA"}
+{"version":3,"file":"ParticlePool.js","sourceRoot":"","sources":["../../src/lib/ParticlePool.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,YAAY,CAAA;AAEjC;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,YAAY;IAAjC;QAME;;WAEG;QACH,UAAK,GAAoB,IAAI,CAAA;IA0C/B,CAAC;IAxCC;;;;OAIG;IACH,GAAG;QACD,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC,MAAM,EAAE,CAAA;QAErC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAA;QAC1B,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,CAAA;QACzB,OAAO,CAAC,IAAI,GAAG,IAAI,CAAA;QACnB,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO,IAAI,QAAQ,EAAE,CAAA;IACvB,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,QAAkB;QACrB,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAA;QAC1B,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAA;IACvB,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACjB,YAAY,CAAC,MAAM,GAAG,IAAI,YAAY,EAAE,CAAA;IAC1C,CAAC;;AAjDD;;GAEG;AACI,mBAAM,GAAG,IAAI,YAAY,EAAE,CAAA"}

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

@@ -1,5 +1,11 @@
 import Behaviour from './Behaviour';
 import Particle from '../Particle';
+/**
+ * AngularVelocityBehaviour is a subclass of Behaviour and defines the angular velocity of a particle.
+ *
+ * @class AngularVelocityBehaviour
+ * @extends {Behaviour}
+ */
 export default class AngularVelocityBehaviour extends Behaviour {
     private enabled;
     private degrees;
@@ -9,9 +15,34 @@ export default class AngularVelocityBehaviour extends Behaviour {
     private minRadius;
     private minRadiusVariance;
     protected priority: number;
+    /**
+     * Initializes particle properties of the behaviour
+     *
+     * @param {Particle} particle - The current particle
+     * @memberof AngularVelocityBehaviour
+     */
     init: (particle: Particle) => void;
+    /**
+     * Applies the behaviour to the particle
+     *
+     * @param {Particle} particle - The current particle
+     * @param {number} deltaTime - Time elapsed since the last frame
+     * @memberof AngularVelocityBehaviour
+     */
     apply: (particle: Particle, deltaTime: number) => void;
+    /**
+     * Returns the name of the behaviour
+     *
+     * @returns {string} Name of the behaviour
+     * @memberof AngularVelocityBehaviour
+     */
     getName(): string;
+    /**
+     * Returns the properties of the behaviour
+     *
+     * @returns {object} Properties of the behaviour
+     * @memberof AngularVelocityBehaviour
+     */
     getProps(): {
         enabled: boolean;
         degrees: number;