Documentation
Particles

Particles

All Lua functions and events in the Particles category, on the server and the client.

ParticlesMoving particles simulated by the game: 14 ready-made effects, custom settings, attaching to vehicles and players, server effects everyone sees.

Client functions 1

getParticleCountReturns the number of living particles of the emitter. An emitter further than maxDistance from the camera computes nothing and returns 0.

Shared functions 10

burstParticlesReleases the given number of particles at once, regardless of rate: an explosion, a hit, a burst of confetti.
createParticleEffectA short effect: the emitter releases particles for the given time and removes itself once the last one fades. No need to destroy it. On the server, every player nearby sees the effect.
createParticleEmitterCreates an emitter of moving particles simulated by the game: fire, smoke, sparks, snow, portals and anything you build from the settings. The fourth argument is a preset name or a settings table, the fifth overrides chosen fields of the preset. Returns a "particle" element that can be moved, attached and destroyed like any other. Called on the server, it creates an emitter every player sees.
getParticleEmitterSettingsReturns a copy of the emitter's settings. You can change it and pass it back to setParticleEmitterSettings.
getParticlePresetsReturns the ready-made particle effects as a { name = description } table.
getParticlePresetSettingsReturns a copy of a preset's full settings, as a starting point for your own.
getParticleSpritesReturns the names of the built-in particle shapes (the sprite field).
isParticleEmitterEnabledChecks whether the emitter releases new particles.
setParticleEmitterEnabledStarts or pauses releasing new particles. A disabled emitter lets the particles already released live out their life; enabling it again restarts the duration time.
setParticleEmitterSettingsChanges chosen settings of a running emitter (the same fields as in createParticleEmitter), the rest stays. Living particles pick up the new colour and size immediately.