@codexo/exojs 0.7.11 → 0.7.12

package/dist/esm/particles/Particle.js

@@ -3,6 +3,17 @@ import { Color } from '../core/Color.js';
 import { Time } from '../core/Time.js';
 import { trimRotation } from '../math/utils.js';
 
+/**
+ * Mutable per-instance state for a single live particle. Implements
+ * {@link ParticleProperties} so affectors can mutate it through the shared
+ * interface. Particles are pooled by {@link ParticleSystem}: expired instances
+ * are moved to the graveyard and reused via {@link ParticleSystem.requestParticle}
+ * rather than garbage-collected.
+ *
+ * Do not construct directly — use {@link ParticleSystem.requestParticle} to
+ * obtain a recycled or fresh instance, then configure it through
+ * {@link Particle.applyOptions}.
+ */
 class Particle {
     _totalLifetime = Time.oneSecond.clone();
     _elapsedLifetime = Time.zero.clone();
@@ -67,18 +78,38 @@ class Particle {
     set textureIndex(textureIndex) {
         this._textureIndex = textureIndex;
     }
+    /**
+     * Time remaining before this particle expires, returned via the shared
+     * `Time.temp` scratch value — copy before storing if you need it beyond
+     * the current frame.
+     */
     get remainingLifetime() {
         return Time.temp.set(this._totalLifetime.milliseconds - this._elapsedLifetime.milliseconds);
     }
+    /**
+     * Fraction of total lifetime already elapsed, in [0, 1]. Used by
+     * {@link ColorAffector} as the interpolation factor for tint blending.
+     */
     get elapsedRatio() {
         return this._elapsedLifetime.milliseconds / this._totalLifetime.milliseconds;
     }
+    /** Fraction of total lifetime still remaining, in [0, 1]. */
     get remainingRatio() {
         return this.remainingLifetime.milliseconds / this._totalLifetime.milliseconds;
     }
+    /**
+     * Returns `true` once `elapsedLifetime` exceeds `totalLifetime`. Expired
+     * particles are moved to the graveyard by {@link ParticleSystem.update}
+     * before affectors run.
+     */
     get expired() {
         return this._elapsedLifetime.greaterThan(this._totalLifetime);
     }
+    /**
+     * Bulk-copies every field from `options` into this particle, replacing all
+     * previous state. Called immediately after {@link ParticleSystem.requestParticle}
+     * to configure a recycled particle for reuse.
+     */
     applyOptions(options) {
         const { totalLifetime, elapsedLifetime, position, velocity, scale, tint, rotation, rotationSpeed, textureIndex, } = options;
         this._totalLifetime.copy(totalLifetime);
@@ -92,6 +123,12 @@ class Particle {
         this._textureIndex = textureIndex;
         return this;
     }
+    /**
+     * Destroys all owned value objects. Called by
+     * {@link ParticleSystem.clearParticles} when the pool is flushed entirely.
+     * Do not call on individual particles mid-simulation; let the system
+     * recycle them via the graveyard instead.
+     */
     destroy() {
         this._totalLifetime.destroy();
         this._elapsedLifetime.destroy();

package/dist/esm/particles/Particle.js.map

@@ -1 +1 @@
-{"version":3,"file":"Particle.js","sources":["../../../../src/particles/Particle.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;MAOa,QAAQ,CAAA;AACT,IAAA,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE;AACvC,IAAA,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;AACpC,IAAA,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE;AAC/B,IAAA,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE;AAC/B,IAAA,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE;IAC3B,SAAS,GAAG,CAAC;IACb,cAAc,GAAG,CAAC;IAClB,aAAa,GAAG,CAAC;AACjB,IAAA,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE;AAEnC,IAAA,IAAW,aAAa,GAAA;QACpB,OAAO,IAAI,CAAC,cAAc;IAC9B;IAEA,IAAW,aAAa,CAAC,aAAa,EAAA;AAClC,QAAA,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC;IAC3C;AAEA,IAAA,IAAW,eAAe,GAAA;QACtB,OAAO,IAAI,CAAC,gBAAgB;IAChC;IAEA,IAAW,eAAe,CAAC,eAAe,EAAA;AACtC,QAAA,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,eAAe,CAAC;IAC/C;AAEA,IAAA,IAAW,QAAQ,GAAA;QACf,OAAO,IAAI,CAAC,SAAS;IACzB;IAEA,IAAW,QAAQ,CAAC,QAAQ,EAAA;AACxB,QAAA,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC;IACjC;AAEA,IAAA,IAAW,QAAQ,GAAA;QACf,OAAO,IAAI,CAAC,SAAS;IACzB;IAEA,IAAW,QAAQ,CAAC,QAAQ,EAAA;AACxB,QAAA,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC;IACjC;AAEA,IAAA,IAAW,KAAK,GAAA;QACZ,OAAO,IAAI,CAAC,MAAM;IACtB;IAEA,IAAW,KAAK,CAAC,KAAK,EAAA;AAClB,QAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;IAC3B;AAEA,IAAA,IAAW,IAAI,GAAA;QACX,OAAO,IAAI,CAAC,KAAK;IACrB;IAEA,IAAW,IAAI,CAAC,IAAI,EAAA;AAChB,QAAA,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;IACzB;AAEA,IAAA,IAAW,QAAQ,GAAA;QACf,OAAO,IAAI,CAAC,SAAS;IACzB;IAEA,IAAW,QAAQ,CAAC,OAAO,EAAA;AACvB,QAAA,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC;IAC1C;AAEA,IAAA,IAAW,aAAa,GAAA;QACpB,OAAO,IAAI,CAAC,cAAc;IAC9B;IAEA,IAAW,aAAa,CAAC,aAAa,EAAA;AAClC,QAAA,IAAI,CAAC,cAAc,GAAG,aAAa;IACvC;AAEA,IAAA,IAAW,YAAY,GAAA;QACnB,OAAO,IAAI,CAAC,aAAa;IAC7B;IAEA,IAAW,YAAY,CAAC,YAAY,EAAA;AAChC,QAAA,IAAI,CAAC,aAAa,GAAG,YAAY;IACrC;AAEA,IAAA,IAAW,iBAAiB,GAAA;AACxB,QAAA,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC;IAC/F;AAEA,IAAA,IAAW,YAAY,GAAA;QACnB,OAAO,IAAI,CAAC,gBAAgB,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,YAAY;IAChF;AAEA,IAAA,IAAW,cAAc,GAAA;QACrB,OAAO,IAAI,CAAC,iBAAiB,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,YAAY;IACjF;AAEA,IAAA,IAAW,OAAO,GAAA;QACd,OAAO,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC;IACjE;AAEO,IAAA,YAAY,CAAC,OAAwB,EAAA;QACxC,MAAM,EACF,aAAa,EACb,eAAe,EACf,QAAQ,EACR,QAAQ,EACR,KAAK,EACL,IAAI,EACJ,QAAQ,EACR,aAAa,EACb,YAAY,GACf,GAAG,OAAO;AAEX,QAAA,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC;AACvC,QAAA,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,eAAe,CAAC;AAC3C,QAAA,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC;AAC7B,QAAA,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC;AAC7B,QAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;AACvB,QAAA,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;AACrB,QAAA,IAAI,CAAC,SAAS,GAAG,QAAQ;AACzB,QAAA,IAAI,CAAC,cAAc,GAAG,aAAa;AACnC,QAAA,IAAI,CAAC,aAAa,GAAG,YAAY;AAEjC,QAAA,OAAO,IAAI;IACf;IAEO,OAAO,GAAA;AACV,QAAA,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE;AAC7B,QAAA,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE;AAC/B,QAAA,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE;AACxB,QAAA,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE;AACxB,QAAA,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;AACrB,QAAA,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE;IACxB;AACH;;;;"}
+{"version":3,"file":"Particle.js","sources":["../../../../src/particles/Particle.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AAOA;;;;;;;;;;AAUG;MACU,QAAQ,CAAA;AACT,IAAA,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE;AACvC,IAAA,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;AACpC,IAAA,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE;AAC/B,IAAA,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE;AAC/B,IAAA,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE;IAC3B,SAAS,GAAG,CAAC;IACb,cAAc,GAAG,CAAC;IAClB,aAAa,GAAG,CAAC;AACjB,IAAA,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE;AAEnC,IAAA,IAAW,aAAa,GAAA;QACpB,OAAO,IAAI,CAAC,cAAc;IAC9B;IAEA,IAAW,aAAa,CAAC,aAAa,EAAA;AAClC,QAAA,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC;IAC3C;AAEA,IAAA,IAAW,eAAe,GAAA;QACtB,OAAO,IAAI,CAAC,gBAAgB;IAChC;IAEA,IAAW,eAAe,CAAC,eAAe,EAAA;AACtC,QAAA,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,eAAe,CAAC;IAC/C;AAEA,IAAA,IAAW,QAAQ,GAAA;QACf,OAAO,IAAI,CAAC,SAAS;IACzB;IAEA,IAAW,QAAQ,CAAC,QAAQ,EAAA;AACxB,QAAA,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC;IACjC;AAEA,IAAA,IAAW,QAAQ,GAAA;QACf,OAAO,IAAI,CAAC,SAAS;IACzB;IAEA,IAAW,QAAQ,CAAC,QAAQ,EAAA;AACxB,QAAA,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC;IACjC;AAEA,IAAA,IAAW,KAAK,GAAA;QACZ,OAAO,IAAI,CAAC,MAAM;IACtB;IAEA,IAAW,KAAK,CAAC,KAAK,EAAA;AAClB,QAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;IAC3B;AAEA,IAAA,IAAW,IAAI,GAAA;QACX,OAAO,IAAI,CAAC,KAAK;IACrB;IAEA,IAAW,IAAI,CAAC,IAAI,EAAA;AAChB,QAAA,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;IACzB;AAEA,IAAA,IAAW,QAAQ,GAAA;QACf,OAAO,IAAI,CAAC,SAAS;IACzB;IAEA,IAAW,QAAQ,CAAC,OAAO,EAAA;AACvB,QAAA,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC;IAC1C;AAEA,IAAA,IAAW,aAAa,GAAA;QACpB,OAAO,IAAI,CAAC,cAAc;IAC9B;IAEA,IAAW,aAAa,CAAC,aAAa,EAAA;AAClC,QAAA,IAAI,CAAC,cAAc,GAAG,aAAa;IACvC;AAEA,IAAA,IAAW,YAAY,GAAA;QACnB,OAAO,IAAI,CAAC,aAAa;IAC7B;IAEA,IAAW,YAAY,CAAC,YAAY,EAAA;AAChC,QAAA,IAAI,CAAC,aAAa,GAAG,YAAY;IACrC;AAEA;;;;AAIG;AACH,IAAA,IAAW,iBAAiB,GAAA;AACxB,QAAA,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC;IAC/F;AAEA;;;AAGG;AACH,IAAA,IAAW,YAAY,GAAA;QACnB,OAAO,IAAI,CAAC,gBAAgB,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,YAAY;IAChF;;AAGA,IAAA,IAAW,cAAc,GAAA;QACrB,OAAO,IAAI,CAAC,iBAAiB,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,YAAY;IACjF;AAEA;;;;AAIG;AACH,IAAA,IAAW,OAAO,GAAA;QACd,OAAO,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC;IACjE;AAEA;;;;AAIG;AACI,IAAA,YAAY,CAAC,OAAwB,EAAA;QACxC,MAAM,EACF,aAAa,EACb,eAAe,EACf,QAAQ,EACR,QAAQ,EACR,KAAK,EACL,IAAI,EACJ,QAAQ,EACR,aAAa,EACb,YAAY,GACf,GAAG,OAAO;AAEX,QAAA,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC;AACvC,QAAA,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,eAAe,CAAC;AAC3C,QAAA,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC;AAC7B,QAAA,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC;AAC7B,QAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;AACvB,QAAA,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;AACrB,QAAA,IAAI,CAAC,SAAS,GAAG,QAAQ;AACzB,QAAA,IAAI,CAAC,cAAc,GAAG,aAAa;AACnC,QAAA,IAAI,CAAC,aAAa,GAAG,YAAY;AAEjC,QAAA,OAAO,IAAI;IACf;AAEA;;;;;AAKG;IACI,OAAO,GAAA;AACV,QAAA,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE;AAC7B,QAAA,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE;AAC/B,QAAA,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE;AACxB,QAAA,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE;AACxB,QAAA,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;AACrB,QAAA,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE;IACxB;AACH;;;;"}

package/dist/esm/particles/ParticleProperties.d.ts

@@ -1,14 +1,29 @@
 import type { Time } from '@/core/Time';
 import type { Vector } from '@/math/Vector';
 import type { Color } from '@/core/Color';
+/**
+ * Shared property contract for both {@link Particle} (live instance) and
+ * {@link ParticleOptions} (spawn configuration). Every field represents a
+ * mutable, per-particle attribute that affectors and the system update each
+ * tick.
+ */
 export interface ParticleProperties {
+    /** Total time the particle lives before expiring. */
     totalLifetime: Time;
+    /** Time that has passed since the particle was spawned. */
     elapsedLifetime: Time;
+    /** Position in the owning {@link ParticleSystem}'s local coordinate space. */
     position: Vector;
+    /** Pixels-per-second movement vector applied by the system each tick. */
     velocity: Vector;
+    /** Multiplicative scale applied to the particle sprite on both axes. */
     scale: Vector;
+    /** Rotation in degrees, normalised to [0, 360) by {@link trimRotation}. */
     rotation: number;
+    /** Degrees-per-second angular velocity accumulated by {@link TorqueAffector}. */
     rotationSpeed: number;
+    /** Index into the atlas frame list used to choose the particle sprite. */
     textureIndex: number;
+    /** RGBA tint blended onto the particle sprite, interpolated by {@link ColorAffector}. */
     tint: Color;
 }

package/dist/esm/particles/ParticleSystem.d.ts

@@ -5,6 +5,20 @@ import { Drawable } from '@/rendering/Drawable';
 import type { Texture } from '@/rendering/texture/Texture';
 import type { ParticleEmitter } from '@/particles/emitters/ParticleEmitter';
 import type { ParticleAffector } from '@/particles/affectors/ParticleAffector';
+/**
+ * The central coordinator of the particle triad. `ParticleSystem` is a
+ * {@link Drawable} that owns a list of {@link ParticleEmitter} spawners, a
+ * list of {@link ParticleAffector} mutators, and the live/graveyard particle
+ * pools. Each call to {@link ParticleSystem.update} runs all emitters to
+ * spawn new particles, advances every live particle's position and lifetime,
+ * retires expired ones to the graveyard for pooling, and runs all affectors
+ * on the survivors.
+ *
+ * Rendering reads {@link ParticleSystem.vertices} and
+ * {@link ParticleSystem.texCoords} (lazily recomputed on texture-frame
+ * changes) plus the live {@link ParticleSystem.particles} array to draw each
+ * sprite.
+ */
 export declare class ParticleSystem extends Drawable {
     private _emitters;
     private _affectors;
@@ -21,23 +35,78 @@ export declare class ParticleSystem extends Drawable {
     set texture(texture: Texture);
     get textureFrame(): Rectangle;
     set textureFrame(frame: Rectangle);
+    /**
+     * Quad corner offsets for the current {@link textureFrame}, in local
+     * space as `[minX, minY, maxX, maxY]`. Recomputed lazily whenever
+     * `textureFrame` changes. Used by the renderer to position each particle
+     * sprite relative to its world position.
+     */
     get vertices(): Float32Array;
+    /**
+     * Packed UV coordinates for the current {@link textureFrame} as four
+     * `Uint32` values, each encoding a `(u, v)` pair in the upper/lower 16
+     * bits (normalised to 0–65535). Vertex order respects
+     * {@link Texture.flipY}. Recomputed lazily on texture or frame changes.
+     */
     get texCoords(): Uint32Array;
     get emitters(): Array<ParticleEmitter>;
     get affectors(): Array<ParticleAffector>;
     get particles(): Array<Particle>;
+    /**
+     * Pool of expired {@link Particle} instances waiting to be recycled.
+     * {@link requestParticle} pops from this array before allocating a new
+     * instance, keeping GC pressure low during sustained emission.
+     */
     get graveyard(): Array<Particle>;
+    /**
+     * Replaces the particle sprite texture and resets the texture frame to
+     * cover the full new texture. No-ops if `texture` is the same instance.
+     */
     setTexture(texture: Texture): this;
+    /**
+     * Sets the sub-rectangle of the texture used as the particle sprite,
+     * invalidating cached vertices and UV coordinates and updating the system's
+     * local bounds to match the frame dimensions.
+     */
     setTextureFrame(frame: Rectangle): this;
+    /** Resets the texture frame to the full dimensions of the current texture. */
     resetTextureFrame(): this;
+    /** Registers `emitter` to be called each tick during {@link update}. */
     addEmitter(emitter: ParticleEmitter): this;
+    /** Destroys and removes all registered emitters. */
     clearEmitters(): this;
+    /** Registers `affector` to run on every live particle each tick during {@link update}. */
     addAffector(affector: ParticleAffector): this;
+    /** Destroys and removes all registered affectors. */
     clearAffectors(): this;
+    /**
+     * Returns a recycled particle from the {@link graveyard}, or allocates a
+     * new one if the pool is empty. Call {@link Particle.applyOptions}
+     * immediately after to reset its state before passing it to
+     * {@link emitParticle}.
+     */
     requestParticle(): Particle;
+    /** Adds a fully-configured `particle` to the live pool. Typically called by emitters. */
     emitParticle(particle: Particle): this;
+    /**
+     * Advances a single particle by one `delta` step: increments
+     * `elapsedLifetime`, integrates velocity into position, and applies
+     * `rotationSpeed` to rotation. Called for every live particle by
+     * {@link update} before the affector pass.
+     */
     updateParticle(particle: Particle, delta: Time): this;
+    /**
+     * Destroys and removes all particles from both the live pool and the
+     * graveyard. Use when resetting or recycling the entire system.
+     */
     clearParticles(): this;
+    /**
+     * Advances the full simulation by one `delta` step: runs all emitters,
+     * then for each live particle calls {@link updateParticle}, moves expired
+     * ones to the {@link graveyard}, and runs all affectors on survivors.
+     * The particle array is iterated in reverse to allow in-place splice
+     * without re-indexing.
+     */
     update(delta: Time): this;
     destroy(): void;
 }

package/dist/esm/particles/ParticleSystem.js

@@ -2,6 +2,20 @@ import { Particle } from './Particle.js';
 import { Rectangle } from '../math/Rectangle.js';
 import { Drawable } from '../rendering/Drawable.js';
 
+/**
+ * The central coordinator of the particle triad. `ParticleSystem` is a
+ * {@link Drawable} that owns a list of {@link ParticleEmitter} spawners, a
+ * list of {@link ParticleAffector} mutators, and the live/graveyard particle
+ * pools. Each call to {@link ParticleSystem.update} runs all emitters to
+ * spawn new particles, advances every live particle's position and lifetime,
+ * retires expired ones to the graveyard for pooling, and runs all affectors
+ * on the survivors.
+ *
+ * Rendering reads {@link ParticleSystem.vertices} and
+ * {@link ParticleSystem.texCoords} (lazily recomputed on texture-frame
+ * changes) plus the live {@link ParticleSystem.particles} array to draw each
+ * sprite.
+ */
 class ParticleSystem extends Drawable {
     _emitters = [];
     _affectors = [];
@@ -30,6 +44,12 @@ class ParticleSystem extends Drawable {
     set textureFrame(frame) {
         this.setTextureFrame(frame);
     }
+    /**
+     * Quad corner offsets for the current {@link textureFrame}, in local
+     * space as `[minX, minY, maxX, maxY]`. Recomputed lazily whenever
+     * `textureFrame` changes. Used by the renderer to position each particle
+     * sprite relative to its world position.
+     */
     get vertices() {
         if (this._updateVertices) {
             const { x, y, width, height } = this._textureFrame;
@@ -43,6 +63,12 @@ class ParticleSystem extends Drawable {
         }
         return this._vertices;
     }
+    /**
+     * Packed UV coordinates for the current {@link textureFrame} as four
+     * `Uint32` values, each encoding a `(u, v)` pair in the upper/lower 16
+     * bits (normalised to 0–65535). Vertex order respects
+     * {@link Texture.flipY}. Recomputed lazily on texture or frame changes.
+     */
     get texCoords() {
         if (this._updateTexCoords) {
             const { width, height } = this._texture;
@@ -76,9 +102,18 @@ class ParticleSystem extends Drawable {
     get particles() {
         return this._particles;
     }
+    /**
+     * Pool of expired {@link Particle} instances waiting to be recycled.
+     * {@link requestParticle} pops from this array before allocating a new
+     * instance, keeping GC pressure low during sustained emission.
+     */
     get graveyard() {
         return this._graveyard;
     }
+    /**
+     * Replaces the particle sprite texture and resets the texture frame to
+     * cover the full new texture. No-ops if `texture` is the same instance.
+     */
     setTexture(texture) {
         if (this._texture !== texture) {
             this._texture = texture;
@@ -86,6 +121,11 @@ class ParticleSystem extends Drawable {
         }
         return this;
     }
+    /**
+     * Sets the sub-rectangle of the texture used as the particle sprite,
+     * invalidating cached vertices and UV coordinates and updating the system's
+     * local bounds to match the frame dimensions.
+     */
     setTextureFrame(frame) {
         this._textureFrame.copy(frame);
         this._updateTexCoords = true;
@@ -94,13 +134,16 @@ class ParticleSystem extends Drawable {
         this._invalidateBoundsCascade();
         return this;
     }
+    /** Resets the texture frame to the full dimensions of the current texture. */
     resetTextureFrame() {
         return this.setTextureFrame(Rectangle.temp.set(0, 0, this._texture.width, this._texture.height));
     }
+    /** Registers `emitter` to be called each tick during {@link update}. */
     addEmitter(emitter) {
         this._emitters.push(emitter);
         return this;
     }
+    /** Destroys and removes all registered emitters. */
     clearEmitters() {
         for (const emitter of this._emitters) {
             emitter.destroy();
@@ -108,10 +151,12 @@ class ParticleSystem extends Drawable {
         this._emitters.length = 0;
         return this;
     }
+    /** Registers `affector` to run on every live particle each tick during {@link update}. */
     addAffector(affector) {
         this._affectors.push(affector);
         return this;
     }
+    /** Destroys and removes all registered affectors. */
     clearAffectors() {
         for (const affector of this._affectors) {
             affector.destroy();
@@ -119,13 +164,26 @@ class ParticleSystem extends Drawable {
         this._affectors.length = 0;
         return this;
     }
+    /**
+     * Returns a recycled particle from the {@link graveyard}, or allocates a
+     * new one if the pool is empty. Call {@link Particle.applyOptions}
+     * immediately after to reset its state before passing it to
+     * {@link emitParticle}.
+     */
     requestParticle() {
         return this._graveyard.pop() || new Particle();
     }
+    /** Adds a fully-configured `particle` to the live pool. Typically called by emitters. */
     emitParticle(particle) {
         this._particles.push(particle);
         return this;
     }
+    /**
+     * Advances a single particle by one `delta` step: increments
+     * `elapsedLifetime`, integrates velocity into position, and applies
+     * `rotationSpeed` to rotation. Called for every live particle by
+     * {@link update} before the affector pass.
+     */
     updateParticle(particle, delta) {
         const seconds = delta.seconds;
         particle.elapsedLifetime.addTime(delta);
@@ -133,6 +191,10 @@ class ParticleSystem extends Drawable {
         particle.rotation += (seconds * particle.rotationSpeed);
         return this;
     }
+    /**
+     * Destroys and removes all particles from both the live pool and the
+     * graveyard. Use when resetting or recycling the entire system.
+     */
     clearParticles() {
         for (const particle of this._particles) {
             particle.destroy();
@@ -144,6 +206,13 @@ class ParticleSystem extends Drawable {
         this._graveyard.length = 0;
         return this;
     }
+    /**
+     * Advances the full simulation by one `delta` step: runs all emitters,
+     * then for each live particle calls {@link updateParticle}, moves expired
+     * ones to the {@link graveyard}, and runs all affectors on survivors.
+     * The particle array is iterated in reverse to allow in-place splice
+     * without re-indexing.
+     */
     update(delta) {
         const emitters = this._emitters;
         const affectors = this._affectors;

package/dist/esm/particles/ParticleSystem.js.map

@@ -1 +1 @@
-{"version":3,"file":"ParticleSystem.js","sources":["../../../../src/particles/ParticleSystem.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;AAQM,MAAO,cAAe,SAAQ,QAAQ,CAAA;IAEhC,SAAS,GAA2B,EAAE;IACtC,UAAU,GAA4B,EAAE;IACxC,UAAU,GAAoB,EAAE;IAChC,UAAU,GAAoB,EAAE;AAChC,IAAA,QAAQ;AACR,IAAA,aAAa,GAAc,IAAI,SAAS,EAAE;AAC1C,IAAA,SAAS,GAAiB,IAAI,YAAY,CAAC,CAAC,CAAC;AAC7C,IAAA,UAAU,GAAgB,IAAI,WAAW,CAAC,CAAC,CAAC;IAC5C,gBAAgB,GAAG,IAAI;IACvB,eAAe,GAAG,IAAI;AAE9B,IAAA,WAAA,CAAmB,OAAgB,EAAA;AAC/B,QAAA,KAAK,EAAE;AAEP,QAAA,IAAI,CAAC,QAAQ,GAAG,OAAO;QACvB,IAAI,CAAC,iBAAiB,EAAE;IAC5B;AAEA,IAAA,IAAW,OAAO,GAAA;QACd,OAAO,IAAI,CAAC,QAAQ;IACxB;IAEA,IAAW,OAAO,CAAC,OAAgB,EAAA;AAC/B,QAAA,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;IAC5B;AAEA,IAAA,IAAW,YAAY,GAAA;QACnB,OAAO,IAAI,CAAC,aAAa;IAC7B;IAEA,IAAW,YAAY,CAAC,KAAgB,EAAA;AACpC,QAAA,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC;IAC/B;AAEA,IAAA,IAAW,QAAQ,GAAA;AACf,QAAA,IAAI,IAAI,CAAC,eAAe,EAAE;AACtB,YAAA,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,aAAa;AAClD,YAAA,MAAM,OAAO,IAAI,KAAK,GAAG,CAAC,CAAC;AAC3B,YAAA,MAAM,OAAO,IAAI,MAAM,GAAG,CAAC,CAAC;YAE5B,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,OAAO;YAC/B,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,OAAO;YAC/B,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,OAAO;YACnC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,OAAO;AAEpC,YAAA,IAAI,CAAC,eAAe,GAAG,KAAK;QAChC;QAEA,OAAO,IAAI,CAAC,SAAS;IACzB;AAEA,IAAA,IAAW,SAAS,GAAA;AAChB,QAAA,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACvB,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,QAAQ;AACvC,YAAA,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,aAAa;AACvD,YAAA,MAAM,IAAI,IAAI,CAAC,IAAI,GAAG,KAAK,IAAI,KAAK,GAAG,KAAK,CAAC;AAC7C,YAAA,MAAM,IAAI,GAAG,CAAC,CAAC,GAAG,GAAG,MAAM,IAAI,KAAK,GAAG,KAAK,KAAK,EAAE;AACnD,YAAA,MAAM,IAAI,IAAI,CAAC,KAAK,GAAG,KAAK,IAAI,KAAK,GAAG,KAAK,CAAC;AAC9C,YAAA,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,GAAG,MAAM,IAAI,KAAK,GAAG,KAAK,KAAK,EAAE;AAEtD,YAAA,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE;gBACrB,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,CAAC;gBAClC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,CAAC;gBAClC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,CAAC;gBAClC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,CAAC;YACtC;iBAAO;gBACH,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,CAAC;gBAClC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,CAAC;gBAClC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,CAAC;gBAClC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,CAAC;YACtC;AAEA,YAAA,IAAI,CAAC,gBAAgB,GAAG,KAAK;QACjC;QAEA,OAAO,IAAI,CAAC,UAAU;IAC1B;AAEA,IAAA,IAAW,QAAQ,GAAA;QACf,OAAO,IAAI,CAAC,SAAS;IACzB;AAEA,IAAA,IAAW,SAAS,GAAA;QAChB,OAAO,IAAI,CAAC,UAAU;IAC1B;AAEA,IAAA,IAAW,SAAS,GAAA;QAChB,OAAO,IAAI,CAAC,UAAU;IAC1B;AAEA,IAAA,IAAW,SAAS,GAAA;QAChB,OAAO,IAAI,CAAC,UAAU;IAC1B;AAEO,IAAA,UAAU,CAAC,OAAgB,EAAA;AAC9B,QAAA,IAAI,IAAI,CAAC,QAAQ,KAAK,OAAO,EAAE;AAC3B,YAAA,IAAI,CAAC,QAAQ,GAAG,OAAO;YACvB,IAAI,CAAC,iBAAiB,EAAE;QAC5B;AAEA,QAAA,OAAO,IAAI;IACf;AAEO,IAAA,eAAe,CAAC,KAAgB,EAAA;AACnC,QAAA,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC;AAC9B,QAAA,IAAI,CAAC,gBAAgB,GAAG,IAAI;AAC5B,QAAA,IAAI,CAAC,eAAe,GAAG,IAAI;AAE3B,QAAA,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;QACrD,IAAI,CAAC,wBAAwB,EAAE;AAE/B,QAAA,OAAO,IAAI;IACf;IAEO,iBAAiB,GAAA;QACpB,OAAO,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACpG;AAEO,IAAA,UAAU,CAAC,OAAwB,EAAA;AACtC,QAAA,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC;AAE5B,QAAA,OAAO,IAAI;IACf;IAEO,aAAa,GAAA;AAChB,QAAA,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE;YAClC,OAAO,CAAC,OAAO,EAAE;QACrB;AAEA,QAAA,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC;AAEzB,QAAA,OAAO,IAAI;IACf;AAEO,IAAA,WAAW,CAAC,QAA0B,EAAA;AACzC,QAAA,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC;AAE9B,QAAA,OAAO,IAAI;IACf;IAEO,cAAc,GAAA;AACjB,QAAA,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE;YACpC,QAAQ,CAAC,OAAO,EAAE;QACtB;AAEA,QAAA,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;AAE1B,QAAA,OAAO,IAAI;IACf;IAEO,eAAe,GAAA;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,IAAI,QAAQ,EAAE;IAClD;AAEO,IAAA,YAAY,CAAC,QAAkB,EAAA;AAClC,QAAA,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC;AAE9B,QAAA,OAAO,IAAI;IACf;IAEO,cAAc,CAAC,QAAkB,EAAE,KAAW,EAAA;AACjD,QAAA,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO;AAE7B,QAAA,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC;QAEvC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;QACnF,QAAQ,CAAC,QAAQ,KAAK,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC;AAEvD,QAAA,OAAO,IAAI;IACf;IAEO,cAAc,GAAA;AACjB,QAAA,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE;YACpC,QAAQ,CAAC,OAAO,EAAE;QACtB;AAEA,QAAA,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE;YACpC,QAAQ,CAAC,OAAO,EAAE;QACtB;AAEA,QAAA,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;AAC1B,QAAA,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;AAE1B,QAAA,OAAO,IAAI;IACf;AAEO,IAAA,MAAM,CAAC,KAAW,EAAA;AACrB,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS;AAC/B,QAAA,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU;AACjC,QAAA,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU;AACjC,QAAA,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU;AACjC,QAAA,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM;AAE5B,QAAA,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;AAC5B,YAAA,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC;QAC9B;QAEA,IAAI,WAAW,GAAG,CAAC;AAEnB,QAAA,KAAK,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE;YAC/B,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC;AAExC,YAAA,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE;gBACtB,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AAC5B,gBAAA,WAAW,EAAE;gBAEb;YACJ;AAEA,YAAA,IAAI,WAAW,GAAG,CAAC,EAAE;gBACjB,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,EAAE,WAAW,CAAC;gBACpC,WAAW,GAAG,CAAC;YACnB;AAEA,YAAA,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;gBAC9B,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC;YACvC;QACJ;AAEA,QAAA,IAAI,WAAW,GAAG,CAAC,EAAE;AACjB,YAAA,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,WAAW,CAAC;QACpC;AAEA,QAAA,OAAO,IAAI;IACf;IAEgB,OAAO,GAAA;QACnB,KAAK,CAAC,OAAO,EAAE;QAEf,IAAI,CAAC,aAAa,EAAE;QACpB,IAAI,CAAC,cAAc,EAAE;QACrB,IAAI,CAAC,cAAc,EAAE;AAErB,QAAA,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE;IAChC;AACH;;;;"}
+{"version":3,"file":"ParticleSystem.js","sources":["../../../../src/particles/ParticleSystem.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;AAQA;;;;;;;;;;;;;AAaG;AACG,MAAO,cAAe,SAAQ,QAAQ,CAAA;IAEhC,SAAS,GAA2B,EAAE;IACtC,UAAU,GAA4B,EAAE;IACxC,UAAU,GAAoB,EAAE;IAChC,UAAU,GAAoB,EAAE;AAChC,IAAA,QAAQ;AACR,IAAA,aAAa,GAAc,IAAI,SAAS,EAAE;AAC1C,IAAA,SAAS,GAAiB,IAAI,YAAY,CAAC,CAAC,CAAC;AAC7C,IAAA,UAAU,GAAgB,IAAI,WAAW,CAAC,CAAC,CAAC;IAC5C,gBAAgB,GAAG,IAAI;IACvB,eAAe,GAAG,IAAI;AAE9B,IAAA,WAAA,CAAmB,OAAgB,EAAA;AAC/B,QAAA,KAAK,EAAE;AAEP,QAAA,IAAI,CAAC,QAAQ,GAAG,OAAO;QACvB,IAAI,CAAC,iBAAiB,EAAE;IAC5B;AAEA,IAAA,IAAW,OAAO,GAAA;QACd,OAAO,IAAI,CAAC,QAAQ;IACxB;IAEA,IAAW,OAAO,CAAC,OAAgB,EAAA;AAC/B,QAAA,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;IAC5B;AAEA,IAAA,IAAW,YAAY,GAAA;QACnB,OAAO,IAAI,CAAC,aAAa;IAC7B;IAEA,IAAW,YAAY,CAAC,KAAgB,EAAA;AACpC,QAAA,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC;IAC/B;AAEA;;;;;AAKG;AACH,IAAA,IAAW,QAAQ,GAAA;AACf,QAAA,IAAI,IAAI,CAAC,eAAe,EAAE;AACtB,YAAA,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,aAAa;AAClD,YAAA,MAAM,OAAO,IAAI,KAAK,GAAG,CAAC,CAAC;AAC3B,YAAA,MAAM,OAAO,IAAI,MAAM,GAAG,CAAC,CAAC;YAE5B,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,OAAO;YAC/B,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,OAAO;YAC/B,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,OAAO;YACnC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,OAAO;AAEpC,YAAA,IAAI,CAAC,eAAe,GAAG,KAAK;QAChC;QAEA,OAAO,IAAI,CAAC,SAAS;IACzB;AAEA;;;;;AAKG;AACH,IAAA,IAAW,SAAS,GAAA;AAChB,QAAA,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACvB,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,QAAQ;AACvC,YAAA,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,aAAa;AACvD,YAAA,MAAM,IAAI,IAAI,CAAC,IAAI,GAAG,KAAK,IAAI,KAAK,GAAG,KAAK,CAAC;AAC7C,YAAA,MAAM,IAAI,GAAG,CAAC,CAAC,GAAG,GAAG,MAAM,IAAI,KAAK,GAAG,KAAK,KAAK,EAAE;AACnD,YAAA,MAAM,IAAI,IAAI,CAAC,KAAK,GAAG,KAAK,IAAI,KAAK,GAAG,KAAK,CAAC;AAC9C,YAAA,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,GAAG,MAAM,IAAI,KAAK,GAAG,KAAK,KAAK,EAAE;AAEtD,YAAA,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE;gBACrB,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,CAAC;gBAClC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,CAAC;gBAClC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,CAAC;gBAClC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,CAAC;YACtC;iBAAO;gBACH,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,CAAC;gBAClC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,CAAC;gBAClC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,CAAC;gBAClC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,CAAC;YACtC;AAEA,YAAA,IAAI,CAAC,gBAAgB,GAAG,KAAK;QACjC;QAEA,OAAO,IAAI,CAAC,UAAU;IAC1B;AAEA,IAAA,IAAW,QAAQ,GAAA;QACf,OAAO,IAAI,CAAC,SAAS;IACzB;AAEA,IAAA,IAAW,SAAS,GAAA;QAChB,OAAO,IAAI,CAAC,UAAU;IAC1B;AAEA,IAAA,IAAW,SAAS,GAAA;QAChB,OAAO,IAAI,CAAC,UAAU;IAC1B;AAEA;;;;AAIG;AACH,IAAA,IAAW,SAAS,GAAA;QAChB,OAAO,IAAI,CAAC,UAAU;IAC1B;AAEA;;;AAGG;AACI,IAAA,UAAU,CAAC,OAAgB,EAAA;AAC9B,QAAA,IAAI,IAAI,CAAC,QAAQ,KAAK,OAAO,EAAE;AAC3B,YAAA,IAAI,CAAC,QAAQ,GAAG,OAAO;YACvB,IAAI,CAAC,iBAAiB,EAAE;QAC5B;AAEA,QAAA,OAAO,IAAI;IACf;AAEA;;;;AAIG;AACI,IAAA,eAAe,CAAC,KAAgB,EAAA;AACnC,QAAA,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC;AAC9B,QAAA,IAAI,CAAC,gBAAgB,GAAG,IAAI;AAC5B,QAAA,IAAI,CAAC,eAAe,GAAG,IAAI;AAE3B,QAAA,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;QACrD,IAAI,CAAC,wBAAwB,EAAE;AAE/B,QAAA,OAAO,IAAI;IACf;;IAGO,iBAAiB,GAAA;QACpB,OAAO,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACpG;;AAGO,IAAA,UAAU,CAAC,OAAwB,EAAA;AACtC,QAAA,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC;AAE5B,QAAA,OAAO,IAAI;IACf;;IAGO,aAAa,GAAA;AAChB,QAAA,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE;YAClC,OAAO,CAAC,OAAO,EAAE;QACrB;AAEA,QAAA,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC;AAEzB,QAAA,OAAO,IAAI;IACf;;AAGO,IAAA,WAAW,CAAC,QAA0B,EAAA;AACzC,QAAA,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC;AAE9B,QAAA,OAAO,IAAI;IACf;;IAGO,cAAc,GAAA;AACjB,QAAA,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE;YACpC,QAAQ,CAAC,OAAO,EAAE;QACtB;AAEA,QAAA,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;AAE1B,QAAA,OAAO,IAAI;IACf;AAEA;;;;;AAKG;IACI,eAAe,GAAA;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,IAAI,QAAQ,EAAE;IAClD;;AAGO,IAAA,YAAY,CAAC,QAAkB,EAAA;AAClC,QAAA,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC;AAE9B,QAAA,OAAO,IAAI;IACf;AAEA;;;;;AAKG;IACI,cAAc,CAAC,QAAkB,EAAE,KAAW,EAAA;AACjD,QAAA,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO;AAE7B,QAAA,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC;QAEvC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;QACnF,QAAQ,CAAC,QAAQ,KAAK,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC;AAEvD,QAAA,OAAO,IAAI;IACf;AAEA;;;AAGG;IACI,cAAc,GAAA;AACjB,QAAA,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE;YACpC,QAAQ,CAAC,OAAO,EAAE;QACtB;AAEA,QAAA,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE;YACpC,QAAQ,CAAC,OAAO,EAAE;QACtB;AAEA,QAAA,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;AAC1B,QAAA,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;AAE1B,QAAA,OAAO,IAAI;IACf;AAEA;;;;;;AAMG;AACI,IAAA,MAAM,CAAC,KAAW,EAAA;AACrB,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS;AAC/B,QAAA,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU;AACjC,QAAA,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU;AACjC,QAAA,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU;AACjC,QAAA,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM;AAE5B,QAAA,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;AAC5B,YAAA,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC;QAC9B;QAEA,IAAI,WAAW,GAAG,CAAC;AAEnB,QAAA,KAAK,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE;YAC/B,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC;AAExC,YAAA,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE;gBACtB,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AAC5B,gBAAA,WAAW,EAAE;gBAEb;YACJ;AAEA,YAAA,IAAI,WAAW,GAAG,CAAC,EAAE;gBACjB,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,EAAE,WAAW,CAAC;gBACpC,WAAW,GAAG,CAAC;YACnB;AAEA,YAAA,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;gBAC9B,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC;YACvC;QACJ;AAEA,QAAA,IAAI,WAAW,GAAG,CAAC,EAAE;AACjB,YAAA,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,WAAW,CAAC;QACpC;AAEA,QAAA,OAAO,IAAI;IACf;IAEgB,OAAO,GAAA;QACnB,KAAK,CAAC,OAAO,EAAE;QAEf,IAAI,CAAC,aAAa,EAAE;QACpB,IAAI,CAAC,cAAc,EAAE;QACrB,IAAI,CAAC,cAAc,EAAE;AAErB,QAAA,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE;IAChC;AACH;;;;"}

package/dist/esm/particles/affectors/ColorAffector.d.ts

@@ -2,6 +2,13 @@ import type { ParticleAffector } from '@/particles/affectors/ParticleAffector';
 import type { Color } from '@/core/Color';
 import type { Particle } from '@/particles/Particle';
 import type { Time } from '@/core/Time';
+/**
+ * Linearly interpolates a particle's {@link Particle.tint} from `fromColor`
+ * to `toColor` over the particle's full lifetime. The blend factor is
+ * {@link Particle.elapsedRatio} — 0 at birth, 1 at expiry — so the
+ * transition is always proportional to how long the particle has lived
+ * regardless of delta size.
+ */
 export declare class ColorAffector implements ParticleAffector {
     private readonly _fromColor;
     private readonly _toColor;
@@ -12,6 +19,12 @@ export declare class ColorAffector implements ParticleAffector {
     set toColor(color: Color);
     setFromColor(color: Color): this;
     setToColor(color: Color): this;
+    /**
+     * Sets `particle.tint` to the RGBA value interpolated between
+     * {@link fromColor} and {@link toColor} at the particle's current
+     * {@link Particle.elapsedRatio}. `delta` is unused but required by the
+     * {@link ParticleAffector} contract.
+     */
     apply(particle: Particle, delta: Time): this;
     destroy(): void;
 }

package/dist/esm/particles/affectors/ColorAffector.js

@@ -1,3 +1,10 @@
+/**
+ * Linearly interpolates a particle's {@link Particle.tint} from `fromColor`
+ * to `toColor` over the particle's full lifetime. The blend factor is
+ * {@link Particle.elapsedRatio} — 0 at birth, 1 at expiry — so the
+ * transition is always proportional to how long the particle has lived
+ * regardless of delta size.
+ */
 class ColorAffector {
     _fromColor;
     _toColor;
@@ -25,6 +32,12 @@ class ColorAffector {
         this._toColor.copy(color);
         return this;
     }
+    /**
+     * Sets `particle.tint` to the RGBA value interpolated between
+     * {@link fromColor} and {@link toColor} at the particle's current
+     * {@link Particle.elapsedRatio}. `delta` is unused but required by the
+     * {@link ParticleAffector} contract.
+     */
     apply(particle, delta) {
         const ratio = particle.elapsedRatio;
         const { r: r1, g: g1, b: b1, a: a1 } = this._fromColor;

package/dist/esm/particles/affectors/ColorAffector.js.map

@@ -1 +1 @@
-{"version":3,"file":"ColorAffector.js","sources":["../../../../../src/particles/affectors/ColorAffector.ts"],"sourcesContent":[null],"names":[],"mappings":"MAKa,aAAa,CAAA;AAEL,IAAA,UAAU;AACV,IAAA,QAAQ;IAEzB,WAAA,CAAmB,SAAgB,EAAE,OAAc,EAAA;AAC/C,QAAA,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,KAAK,EAAE;AACnC,QAAA,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,KAAK,EAAE;IACnC;AAEA,IAAA,IAAW,SAAS,GAAA;QAChB,OAAO,IAAI,CAAC,UAAU;IAC1B;IAEA,IAAW,SAAS,CAAC,KAAK,EAAA;AACtB,QAAA,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC;IAC5B;AAEA,IAAA,IAAW,OAAO,GAAA;QACd,OAAO,IAAI,CAAC,QAAQ;IACxB;IAEA,IAAW,OAAO,CAAC,KAAK,EAAA;AACpB,QAAA,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;IAC1B;AAEO,IAAA,YAAY,CAAC,KAAY,EAAA;AAC5B,QAAA,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC;AAE3B,QAAA,OAAO,IAAI;IACf;AAEO,IAAA,UAAU,CAAC,KAAY,EAAA;AAC1B,QAAA,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;AAEzB,QAAA,OAAO,IAAI;IACf;IAEO,KAAK,CAAC,QAAkB,EAAE,KAAW,EAAA;AACxC,QAAA,MAAM,KAAK,GAAG,QAAQ,CAAC,YAAY;QAClC,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,UAAU;QACtD,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,QAAQ;QAErD,QAAQ,CAAC,IAAI,CAAC,GAAG,CACb,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,KAAK,IAAI,EAAE,EACxB,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,KAAK,IAAI,EAAE,EACxB,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,KAAK,IAAI,EAAE,EACxB,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,KAAK,IAAI,EAAE,CAC3B;AAED,QAAA,OAAO,IAAI;IACf;IAEO,OAAO,GAAA;AACV,QAAA,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE;AACzB,QAAA,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE;IAC3B;AACH;;;;"}
+{"version":3,"file":"ColorAffector.js","sources":["../../../../../src/particles/affectors/ColorAffector.ts"],"sourcesContent":[null],"names":[],"mappings":"AAKA;;;;;;AAMG;MACU,aAAa,CAAA;AAEL,IAAA,UAAU;AACV,IAAA,QAAQ;IAEzB,WAAA,CAAmB,SAAgB,EAAE,OAAc,EAAA;AAC/C,QAAA,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,KAAK,EAAE;AACnC,QAAA,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,KAAK,EAAE;IACnC;AAEA,IAAA,IAAW,SAAS,GAAA;QAChB,OAAO,IAAI,CAAC,UAAU;IAC1B;IAEA,IAAW,SAAS,CAAC,KAAK,EAAA;AACtB,QAAA,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC;IAC5B;AAEA,IAAA,IAAW,OAAO,GAAA;QACd,OAAO,IAAI,CAAC,QAAQ;IACxB;IAEA,IAAW,OAAO,CAAC,KAAK,EAAA;AACpB,QAAA,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;IAC1B;AAEO,IAAA,YAAY,CAAC,KAAY,EAAA;AAC5B,QAAA,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC;AAE3B,QAAA,OAAO,IAAI;IACf;AAEO,IAAA,UAAU,CAAC,KAAY,EAAA;AAC1B,QAAA,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;AAEzB,QAAA,OAAO,IAAI;IACf;AAEA;;;;;AAKG;IACI,KAAK,CAAC,QAAkB,EAAE,KAAW,EAAA;AACxC,QAAA,MAAM,KAAK,GAAG,QAAQ,CAAC,YAAY;QAClC,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,UAAU;QACtD,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,QAAQ;QAErD,QAAQ,CAAC,IAAI,CAAC,GAAG,CACb,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,KAAK,IAAI,EAAE,EACxB,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,KAAK,IAAI,EAAE,EACxB,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,KAAK,IAAI,EAAE,EACxB,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,KAAK,IAAI,EAAE,CAC3B;AAED,QAAA,OAAO,IAAI;IACf;IAEO,OAAO,GAAA;AACV,QAAA,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE;AACzB,QAAA,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE;IAC3B;AACH;;;;"}

package/dist/esm/particles/affectors/ForceAffector.d.ts

@@ -2,12 +2,23 @@ import type { ParticleAffector } from '@/particles/affectors/ParticleAffector';
 import { Vector } from '@/math/Vector';
 import type { Particle } from '@/particles/Particle';
 import type { Time } from '@/core/Time';
+/**
+ * Applies a constant 2-D acceleration to every particle's
+ * {@link Particle.velocity} each tick, simulating forces such as gravity
+ * (`new ForceAffector(0, 980)`) or wind. Velocity is mutated in place;
+ * the system then integrates position from velocity in
+ * {@link ParticleSystem.updateParticle}.
+ */
 export declare class ForceAffector implements ParticleAffector {
     private readonly _acceleration;
     constructor(accelerationX: number, accelerationY: number);
     get acceleration(): Vector;
     set acceleration(acceleration: Vector);
     setAcceleration(acceleration: Vector): this;
+    /**
+     * Adds `acceleration * delta.seconds` to `particle.velocity`, implementing
+     * Euler integration for the configured force vector.
+     */
     apply(particle: Particle, delta: Time): this;
     destroy(): void;
 }

package/dist/esm/particles/affectors/ForceAffector.js

@@ -1,5 +1,12 @@
 import { Vector } from '../../math/Vector.js';
 
+/**
+ * Applies a constant 2-D acceleration to every particle's
+ * {@link Particle.velocity} each tick, simulating forces such as gravity
+ * (`new ForceAffector(0, 980)`) or wind. Velocity is mutated in place;
+ * the system then integrates position from velocity in
+ * {@link ParticleSystem.updateParticle}.
+ */
 class ForceAffector {
     _acceleration;
     constructor(accelerationX, accelerationY) {
@@ -15,6 +22,10 @@ class ForceAffector {
         this._acceleration.copy(acceleration);
         return this;
     }
+    /**
+     * Adds `acceleration * delta.seconds` to `particle.velocity`, implementing
+     * Euler integration for the configured force vector.
+     */
     apply(particle, delta) {
         particle.velocity.add(delta.seconds * this._acceleration.x, delta.seconds * this._acceleration.y);
         return this;

package/dist/esm/particles/affectors/ForceAffector.js.map

@@ -1 +1 @@
-{"version":3,"file":"ForceAffector.js","sources":["../../../../../src/particles/affectors/ForceAffector.ts"],"sourcesContent":[null],"names":[],"mappings":";;MAKa,aAAa,CAAA;AAEL,IAAA,aAAa;IAE9B,WAAA,CAAmB,aAAqB,EAAE,aAAqB,EAAA;QAC3D,IAAI,CAAC,aAAa,GAAG,IAAI,MAAM,CAAC,aAAa,EAAE,aAAa,CAAC;IACjE;AAEA,IAAA,IAAW,YAAY,GAAA;QACnB,OAAO,IAAI,CAAC,aAAa;IAC7B;IAEA,IAAW,YAAY,CAAC,YAAoB,EAAA;AACxC,QAAA,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC;IACtC;AAEO,IAAA,eAAe,CAAC,YAAoB,EAAA;AACvC,QAAA,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC;AAErC,QAAA,OAAO,IAAI;IACf;IAEO,KAAK,CAAC,QAAkB,EAAE,KAAW,EAAA;QACxC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CACjB,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,EACpC,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,CACvC;AAED,QAAA,OAAO,IAAI;IACf;IAEO,OAAO,GAAA;AACV,QAAA,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE;IAChC;AACH;;;;"}
+{"version":3,"file":"ForceAffector.js","sources":["../../../../../src/particles/affectors/ForceAffector.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAKA;;;;;;AAMG;MACU,aAAa,CAAA;AAEL,IAAA,aAAa;IAE9B,WAAA,CAAmB,aAAqB,EAAE,aAAqB,EAAA;QAC3D,IAAI,CAAC,aAAa,GAAG,IAAI,MAAM,CAAC,aAAa,EAAE,aAAa,CAAC;IACjE;AAEA,IAAA,IAAW,YAAY,GAAA;QACnB,OAAO,IAAI,CAAC,aAAa;IAC7B;IAEA,IAAW,YAAY,CAAC,YAAoB,EAAA;AACxC,QAAA,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC;IACtC;AAEO,IAAA,eAAe,CAAC,YAAoB,EAAA;AACvC,QAAA,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC;AAErC,QAAA,OAAO,IAAI;IACf;AAEA;;;AAGG;IACI,KAAK,CAAC,QAAkB,EAAE,KAAW,EAAA;QACxC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CACjB,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,EACpC,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,CACvC;AAED,QAAA,OAAO,IAAI;IACf;IAEO,OAAO,GAAA;AACV,QAAA,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE;IAChC;AACH;;;;"}

package/dist/esm/particles/affectors/ParticleAffector.d.ts

@@ -1,6 +1,19 @@
 import type { Particle } from '@/particles/Particle';
 import type { Time } from '@/core/Time';
+/**
+ * Contract for all per-particle mutators that run once per tick. Each
+ * affector is registered on a {@link ParticleSystem} and called after
+ * position integration for every live particle. Concrete implementations
+ * (e.g. {@link ColorAffector}, {@link ForceAffector}, {@link ScaleAffector},
+ * {@link TorqueAffector}) mutate one or more {@link ParticleProperties} fields
+ * in place.
+ */
 export interface ParticleAffector {
+    /**
+     * Mutates `particle` properties for the current `delta` timestep.
+     * Called by {@link ParticleSystem.update} for every non-expired particle.
+     */
     apply(particle: Particle, delta: Time): this;
+    /** Releases any resources owned by this affector. */
     destroy(): void;
 }

package/dist/esm/particles/affectors/ScaleAffector.d.ts

@@ -2,12 +2,22 @@ import type { ParticleAffector } from '@/particles/affectors/ParticleAffector';
 import { Vector } from '@/math/Vector';
 import type { Time } from '@/core/Time';
 import type { Particle } from '@/particles/Particle';
+/**
+ * Additively grows or shrinks a particle's {@link Particle.scale} each tick
+ * by a constant rate vector. A positive factor enlarges the sprite; a
+ * negative factor shrinks it. Use `new ScaleAffector(-1, -1)` to make
+ * particles fade out in size over one second.
+ */
 export declare class ScaleAffector implements ParticleAffector {
     private readonly _scaleFactor;
     constructor(factorX: number, factorY: number);
     get scaleFactor(): Vector;
     set scaleFactor(scaleFactor: Vector);
     setScaleFactor(scaleFactor: Vector): this;
+    /**
+     * Adds `scaleFactor * delta.seconds` to `particle.scale` on both axes,
+     * implementing linear scale drift for the configured rate.
+     */
     apply(particle: Particle, delta: Time): this;
     destroy(): void;
 }

package/dist/esm/particles/affectors/ScaleAffector.js

@@ -1,5 +1,11 @@
 import { Vector } from '../../math/Vector.js';
 
+/**
+ * Additively grows or shrinks a particle's {@link Particle.scale} each tick
+ * by a constant rate vector. A positive factor enlarges the sprite; a
+ * negative factor shrinks it. Use `new ScaleAffector(-1, -1)` to make
+ * particles fade out in size over one second.
+ */
 class ScaleAffector {
     _scaleFactor;
     constructor(factorX, factorY) {
@@ -15,6 +21,10 @@ class ScaleAffector {
         this._scaleFactor.copy(scaleFactor);
         return this;
     }
+    /**
+     * Adds `scaleFactor * delta.seconds` to `particle.scale` on both axes,
+     * implementing linear scale drift for the configured rate.
+     */
     apply(particle, delta) {
         particle.scale.add(delta.seconds * this._scaleFactor.x, delta.seconds * this._scaleFactor.y);
         return this;

package/dist/esm/particles/affectors/ScaleAffector.js.map

@@ -1 +1 @@
-{"version":3,"file":"ScaleAffector.js","sources":["../../../../../src/particles/affectors/ScaleAffector.ts"],"sourcesContent":[null],"names":[],"mappings":";;MAKa,aAAa,CAAA;AAEL,IAAA,YAAY;IAE7B,WAAA,CAAmB,OAAe,EAAE,OAAe,EAAA;QAC/C,IAAI,CAAC,YAAY,GAAG,IAAI,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC;IACpD;AAEA,IAAA,IAAW,WAAW,GAAA;QAClB,OAAO,IAAI,CAAC,YAAY;IAC5B;IAEA,IAAW,WAAW,CAAC,WAAmB,EAAA;AACtC,QAAA,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC;IACpC;AAEO,IAAA,cAAc,CAAC,WAAmB,EAAA;AACrC,QAAA,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC;AAEnC,QAAA,OAAO,IAAI;IACf;IAEO,KAAK,CAAC,QAAkB,EAAE,KAAW,EAAA;QACxC,QAAQ,CAAC,KAAK,CAAC,GAAG,CACd,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,EACnC,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CACtC;AAED,QAAA,OAAO,IAAI;IACf;IAEO,OAAO,GAAA;AACV,QAAA,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE;IAC/B;AACH;;;;"}
+{"version":3,"file":"ScaleAffector.js","sources":["../../../../../src/particles/affectors/ScaleAffector.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAKA;;;;;AAKG;MACU,aAAa,CAAA;AAEL,IAAA,YAAY;IAE7B,WAAA,CAAmB,OAAe,EAAE,OAAe,EAAA;QAC/C,IAAI,CAAC,YAAY,GAAG,IAAI,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC;IACpD;AAEA,IAAA,IAAW,WAAW,GAAA;QAClB,OAAO,IAAI,CAAC,YAAY;IAC5B;IAEA,IAAW,WAAW,CAAC,WAAmB,EAAA;AACtC,QAAA,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC;IACpC;AAEO,IAAA,cAAc,CAAC,WAAmB,EAAA;AACrC,QAAA,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC;AAEnC,QAAA,OAAO,IAAI;IACf;AAEA;;;AAGG;IACI,KAAK,CAAC,QAAkB,EAAE,KAAW,EAAA;QACxC,QAAQ,CAAC,KAAK,CAAC,GAAG,CACd,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,EACnC,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CACtC;AAED,QAAA,OAAO,IAAI;IACf;IAEO,OAAO,GAAA;AACV,QAAA,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE;IAC/B;AACH;;;;"}

package/dist/esm/particles/affectors/TorqueAffector.d.ts

@@ -1,12 +1,23 @@
 import type { ParticleAffector } from '@/particles/affectors/ParticleAffector';
 import type { Particle } from '@/particles/Particle';
 import type { Time } from '@/core/Time';
+/**
+ * Accelerates a particle's angular velocity ({@link Particle.rotationSpeed})
+ * by a constant `angularAcceleration` (degrees per second²) each tick.
+ * The updated `rotationSpeed` is then integrated into
+ * {@link Particle.rotation} by {@link ParticleSystem.updateParticle}.
+ * Use a negative value to decelerate spin over time.
+ */
 export declare class TorqueAffector implements ParticleAffector {
     private _angularAcceleration;
     constructor(angularAcceleration: number);
     get angularAcceleration(): number;
     set angularAcceleration(angularAcceleration: number);
     setAngularAcceleration(angularAcceleration: number): this;
+    /**
+     * Adds `angularAcceleration * delta.seconds` to `particle.rotationSpeed`,
+     * increasing or decreasing spin rate for this timestep.
+     */
     apply(particle: Particle, delta: Time): this;
     destroy(): void;
 }

package/dist/esm/particles/affectors/TorqueAffector.js

@@ -1,3 +1,10 @@
+/**
+ * Accelerates a particle's angular velocity ({@link Particle.rotationSpeed})
+ * by a constant `angularAcceleration` (degrees per second²) each tick.
+ * The updated `rotationSpeed` is then integrated into
+ * {@link Particle.rotation} by {@link ParticleSystem.updateParticle}.
+ * Use a negative value to decelerate spin over time.
+ */
 class TorqueAffector {
     _angularAcceleration;
     constructor(angularAcceleration) {
@@ -13,6 +20,10 @@ class TorqueAffector {
         this._angularAcceleration = angularAcceleration;
         return this;
     }
+    /**
+     * Adds `angularAcceleration * delta.seconds` to `particle.rotationSpeed`,
+     * increasing or decreasing spin rate for this timestep.
+     */
     apply(particle, delta) {
         particle.rotationSpeed += (delta.seconds * this._angularAcceleration);
         return this;

package/dist/esm/particles/affectors/TorqueAffector.js.map

@@ -1 +1 @@
-{"version":3,"file":"TorqueAffector.js","sources":["../../../../../src/particles/affectors/TorqueAffector.ts"],"sourcesContent":[null],"names":[],"mappings":"MAIa,cAAc,CAAA;AAEf,IAAA,oBAAoB;AAE5B,IAAA,WAAA,CAAmB,mBAA2B,EAAA;AAC1C,QAAA,IAAI,CAAC,oBAAoB,GAAG,mBAAmB;IACnD;AAEA,IAAA,IAAW,mBAAmB,GAAA;QAC1B,OAAO,IAAI,CAAC,oBAAoB;IACpC;IAEA,IAAW,mBAAmB,CAAC,mBAA2B,EAAA;AACtD,QAAA,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,CAAC;IACpD;AAEO,IAAA,sBAAsB,CAAC,mBAA2B,EAAA;AACrD,QAAA,IAAI,CAAC,oBAAoB,GAAG,mBAAmB;AAE/C,QAAA,OAAO,IAAI;IACf;IAEO,KAAK,CAAC,QAAkB,EAAE,KAAW,EAAA;AACxC,QAAA,QAAQ,CAAC,aAAa,KAAK,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,oBAAoB,CAAC;AAErE,QAAA,OAAO,IAAI;IACf;IAEO,OAAO,GAAA;;IAEd;AACH;;;;"}
+{"version":3,"file":"TorqueAffector.js","sources":["../../../../../src/particles/affectors/TorqueAffector.ts"],"sourcesContent":[null],"names":[],"mappings":"AAIA;;;;;;AAMG;MACU,cAAc,CAAA;AAEf,IAAA,oBAAoB;AAE5B,IAAA,WAAA,CAAmB,mBAA2B,EAAA;AAC1C,QAAA,IAAI,CAAC,oBAAoB,GAAG,mBAAmB;IACnD;AAEA,IAAA,IAAW,mBAAmB,GAAA;QAC1B,OAAO,IAAI,CAAC,oBAAoB;IACpC;IAEA,IAAW,mBAAmB,CAAC,mBAA2B,EAAA;AACtD,QAAA,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,CAAC;IACpD;AAEO,IAAA,sBAAsB,CAAC,mBAA2B,EAAA;AACrD,QAAA,IAAI,CAAC,oBAAoB,GAAG,mBAAmB;AAE/C,QAAA,OAAO,IAAI;IACf;AAEA;;;AAGG;IACI,KAAK,CAAC,QAAkB,EAAE,KAAW,EAAA;AACxC,QAAA,QAAQ,CAAC,aAAa,KAAK,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,oBAAoB,CAAC;AAErE,QAAA,OAAO,IAAI;IACf;IAEO,OAAO,GAAA;;IAEd;AACH;;;;"}