Interface ParticleEmitterOptions

Whether particles can rotate.

Optional world-space bounds — particles outside die instantly.

Periodic-burst count (particles per burst). Combined with burstInterval, fires a burst every burstInterval seconds.

Period of automatic bursts in seconds. Has no effect when burstCount is 0.

Whether the emitter is active.

Lifetime range maximum (s).

Lifetime range minimum (s).

Maximum simultaneously alive particles. The pool size is capped at this value too.

Fired when a particle's body collides with another body. Requires particleCbType to be set. The handler runs from inside a Space callback — do not mutate the space synchronously; use ParticleEmitter.requestKill for deferred cleanup.

Fired when a particle dies (lifetime, bounds, manual, or killAll).

Fired once per spawn, after the body is in the space.

Fired every update() for each live particle (ages > 0).

Spawn anchor. A Vec2 is captured by reference (mutating it after construction moves the emitter); a Body is tracked by position each spawn (the body does not need to be in the same space). Required.

Policy when maxParticles is reached.

Collision-callback type tagged on every particle body. Required for onCollide to fire. The emitter never auto-creates one — pass your own if you need it (so multiple emitters can share a type, or a single emitter can match a user-defined cbType).

Filter applied to every particle shape. If omitted and selfCollision is false, the emitter generates a self-excluding filter automatically.

Material applied to every particle shape.

Polygon vertices in body-local space (used when particleShape: "polygon"). Defaults to a small square.

Radius for circle particles. Ignored for polygon.

Body shape for each particle.

Deterministic RNG. All emitter randomness (spawn jitter, velocity cone, lifetime sampling) flows through this.

Continuous spawn rate in particles/second. Accumulated across update() calls — fractional rates work. 0 disables continuous spawning (use ParticleEmitter.emit for manual bursts).

When false and no explicit particleFilter is given, particles receive a generated filter that skips its own group — particles in the same emitter never collide with each other. Has no effect when particleFilter is provided.

Space the emitted particle bodies live in. Required.

Spawn-position pattern.

Initial velocity pattern.