ReferenceScripting APIParticleComponentburst
ParticleComponent.burst
methodFires a burst of particles.
| Name | burst |
|---|---|
| Kind | method of ParticleComponent |
| Called as | particleComponent.burst(…) |
| As a node | Burst Particles (logic graph) |
| Since | 0.4 |
Syntax
burst( count?: number, at?: [number, number] | { x: number; y: number }, emitter?: string | number): voidParameters
| Name | Type | Description |
|---|---|---|
count | number | Optional. How many (30 unless given), 2000 at most |
at | [number, number] | { x: number; y: number } | Optional. Where, 0 to 1 across and down the layer ({ x, y } or [x, y]); at the emitter unless given |
emitter | string | number | Optional. Which emitter, by its number (0 the first) or name; the first unless given |
Returns
Nothing.
Remarks
While the scene's paused the burst waits for it to play again; at most 20000 wait at once. An emitter that isn't there does nothing, and the console says so.
Example
scene.particles("Sparks").burst(200, { x: 0.5, y: 0.3 });Notes from the community
Written by creators and checked by the docs' editors. Not part of Motion's official reference.