pixi-particle-system 1.0.0

package/dist/Emitter.d.ts

@@ -0,0 +1,285 @@
+import { ParticleContainer } from 'pixi.js';
+import { AlphaBehavior } from './behavior/built-in/AlphaBehavior';
+import { ColorBehavior } from './behavior/built-in/ColorBehavior';
+import { MovementBehavior } from './behavior/built-in/MovementBehavior';
+import { RotationBehavior } from './behavior/built-in/RotationBehavior';
+import { ScaleBehavior } from './behavior/built-in/ScaleBehavior';
+import { SpawnBehavior } from './behavior/built-in/SpawnBehavior';
+import { TextureBehavior } from './behavior/built-in/TextureBehavior';
+import { InitBehavior, UpdateBehavior } from './behavior/EmitterBehavior';
+import { Ease } from './data/easing/Ease';
+import { EmitterConfig } from './EmitterConfig';
+import { BaseParticleData, EmitterParticle, IEmitterParticle } from './particle/EmitterParticle';
+/**
+ * Extra emitter options allowing for custom particles/particle data.
+ * @template DataType Type describing the data object stored on particles.
+ * @template ParticleType Type describing the particle used within the emitter.
+ * @group Emitter/
+ */
+export type EmitterOptions<DataType extends BaseParticleData = BaseParticleData, ParticleType extends IEmitterParticle<DataType> = IEmitterParticle<DataType>> = {
+    /**
+     * Creates and returns object containing particle data. By default,
+     * uses {@link BaseParticleData} object to store particle data.
+     * @returns New particle data object.
+     */
+    dataFactory?: () => DataType;
+    /**
+     * Creates and returns new instance of a particle. By default,
+     * uses {@link EmitterParticle} as the base particle class.
+     * @param data Data used by the particle.
+     * @returns New particle instance.
+     */
+    particleFactory?: (data: DataType) => ParticleType;
+    /**
+     * Initializes any custom data for the particles. By default,
+     * does nothing, as there is no custom data.
+     * @param data Data used by the particle.
+     */
+    customDataInitializer?: (data: DataType) => void;
+};
+/**
+ * Class responsible for spawning and managing particles using various behaviors.
+ *
+ * Emitter is the core class of the particle system, handling particle creation, updating,
+ * and recycling. It utilizes a set of behaviors to define how particles are initialized
+ * and updated over their lifetime.
+ * @example
+ * ```ts
+ * const emitter = new Emitter(particleContainer, {
+ *   emitterVersion: 0,
+ *   minParticleLifetime: 1,
+ *   maxParticleLifetime: 3,
+ *   spawnInterval: 0.1,
+ *   maxParticles: 500,
+ *   alphaBehavior: {
+ *     mode: "list",
+ *     list: [1, 0]
+ *   },
+ *   scaleBehavior: {
+ *     mode: "random",
+ *     xList: [0.5, 1],
+ *     yList: [0.5, 1]
+ *   }
+ * });
+ *
+ * emitter.play();
+ * ```
+ * @template DataType Type describing the data object stored on particles.
+ * @template ParticleType Type describing the particle used within the emitter.
+ * @group Emitter
+ */
+export declare class Emitter<DataType extends BaseParticleData = BaseParticleData, ParticleType extends IEmitterParticle<DataType> = EmitterParticle<DataType>> {
+    private readonly _version;
+    private readonly _dataFactory;
+    private readonly _particleFactory;
+    private readonly _customDataInitializer;
+    private readonly _parent;
+    private readonly _particles;
+    private readonly _pooledParticles;
+    private readonly _initBehaviors;
+    private readonly _updateBehaviors;
+    private readonly _alphaBehavior;
+    private readonly _colorBehavior;
+    private readonly _movementBehavior;
+    private readonly _rotationBehavior;
+    private readonly _scaleBehavior;
+    private readonly _spawnBehavior;
+    private readonly _textureBehavior;
+    private _ease;
+    private _easeFunction;
+    private _minLifetime;
+    private _maxLifetime;
+    private _spawnInterval;
+    private _spawnChance;
+    private _maxParticles;
+    private _addAtBack;
+    private _particlesPerWave;
+    private _particleCount;
+    private _spawnTimer;
+    private _emitterLife;
+    private _onComplete;
+    private _isActive;
+    private _isEmitting;
+    private _isPaused;
+    /**
+     * Creates a new Emitter.
+     * @param parent Parent ParticleContainer to which particles will be added.
+     * @param initialConfig Optional initial configuration for the emitter.
+     * @param options Optional factories and initializers for custom particle data and particles.
+     */
+    constructor(parent: ParticleContainer, initialConfig?: EmitterConfig, options?: EmitterOptions<DataType, ParticleType>);
+    /**
+     * Current version of the emitter.
+     */
+    get version(): string;
+    /**
+     * Parent ParticleContainer of the emitter.
+     */
+    get parent(): ParticleContainer;
+    /**
+     * Number of active particles in the emitter.
+     */
+    get particleCount(): number;
+    /**
+     * Whether the emitter is currently emitting new particles.
+     */
+    get isEmitting(): boolean;
+    /**
+     * Whether the emitter is currently paused.
+     */
+    get isPaused(): boolean;
+    /**
+     * Minimum lifetime of particles in seconds.
+     */
+    get minLifetime(): number;
+    set minLifetime(value: number);
+    /**
+     * Maximum lifetime of particles in seconds.
+     */
+    get maxLifetime(): number;
+    set maxLifetime(value: number);
+    /**
+     * Interval between particle spawns in seconds.
+     */
+    get spawnInterval(): number;
+    set spawnInterval(value: number);
+    /**
+     * Chance of spawning a particle (0.0 - 1.0).
+     */
+    get spawnChance(): number;
+    set spawnChance(value: number);
+    /**
+     * Maximum number of particles allowed in the emitter.
+     */
+    get maxParticles(): number;
+    set maxParticles(value: number);
+    /**
+     * Whether to add new particles at the back of the container.
+     */
+    get addAtBack(): boolean;
+    set addAtBack(value: boolean);
+    /**
+     * Number of particles to spawn per wave.
+     */
+    get particlesPerWave(): number;
+    set particlesPerWave(value: number);
+    /**
+     * Ease applied to particle lifetime.
+     */
+    get ease(): Ease;
+    set ease(value: Ease);
+    /**
+     * Alpha behavior of the emitter.
+     */
+    get alphaBehavior(): AlphaBehavior<DataType, ParticleType>;
+    /**
+     * Color behavior of the emitter.
+     */
+    get colorBehavior(): ColorBehavior<DataType, ParticleType>;
+    /**
+     * Movement behavior of the emitter.
+     */
+    get movementBehavior(): MovementBehavior<DataType, ParticleType>;
+    /**
+     * Rotation behavior of the emitter.
+     */
+    get rotationBehavior(): RotationBehavior<DataType, ParticleType>;
+    /**
+     * Scale behavior of the emitter.
+     */
+    get scaleBehavior(): ScaleBehavior<DataType, ParticleType>;
+    /**
+     * Spawn behavior of the emitter.
+     */
+    get spawnBehavior(): SpawnBehavior<DataType, ParticleType>;
+    /**
+     * Texture behavior of the emitter.
+     */
+    get textureBehavior(): TextureBehavior<DataType, ParticleType>;
+    /**
+     * Applies a configuration to the emitter.
+     * @param config Configuration to apply.
+     */
+    applyConfig(config: EmitterConfig): void;
+    /**
+     * Retrieves the current configuration for emitter and its behaviors.
+     * @returns Current configuration object.
+     */
+    getConfig(): EmitterConfig;
+    /**
+     * Starts the emitter and hooks into the shared ticker.
+     */
+    play(): void;
+    /**
+     * Pauses the emitter by unhooking from the shared ticker.
+     */
+    pause(): void;
+    /**
+     * Resumes the emitter by rehooking into the shared ticker.
+     */
+    resume(): void;
+    /**
+     * Stops new particles from spawning, and lets existing particles die naturally.
+     * @param instant When true, particles are removed instantly.
+     */
+    stop(instant?: boolean): void;
+    /**
+     * Prewarms the emitter by simulating particle spawning and updating for a given time.
+     * @param time Time in seconds to prewarm the emitter.
+     */
+    prewarm(time: number): void;
+    /**
+     * Checks if a behavior is currently active in the emitter's init behaviors.
+     * @param behavior Behavior to check.
+     * @returns Whether the behavior is active.
+     */
+    isBehaviorInitActive(behavior: InitBehavior<DataType, ParticleType>): boolean;
+    /**
+     * Checks if a behavior is currently active in the emitter's update behaviors.
+     * @param behavior Behavior to check.
+     * @returns Whether the behavior is active.
+     */
+    isBehaviorUpdateActive(behavior: UpdateBehavior<DataType, ParticleType>): boolean;
+    /**
+     * Adds a behavior to the active init behaviors.
+     * @param behavior Behavior to add.
+     */
+    addToActiveInitBehaviors(behavior: InitBehavior<DataType, ParticleType>): void;
+    /**
+     * Adds a behavior to the active update behaviors.
+     * @param behavior Behavior to add.
+     */
+    addToActiveUpdateBehaviors(behavior: UpdateBehavior<DataType, ParticleType>): void;
+    /**
+     * Removes a behavior from the active init behaviors.
+     * @param behavior Behavior to remove.
+     */
+    removeFromActiveInitBehaviors(behavior: InitBehavior<DataType, ParticleType>): void;
+    /**
+     * Removes a behavior from the active update behaviors.
+     * @param behavior Behavior to remove.
+     */
+    removeFromActiveUpdateBehaviors(behavior: UpdateBehavior<DataType, ParticleType>): void;
+    /**
+     * Updates the emitter.
+     * @param ticker Ticker instance.
+     */
+    private update;
+    /**
+     * Recycles a particle back into the pool.
+     * @param particle Particle to recycle.
+     */
+    private recycleParticle;
+    /**
+     * Parses a version string into major/minor/patch components.
+     * @param version Version string to parse.
+     * @returns Parsed version components.
+     */
+    private parseVersionString;
+    /**
+     * Checks compatibility between the emitter version and config version.
+     * @param configVersion Config version to check.
+     */
+    private checkCompatibility;
+}
+//# sourceMappingURL=Emitter.d.ts.map

package/dist/Emitter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Emitter.d.ts","sourceRoot":"","sources":["../src/Emitter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAU,MAAM,SAAS,CAAC;AAEpD,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AACxE,OAAO,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AACtE,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC1E,OAAO,EAAE,IAAI,EAAiC,MAAM,oBAAoB,CAAC;AACzE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EACH,gBAAgB,EAEhB,eAAe,EACf,gBAAgB,EACnB,MAAM,4BAA4B,CAAC;AAEpC;;;;;GAKG;AACH,MAAM,MAAM,cAAc,CACtB,QAAQ,SAAS,gBAAgB,GAAG,gBAAgB,EACpD,YAAY,SAAS,gBAAgB,CAAC,QAAQ,CAAC,GAC3C,gBAAgB,CAAC,QAAQ,CAAC,IAC9B;IACA;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,QAAQ,CAAC;IAE7B;;;;;OAKG;IACH,eAAe,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,YAAY,CAAC;IAEnD;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC;CACpD,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,OAAO,CAChB,QAAQ,SAAS,gBAAgB,GAAG,gBAAgB,EACpD,YAAY,SAAS,gBAAgB,CAAC,QAAQ,CAAC,GAAG,eAAe,CAAC,QAAQ,CAAC;IAE3E,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAuB;IAEhD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAiB;IAC9C,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAmC;IACpE,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAA2B;IAElE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;IAE5C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAsB;IACjD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAsB;IAGvD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA8C;IAE7E,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAgD;IAGjF,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAwC;IAEvE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAwC;IAEvE,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA2C;IAE7E,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA2C;IAE7E,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAwC;IAEvE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAwC;IAEvE,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA0C;IAE3E,OAAO,CAAC,KAAK,CAAkB;IAC/B,OAAO,CAAC,aAAa,CAA6B;IAElD,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,YAAY,CAAa;IAEjC,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,YAAY,CAAe;IAEnC,OAAO,CAAC,aAAa,CAAe;IACpC,OAAO,CAAC,UAAU,CAAiB;IAEnC,OAAO,CAAC,iBAAiB,CAAa;IAEtC,OAAO,CAAC,cAAc,CAAa;IAEnC,OAAO,CAAC,WAAW,CAAa;IAChC,OAAO,CAAC,YAAY,CAAc;IAElC,OAAO,CAAC,WAAW,CAA6B;IAEhD,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,SAAS,CAAkB;IAEnC;;;;;OAKG;gBAEC,MAAM,EAAE,iBAAiB,EACzB,aAAa,CAAC,EAAE,aAAa,EAC7B,OAAO,CAAC,EAAE,cAAc,CAAC,QAAQ,EAAE,YAAY,CAAC;IAiCpD;;OAEG;IACH,IAAW,OAAO,IAAI,MAAM,CAE3B;IAED;;OAEG;IACH,IAAW,MAAM,IAAI,iBAAiB,CAErC;IAED;;OAEG;IACH,IAAW,aAAa,IAAI,MAAM,CAEjC;IAED;;OAEG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;;OAEG;IACH,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,MAAM,CAE/B;IACD,IAAW,WAAW,CAAC,KAAK,EAAE,MAAM,EAEnC;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,MAAM,CAE/B;IACD,IAAW,WAAW,CAAC,KAAK,EAAE,MAAM,EAEnC;IAED;;OAEG;IACH,IAAW,aAAa,IAAI,MAAM,CAEjC;IACD,IAAW,aAAa,CAAC,KAAK,EAAE,MAAM,EAErC;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,MAAM,CAE/B;IACD,IAAW,WAAW,CAAC,KAAK,EAAE,MAAM,EAEnC;IAED;;OAEG;IACH,IAAW,YAAY,IAAI,MAAM,CAEhC;IACD,IAAW,YAAY,CAAC,KAAK,EAAE,MAAM,EAEpC;IAED;;OAEG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;IACD,IAAW,SAAS,CAAC,KAAK,EAAE,OAAO,EAElC;IAED;;OAEG;IACH,IAAW,gBAAgB,IAAI,MAAM,CAEpC;IACD,IAAW,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAExC;IAED;;OAEG;IACH,IAAW,IAAI,IAAI,IAAI,CAEtB;IACD,IAAW,IAAI,CAAC,KAAK,EAAE,IAAI,EAG1B;IAED;;OAEG;IACH,IAAW,aAAa,IAAI,aAAa,CAAC,QAAQ,EAAE,YAAY,CAAC,CAEhE;IAED;;OAEG;IACH,IAAW,aAAa,IAAI,aAAa,CAAC,QAAQ,EAAE,YAAY,CAAC,CAEhE;IAED;;OAEG;IACH,IAAW,gBAAgB,IAAI,gBAAgB,CAAC,QAAQ,EAAE,YAAY,CAAC,CAEtE;IAED;;OAEG;IACH,IAAW,gBAAgB,IAAI,gBAAgB,CAAC,QAAQ,EAAE,YAAY,CAAC,CAEtE;IAED;;OAEG;IACH,IAAW,aAAa,IAAI,aAAa,CAAC,QAAQ,EAAE,YAAY,CAAC,CAEhE;IAED;;OAEG;IACH,IAAW,aAAa,IAAI,aAAa,CAAC,QAAQ,EAAE,YAAY,CAAC,CAEhE;IAED;;OAEG;IACH,IAAW,eAAe,IAAI,eAAe,CAAC,QAAQ,EAAE,YAAY,CAAC,CAEpE;IAGD;;;OAGG;IACI,WAAW,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI;IAgD/C;;;OAGG;IACI,SAAS,IAAI,aAAa;IAqBjC;;OAEG;IACI,IAAI,IAAI,IAAI;IASnB;;OAEG;IACI,KAAK,IAAI,IAAI;IAOpB;;OAEG;IACI,MAAM,IAAI,IAAI;IAOrB;;;OAGG;IACI,IAAI,CAAC,OAAO,GAAE,OAAe,GAAG,IAAI;IAyB3C;;;OAGG;IACI,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAyElC;;;;OAIG;IACI,oBAAoB,CACvB,QAAQ,EAAE,YAAY,CAAC,QAAQ,EAAE,YAAY,CAAC,GAC/C,OAAO;IAIV;;;;OAIG;IACI,sBAAsB,CACzB,QAAQ,EAAE,cAAc,CAAC,QAAQ,EAAE,YAAY,CAAC,GACjD,OAAO;IAIV;;;OAGG;IACI,wBAAwB,CAC3B,QAAQ,EAAE,YAAY,CAAC,QAAQ,EAAE,YAAY,CAAC,GAC/C,IAAI;IAiBP;;;OAGG;IACI,0BAA0B,CAC7B,QAAQ,EAAE,cAAc,CAAC,QAAQ,EAAE,YAAY,CAAC,GACjD,IAAI;IAiBP;;;OAGG;IACI,6BAA6B,CAChC,QAAQ,EAAE,YAAY,CAAC,QAAQ,EAAE,YAAY,CAAC,GAC/C,IAAI;IAQP;;;OAGG;IACI,+BAA+B,CAClC,QAAQ,EAAE,cAAc,CAAC,QAAQ,EAAE,YAAY,CAAC,GACjD,IAAI;IAQP;;;OAGG;IACH,OAAO,CAAC,MAAM;IA4Id;;;OAGG;IACH,OAAO,CAAC,eAAe;IAQvB;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAc1B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;CA2B7B"}

package/dist/EmitterConfig.d.ts

@@ -0,0 +1,79 @@
+import { AlphaBehaviorConfig } from './behavior/built-in/AlphaBehavior';
+import { ColorBehaviorConfig } from './behavior/built-in/ColorBehavior';
+import { MovementBehaviorConfig } from './behavior/built-in/MovementBehavior';
+import { RotationBehaviorConfig } from './behavior/built-in/RotationBehavior';
+import { ScaleBehaviorConfig } from './behavior/built-in/ScaleBehavior';
+import { SpawnBehaviorConfig } from './behavior/built-in/SpawnBehavior';
+import { TextureBehaviorConfig } from './behavior/built-in/TextureBehavior';
+import { Ease } from './data/easing/Ease';
+/**
+ * Type describing the configuration options for an Emitter.
+ * @group Emitter/
+ */
+export type EmitterConfig = {
+    /**
+     * Emitter version this config was made for.
+     */
+    emitterVersion: string;
+    /**
+     * Minimum lifetime of particles emitted, in seconds.
+     */
+    minParticleLifetime?: number;
+    /**
+     * Maximum lifetime of particles emitted, in seconds.
+     */
+    maxParticleLifetime?: number;
+    /**
+     * Interval between spawn waves, in seconds.
+     */
+    spawnInterval?: number;
+    /**
+     * Chance of spawning particles each wave, between 0 and 1.
+     */
+    spawnChance?: number;
+    /**
+     * Maximum number of particles allowed alive at once.
+     */
+    maxParticles?: number;
+    /**
+     * Whether new particles are added to the back of the particle list (behind other particles).
+     */
+    addAtBack?: boolean;
+    /**
+     * Number of particles to spawn each wave.
+     */
+    particlesPerWave?: number;
+    /**
+     * Easing applied to particle's lifetime.
+     */
+    ease?: Ease;
+    /**
+     * Configuration for the AlphaBehavior.
+     */
+    alphaBehavior?: AlphaBehaviorConfig;
+    /**
+     * Configuration for the ColorBehavior.
+     */
+    colorBehavior?: ColorBehaviorConfig;
+    /**
+     * Configuration for the MovementBehavior.
+     */
+    movementBehavior?: MovementBehaviorConfig;
+    /**
+     * Configuration for the RotationBehavior.
+     */
+    rotationBehavior?: RotationBehaviorConfig;
+    /**
+     * Configuration for the ScaleBehavior.
+     */
+    scaleBehavior?: ScaleBehaviorConfig;
+    /**
+     * Configuration for the SpawnBehavior.
+     */
+    spawnBehavior?: SpawnBehaviorConfig;
+    /**
+     * Configuration for the TextureBehavior.
+     */
+    textureBehavior?: TextureBehaviorConfig;
+};
+//# sourceMappingURL=EmitterConfig.d.ts.map

package/dist/EmitterConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EmitterConfig.d.ts","sourceRoot":"","sources":["../src/EmitterConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAC9E,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAC9E,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAE1C;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IACxB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,IAAI,CAAC,EAAE,IAAI,CAAC;IAEZ;;OAEG;IACH,aAAa,CAAC,EAAE,mBAAmB,CAAC;IAEpC;;OAEG;IACH,aAAa,CAAC,EAAE,mBAAmB,CAAC;IAEpC;;OAEG;IACH,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;IAE1C;;OAEG;IACH,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;IAE1C;;OAEG;IACH,aAAa,CAAC,EAAE,mBAAmB,CAAC;IAEpC;;OAEG;IACH,aAAa,CAAC,EAAE,mBAAmB,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,qBAAqB,CAAC;CAC3C,CAAC"}

package/dist/behavior/EmitterBehavior.d.ts

@@ -0,0 +1,79 @@
+import { Emitter } from '../Emitter';
+import { BaseParticleData, IEmitterParticle } from '../particle/EmitterParticle';
+import { BehaviorOrder } from '../util/Types';
+/**
+ * Abstract base for all behavior to build upon.
+ *
+ * This class provides the foundational structure and methods that all
+ * emitter behaviors must implement, ensuring consistency and interoperability.
+ *
+ * In addition to the core functionality, this class also defines interfaces
+ * for behaviors that initialize particles ({@link InitBehavior}) and
+ * those that update particles ({@link UpdateBehavior}) during the emitter's update cycle.
+ * @template ConfigType Type describing the configuration object for this behavior.
+ * @template DataType Type describing the data object stored on particles.
+ * @template ParticleType Type describing the particle used within the emitter.
+ * @group Behavior/EmitterBehavior
+ */
+export declare abstract class EmitterBehavior<ConfigType, DataType extends BaseParticleData = BaseParticleData, ParticleType extends IEmitterParticle<DataType> = IEmitterParticle<DataType>> {
+    /**
+     * @hidden
+     */
+    protected readonly _emitter: Emitter<DataType, ParticleType>;
+    /**
+     * Creates a new instance of the behavior.
+     * @param emitter Emitter instance this behavior belongs to.
+     */
+    constructor(emitter: Emitter<DataType, ParticleType>);
+    /**
+     * Defines at which step of the update cycle the behavior is applied.
+     *
+     * - `initial`: Earliest step, useful when other behaviors depend on this behavior.
+     * - `normal`: Default step for most behaviors.
+     * - `late`: Latest step, useful for behaviors that should override others or depend on their properties.
+     */
+    abstract get updateOrder(): BehaviorOrder;
+    /**
+     * Reset the behavior and apply the provided configuration.
+     * @param config Behavior configuration.
+     */
+    applyConfig(config: ConfigType): void;
+    /**
+     * Retrieve the current behavior properties as a configuration object.
+     * If the behavior is inactive, `undefined` is returned.
+     * @returns Behavior configuration object or `undefined` if inactive.
+     */
+    abstract getConfig(): ConfigType | undefined;
+    /**
+     * Reset the behavior to its default state.
+     */
+    protected abstract reset(): void;
+}
+/**
+ * Interface defining behaviors which update particles when they are first created.
+ * @template DataType Type describing the data object stored on particles.
+ * @template ParticleType Type describing the particle used within the emitter.
+ * @group Behavior/EmitterBehavior/
+ */
+export interface InitBehavior<DataType extends BaseParticleData = BaseParticleData, ParticleType extends IEmitterParticle<DataType> = IEmitterParticle<DataType>> extends EmitterBehavior<unknown, DataType, ParticleType> {
+    /**
+     * Initialize the particle.
+     * @param particle Particle to initialize.
+     */
+    init(particle: ParticleType): void;
+}
+/**
+ * Interface defining behaviors which update particles on each update cycle.
+ * @template DataType Type describing the data object stored on particles.
+ * @template ParticleType Type describing the particle used within the emitter.
+ * @group Behavior/EmitterBehavior/
+ */
+export interface UpdateBehavior<DataType extends BaseParticleData = BaseParticleData, ParticleType extends IEmitterParticle<DataType> = IEmitterParticle<DataType>> extends EmitterBehavior<unknown, DataType, ParticleType> {
+    /**
+     * Updates the particle.
+     * @param particle Particle to update.
+     * @param deltaTime Time elapsed since the last update, in seconds.
+     */
+    update(particle: ParticleType, deltaTime: number): void;
+}
+//# sourceMappingURL=EmitterBehavior.d.ts.map

package/dist/behavior/EmitterBehavior.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EmitterBehavior.d.ts","sourceRoot":"","sources":["../../src/behavior/EmitterBehavior.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EACH,gBAAgB,EAChB,gBAAgB,EACnB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAE9C;;;;;;;;;;;;;GAaG;AACH,8BAAsB,eAAe,CACjC,UAAU,EACV,QAAQ,SAAS,gBAAgB,GAAG,gBAAgB,EACpD,YAAY,SAAS,gBAAgB,CAAC,QAAQ,CAAC,GAC3C,gBAAgB,CAAC,QAAQ,CAAC;IAE9B;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAE7D;;;OAGG;gBACS,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,YAAY,CAAC;IAIpD;;;;;;OAMG;IACH,aAAoB,WAAW,IAAI,aAAa,CAAC;IAEjD;;;OAGG;IACI,WAAW,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI;IAM5C;;;;OAIG;aACa,SAAS,IAAI,UAAU,GAAG,SAAS;IAEnD;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,KAAK,IAAI,IAAI;CACnC;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY,CACzB,QAAQ,SAAS,gBAAgB,GAAG,gBAAgB,EACpD,YAAY,SAAS,gBAAgB,CAAC,QAAQ,CAAC,GAC3C,gBAAgB,CAAC,QAAQ,CAAC,CAChC,SAAQ,eAAe,CAAC,OAAO,EAAE,QAAQ,EAAE,YAAY,CAAC;IACtD;;;OAGG;IACH,IAAI,CAAC,QAAQ,EAAE,YAAY,GAAG,IAAI,CAAC;CACtC;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc,CAC3B,QAAQ,SAAS,gBAAgB,GAAG,gBAAgB,EACpD,YAAY,SAAS,gBAAgB,CAAC,QAAQ,CAAC,GAC3C,gBAAgB,CAAC,QAAQ,CAAC,CAChC,SAAQ,eAAe,CAAC,OAAO,EAAE,QAAQ,EAAE,YAAY,CAAC;IACtD;;;;OAIG;IACH,MAAM,CAAC,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3D"}

package/dist/behavior/built-in/AlphaBehavior.d.ts

@@ -0,0 +1,98 @@
+import { NumberList } from '../../data/list/NumberList';
+import { Emitter } from '../../Emitter';
+import { BaseParticleData, IEmitterParticle } from '../../particle/EmitterParticle';
+import { BehaviorOrder, BehaviorSingleListConfig, BehaviorStaticConfig } from '../../util/Types';
+import { EmitterBehavior, InitBehavior, UpdateBehavior } from '../EmitterBehavior';
+/**
+ * Type defining the configuration for AlphaBehavior.
+ */
+export type AlphaBehaviorConfig = BehaviorStaticConfig<number> | BehaviorSingleListConfig<number>;
+/**
+ * Behavior used to control the transparency of particles over their lifetime.
+ *
+ * Behavior supports three modes, a `static` mode where a single value is applied to all particles,
+ * a `list` mode where values are interpolated over the particle's lifetime based on a provided list,
+ * and a `random` mode where a random value from the list is applied to the particle upon initialization.
+ * @see {@link BehaviorStaticConfig} for static configuration options.
+ * @see {@link BehaviorSingleListConfig} for list configuration options.
+ * @template DataType Type describing the data object stored on particles.
+ * @template ParticleType Type describing the particle used within the emitter.
+ * @group Behavior/AlphaBehavior
+ * @example
+ * ```ts
+ * // Apply a static alpha value of 0.5 to all particles.
+ * alphaBehavior.applyConfig({
+ *     value: 0.5
+ * });
+ *
+ * // Interpolate particle alpha from 0.0 to 1.0 over lifetime.
+ * alphaBehavior.applyConfig({
+ *    listData: [
+ *         { time: 0.0, value: 0.0 },
+ *         { time: 1.0, value: 1.0 }
+ *    ],
+ *   mode: "list"
+ * });
+ *
+ * // Assign a random alpha value between 0.2 and 0.8.
+ * alphaBehavior.applyConfig({
+ *    listData: [
+ *         { time: 0.0, value: 0.2 },
+ *         { time: 1.0, value: 0.8 }
+ *    ],
+ *   mode: "random"
+ * });
+ * ```
+ */
+export declare class AlphaBehavior<DataType extends BaseParticleData = BaseParticleData, ParticleType extends IEmitterParticle<DataType> = IEmitterParticle<DataType>> extends EmitterBehavior<AlphaBehaviorConfig, DataType, ParticleType> implements InitBehavior<DataType, ParticleType>, UpdateBehavior<DataType, ParticleType> {
+    private readonly _list;
+    private _staticValue;
+    private _mode;
+    /**
+     * Creates new instance of AlphaBehavior.
+     * @param emitter Emitter instance this behavior belongs to.
+     */
+    constructor(emitter: Emitter<DataType, ParticleType>);
+    /**
+     * @inheritdoc
+     */
+    get updateOrder(): BehaviorOrder;
+    /**
+     * Number list used to interpolate alpha values over particle lifetime.
+     *
+     * A behavior will always have a list, even when not using list-based configuration,
+     * but the list might not be initialized and will be empty in that case.
+     */
+    get list(): NumberList;
+    /**
+     * Mode currently used by the behavior.
+     */
+    get mode(): "static" | "list" | "random";
+    set mode(value: "static" | "list" | "random");
+    /**
+     * Alpha value applied to all particles in `static` mode.
+     */
+    get staticValue(): number;
+    set staticValue(value: number);
+    /**
+     * @inheritdoc
+     */
+    applyConfig(config: AlphaBehaviorConfig): void;
+    /**
+     * @inheritdoc
+     */
+    getConfig(): AlphaBehaviorConfig | undefined;
+    /**
+     * @inheritdoc
+     */
+    init(particle: ParticleType): void;
+    /**
+     * @inheritdoc
+     */
+    update(particle: ParticleType): void;
+    /**
+     * @inheritdoc
+     */
+    protected reset(): void;
+}
+//# sourceMappingURL=AlphaBehavior.d.ts.map

package/dist/behavior/built-in/AlphaBehavior.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AlphaBehavior.d.ts","sourceRoot":"","sources":["../../../src/behavior/built-in/AlphaBehavior.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EACH,gBAAgB,EAChB,gBAAgB,EACnB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACH,aAAa,EACb,wBAAwB,EACxB,oBAAoB,EACvB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACH,eAAe,EACf,YAAY,EACZ,cAAc,EACjB,MAAM,oBAAoB,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,mBAAmB,GACzB,oBAAoB,CAAC,MAAM,CAAC,GAC5B,wBAAwB,CAAC,MAAM,CAAC,CAAC;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,qBAAa,aAAa,CACtB,QAAQ,SAAS,gBAAgB,GAAG,gBAAgB,EACpD,YAAY,SAAS,gBAAgB,CAAC,QAAQ,CAAC,GAC3C,gBAAgB,CAAC,QAAQ,CAAC,CAE9B,SAAQ,eAAe,CAAC,mBAAmB,EAAE,QAAQ,EAAE,YAAY,CACnE,YACI,YAAY,CAAC,QAAQ,EAAE,YAAY,CAAC,EACpC,cAAc,CAAC,QAAQ,EAAE,YAAY,CAAC;IAE1C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAa;IAEnC,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,KAAK,CAA0C;IAEvD;;;OAGG;gBACS,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,YAAY,CAAC;IAMpD;;OAEG;IACH,IAAW,WAAW,IAAI,aAAa,CAEtC;IAED;;;;;OAKG;IACH,IAAW,IAAI,IAAI,UAAU,CAE5B;IAED;;OAEG;IACH,IAAW,IAAI,IAAI,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAE9C;IACD,IAAW,IAAI,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,EAQlD;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,MAAM,CAE/B;IACD,IAAW,WAAW,CAAC,KAAK,EAAE,MAAM,EAEnC;IAED;;OAEG;IACI,WAAW,CAAC,MAAM,EAAE,mBAAmB,GAAG,IAAI;IAqBrD;;OAEG;IACI,SAAS,IAAI,mBAAmB,GAAG,SAAS;IAwBnD;;OAEG;IACI,IAAI,CAAC,QAAQ,EAAE,YAAY,GAAG,IAAI;IAczC;;OAEG;IACI,MAAM,CAAC,QAAQ,EAAE,YAAY,GAAG,IAAI;IAI3C;;OAEG;IACH,SAAS,CAAC,KAAK,IAAI,IAAI;CAO1B"}

package/dist/behavior/built-in/ColorBehavior.d.ts

@@ -0,0 +1,98 @@
+import { ColorList } from '../../data/list/ColorList';
+import { Emitter } from '../../Emitter';
+import { BaseParticleData, IEmitterParticle } from '../../particle/EmitterParticle';
+import { BehaviorOrder, BehaviorSingleListConfig, BehaviorStaticConfig } from '../../util/Types';
+import { EmitterBehavior, InitBehavior, UpdateBehavior } from '../EmitterBehavior';
+/**
+ * Type defining the configuration for ColorBehavior.
+ */
+export type ColorBehaviorConfig = BehaviorStaticConfig<string> | BehaviorSingleListConfig<string>;
+/**
+ * Behavior used to control the color tint of particles over their lifetime.
+ *
+ * Behavior supports three modes, a `static` mode where a single value is applied to all particles,
+ * a `list` mode where values are interpolated over the particle's lifetime based on a provided list,
+ * and a `random` mode where a random value from the list is applied to the particle upon initialization.
+ * @see {@link BehaviorStaticConfig} for static configuration options.
+ * @see {@link BehaviorSingleListConfig} for list configuration options.
+ * @template DataType Type describing the data object stored on particles.
+ * @template ParticleType Type describing the particle used within the emitter.
+ * @group Behavior/ColorBehavior
+ * @example
+ * ```ts
+ * // Apply a static tint to all particles.
+ * alphaBehavior.applyConfig({
+ *     value: "#ff00ff"
+ * });
+ *
+ * // Interpolate particle tint from white to black over lifetime.
+ * alphaBehavior.applyConfig({
+ *    listData: [
+ *         { time: 0.0, value: "#ffffff" },
+ *         { time: 1.0, value: "#000000" }
+ *    ],
+ *   mode: "list"
+ * });
+ *
+ * // Assign a random tint value between the two stops.
+ * alphaBehavior.applyConfig({
+ *    listData: [
+ *         { time: 0.0, value: "#ff00ff" },
+ *         { time: 1.0, value: "#00ff00" }
+ *    ],
+ *   mode: "random"
+ * });
+ * ```
+ */
+export declare class ColorBehavior<DataType extends BaseParticleData, ParticleType extends IEmitterParticle<DataType> = IEmitterParticle<DataType>> extends EmitterBehavior<ColorBehaviorConfig, DataType, ParticleType> implements InitBehavior<DataType, ParticleType>, UpdateBehavior<DataType, ParticleType> {
+    private readonly _list;
+    private _staticValue;
+    private _mode;
+    /**
+     * Creates new instance of ColorBehavior.
+     * @param emitter Emitter instance this behavior belongs to.
+     */
+    constructor(emitter: Emitter<DataType, ParticleType>);
+    /**
+     * @inheritdoc
+     */
+    get updateOrder(): BehaviorOrder;
+    /**
+     * Color list used to interpolate tint values over particle lifetime.
+     *
+     * A behavior will always have a list, even when not using list-based configuration,
+     * but the list might not be initialized and will be empty in that case.
+     */
+    get list(): ColorList;
+    /**
+     * Mode currently used by the behavior.
+     */
+    get mode(): "static" | "list" | "random";
+    set mode(value: "static" | "list" | "random");
+    /**
+     * Tint value applied to all particles in `static` mode.
+     */
+    get staticValue(): string;
+    set staticValue(value: string);
+    /**
+     * @inheritdoc
+     */
+    applyConfig(config: ColorBehaviorConfig): void;
+    /**
+     * @inheritdoc
+     */
+    getConfig(): ColorBehaviorConfig | undefined;
+    /**
+     * @inheritdoc
+     */
+    init(particle: ParticleType): void;
+    /**
+     * @inheritdoc
+     */
+    update(particle: ParticleType): void;
+    /**
+     * @inheritdoc
+     */
+    protected reset(): void;
+}
+//# sourceMappingURL=ColorBehavior.d.ts.map

package/dist/behavior/built-in/ColorBehavior.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ColorBehavior.d.ts","sourceRoot":"","sources":["../../../src/behavior/built-in/ColorBehavior.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EACH,gBAAgB,EAChB,gBAAgB,EACnB,MAAM,gCAAgC,CAAC;AAExC,OAAO,EACH,aAAa,EACb,wBAAwB,EACxB,oBAAoB,EACvB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACH,eAAe,EACf,YAAY,EACZ,cAAc,EACjB,MAAM,oBAAoB,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,mBAAmB,GACzB,oBAAoB,CAAC,MAAM,CAAC,GAC5B,wBAAwB,CAAC,MAAM,CAAC,CAAC;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,qBAAa,aAAa,CACtB,QAAQ,SAAS,gBAAgB,EACjC,YAAY,SAAS,gBAAgB,CAAC,QAAQ,CAAC,GAC3C,gBAAgB,CAAC,QAAQ,CAAC,CAE9B,SAAQ,eAAe,CAAC,mBAAmB,EAAE,QAAQ,EAAE,YAAY,CACnE,YACI,YAAY,CAAC,QAAQ,EAAE,YAAY,CAAC,EACpC,cAAc,CAAC,QAAQ,EAAE,YAAY,CAAC;IAE1C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAY;IAElC,OAAO,CAAC,YAAY,CAAoB;IACxC,OAAO,CAAC,KAAK,CAA0C;IAEvD;;;OAGG;gBACS,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,YAAY,CAAC;IAMpD;;OAEG;IACH,IAAW,WAAW,IAAI,aAAa,CAEtC;IAED;;;;;OAKG;IACH,IAAW,IAAI,IAAI,SAAS,CAE3B;IAED;;OAEG;IACH,IAAW,IAAI,IAAI,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAE9C;IACD,IAAW,IAAI,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,EAQlD;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,MAAM,CAE/B;IACD,IAAW,WAAW,CAAC,KAAK,EAAE,MAAM,EAEnC;IAED;;OAEG;IACI,WAAW,CAAC,MAAM,EAAE,mBAAmB,GAAG,IAAI;IAqBrD;;OAEG;IACI,SAAS,IAAI,mBAAmB,GAAG,SAAS;IAwBnD;;OAEG;IACI,IAAI,CAAC,QAAQ,EAAE,YAAY,GAAG,IAAI;IAczC;;OAEG;IACI,MAAM,CAAC,QAAQ,EAAE,YAAY,GAAG,IAAI;IAI3C;;OAEG;IACH,SAAS,CAAC,KAAK,IAAI,IAAI;CAO1B"}