API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

I

interfaceBurstSpawnConfig

@codexo/exojs-particles / particles / stable

Spawn configuration for BurstSpawn: the burst schedule plus the shared per-property fields.

10
props
0
methods
0
events
Import
import { BurstSpawnConfig } from '@codexo/exojs-particles'

Spawn configuration for BurstSpawn: the burst schedule plus the shared per-property fields.

Properties10
interval?: number
Seconds from one run of the schedule to the next, measured from the schedule's own t=0. Omit for a one-shot: the schedule fires once and then stays exhausted until BurstSpawn.reset. The clock wraps by subtracting the period rather than restarting from zero, so overshoot carries into the next cycle and a given span of time produces the same bursts at any frame rate. A period shorter than the schedule's last entry overlaps cycles; each one still fires in full.
lifetime?: DistributionValue distribution sampled at particle spawn time. Each `sample()` call may return a different value - used to randomize spawn properties (lifetime, position,…<number>
Total lifetime in seconds. Drives expiry.
position?: DistributionValue distribution sampled at particle spawn time. Each `sample()` call may return a different value - used to randomize spawn properties (lifetime, position,…<VectorConcrete mutable 2D vector with full AbstractVector arithmetic and Collidable collision support (treated as a point collider). `Vector.temp` provides a shared…>
rotation?: DistributionValue distribution sampled at particle spawn time. Each `sample()` call may return a different value - used to randomize spawn properties (lifetime, position,…<number>
rotationSpeed?: DistributionValue distribution sampled at particle spawn time. Each `sample()` call may return a different value - used to randomize spawn properties (lifetime, position,…<number>
scale?: DistributionValue distribution sampled at particle spawn time. Each `sample()` call may return a different value - used to randomize spawn properties (lifetime, position,…<VectorConcrete mutable 2D vector with full AbstractVector arithmetic and Collidable collision support (treated as a point collider). `Vector.temp` provides a shared…>
schedule: readonly BurstScheduleBurst trigger schedule. The module fires at `time` seconds (since registration), spawning `count` particles in one frame.[]
textureIndex?: DistributionValue distribution sampled at particle spawn time. Each `sample()` call may return a different value - used to randomize spawn properties (lifetime, position,…<number>
Atlas frame index. Ignored by a system that declares no frames.
tint?: DistributionValue distribution sampled at particle spawn time. Each `sample()` call may return a different value - used to randomize spawn properties (lifetime, position,…<Color32-bit RGBA color value with channel-wise accessors. Red, green, and blue are integers in 0..255; alpha is a float in 0..1. Out-of-range values are saturated o…>
Initial tint. For a per-frame fade use a ColorOverLifetime update module.
velocity?: DistributionValue distribution sampled at particle spawn time. Each `sample()` call may return a different value - used to randomize spawn properties (lifetime, position,…<VectorConcrete mutable 2D vector with full AbstractVector arithmetic and Collidable collision support (treated as a point collider). `Vector.temp` provides a shared…>
Source
packages/exojs-particles/src/modules/BurstSpawn.ts