1681-engine / index / EmitterOptions
Interface: EmitterOptions ​
Defined in: src/particles/Emitter.ts:12
Properties ​
alpha? ​
optional alpha?: Curve;Defined in: src/particles/Emitter.ts:35
Opacity over life (default fading from 1 to 0).
angle? ​
optional angle?: number;Defined in: src/particles/Emitter.ts:24
Direction of travel in radians (default -π/2, up the screen) and how far either way it may turn (default π).
area? ​
optional area?: SpawnArea;Defined in: src/particles/Emitter.ts:44
Where particles appear round the emitter (default its exact point).
blend? ​
optional blend?: "normal" | "add";Defined in: src/particles/Emitter.ts:42
'add' for glows, sparks and fire; 'normal' for smoke and debris (default 'normal').
budget? ​
optional budget?: ParticleBudget;Defined in: src/particles/Emitter.ts:50
The budget shared with other emitters (default the engine-wide particleBudget).
capacity? ​
optional capacity?: number;Defined in: src/particles/Emitter.ts:16
Particles this emitter may hold at once (default 256).
cullMargin? ​
optional cullMargin?: number;Defined in: src/particles/Emitter.ts:46
World px beyond the screen within which the emitter still spawns and draws (default 64).
drag? ​
optional drag?: number;Defined in: src/particles/Emitter.ts:30
Share of speed lost per second (default 0).
gravityX? ​
optional gravityX?: number;Defined in: src/particles/Emitter.ts:27
Px/s² added to velocity (default none).
gravityY? ​
optional gravityY?: number;Defined in: src/particles/Emitter.ts:28
lifetime? ​
optional lifetime?: Range;Defined in: src/particles/Emitter.ts:20
Seconds a particle lives (default 1).
random? ​
optional random?: () => number;Defined in: src/particles/Emitter.ts:52
Random source (default Math.random); a seeded one makes an emitter replayable.
Returns ​
number
rate? ​
optional rate?: number;Defined in: src/particles/Emitter.ts:18
Particles a second while emitting (default 0: bursts only).
rotation? ​
optional rotation?: Range;Defined in: src/particles/Emitter.ts:39
Starting rotation and spin, radians and radians/s (default 0).
size? ​
optional size?: Curve;Defined in: src/particles/Emitter.ts:32
Scale of the texture over life (default 1), and how much each particle's size may differ (0–1, default 0).
sizeVariance? ​
optional sizeVariance?: number;Defined in: src/particles/Emitter.ts:33
speed? ​
optional speed?: Range;Defined in: src/particles/Emitter.ts:22
Starting speed, px/s (default [40, 80]).
spin? ​
optional spin?: Range;Defined in: src/particles/Emitter.ts:40
spread? ​
optional spread?: number;Defined in: src/particles/Emitter.ts:25
texture ​
texture: Texture;Defined in: src/particles/Emitter.ts:14
Every particle's texture. One emitter draws one texture (a frame of an atlas works: they share a source).
thinFactor? ​
optional thinFactor?: number;Defined in: src/particles/Emitter.ts:48
Share of particles kept under reduced effects or the battery saver (default 0.35).
tint? ​
optional tint?: Curve;Defined in: src/particles/Emitter.ts:37
Tint over life, 0xrrggbb (default white).