BurstConfig

Defined in: src/modules/particles/particles.ts:40

Configuration for burst (and the per-emission config of an emitter).

Properties

angle?

optional angle?: number

Defined in: src/modules/particles/particles.ts:42

Centre launch direction (radians). Omit for a full-circle radial spray.

---

colors

colors: string | readonly string[]

Defined in: src/modules/particles/particles.ts:44

Fill colour, or a palette to pick from per particle.

---

count

count: number

Defined in: src/modules/particles/particles.ts:46

Number of particles to spawn.

---

damping?

optional damping?: number

Defined in: src/modules/particles/particles.ts:48

Fractional velocity decay per second (0 = none, 1 = fully damped in 1s).

---

fadeOut?

optional fadeOut?: boolean

Defined in: src/modules/particles/particles.ts:53

Fade alpha 1 → 0 over life (adds OpacityDef). The curve is the system-global fadeEasing of makeParticleSystem (default linear).

---

gravity?

optional gravity?: object

Defined in: src/modules/particles/particles.ts:55

Constant acceleration (world units / second²) applied to velocity each tick.

x

x: number

y

y: number

---

jitter?

optional jitter?: number

Defined in: src/modules/particles/particles.ts:60

Jitter (radians) added to each particle’s launch direction. Defaults to a small 0.4 in radial mode (no angle) and to spread in cone mode.

---

lifetimeMs

lifetimeMs: Range

Defined in: src/modules/particles/particles.ts:62

Lifetime range (ms).

---

position

position: object

Defined in: src/modules/particles/particles.ts:64

Emission centre in world coords.

x

x: number

y

y: number

---

renderOrder?

optional renderOrder?: number

Defined in: src/modules/particles/particles.ts:66

RenderOrderDef value. Default 0.

---

rng?

optional rng?: RandomFn

Defined in: src/modules/particles/particles.ts:68

Random source for all sampling. Default Math.random; pass a seeded rng for determinism.

---

shape?

optional shape?: EmissionShape

Defined in: src/modules/particles/particles.ts:70

Where particles spawn relative to position. Default { kind: 'point' }.

---

shrink?

optional shrink?: boolean | { to: number; }

Defined in: src/modules/particles/particles.ts:75

Shrink scale 1 → to over life (adds ScaleDef); true shrinks to 0. The curve is the system-global shrinkEasing of makeParticleSystem.

---

size

size: Range

Defined in: src/modules/particles/particles.ts:77

Square particle size range (px); width and height are sampled together.

---

speed

speed: Range

Defined in: src/modules/particles/particles.ts:79

Initial speed range (world units / second).

---

spin?

optional spin?: number

Defined in: src/modules/particles/particles.ts:81

Angular velocity (radians / second); adds RotationDef and spins the particle.

---

spread?

optional spread?: number

Defined in: src/modules/particles/particles.ts:83

Cone half-width (radians) around angle. Default Math.PI (full circle).