burstParticles

Function

burstParticles

Server and clientParticlesTrilogy Hub only

Releases the given number of particles at once, regardless of rate: an explosion, a hit, a burst of confetti.

Syntax

bool burstParticles(element emitter, int count)

Arguments

emitterelement: The emitter.
countint: Number of particles (1 to 2000).

Returns

true on success.

Example

Confetti on a command; the emitter releases nothing by itself.

local x, y, z = getElementPosition(localPlayer)
local party = createParticleEmitter(x, y, z, "confetti", { rate = 0 })
addCommandHandler("party", function()
    burstParticles(party, 400)
end)