Skip to Content
Kinemium

ParticleEmitter

Spawn and animate particles from a part.

ParticleEmitter emits particles from its parent part. Rate, lifetime, speed, size, color, transparency, rotation, and flipbook settings control how they look.

Getting started

local emitter = Instance.new("ParticleEmitter")
emitter.Rate = 40
emitter.Lifetime = NumberRange.new(0.5, 1.2)
emitter.Speed = NumberRange.new(4, 8)
emitter.SpreadAngle = Vector2.new(15, 15)
emitter.Size = NumberSequence.new(0.4)
emitter.Transparency = NumberSequence.new({
    NumberSequenceKeypoint.new(0, 0),
    NumberSequenceKeypoint.new(1, 1),
})
emitter.Parent = part

Properties

PropertyTypeAccessDescription
EnabledbooleanRead/writeWhether new particles spawn.
RatenumberRead/writeParticles per second, clamped to 0 through 2048.
LifetimeNumberRangeRead/writeParticle lifetime range, each bound clamped to 0 through 120.
SpeedNumberRangeRead/writeInitial speed range, each bound clamped to -10000 through 10000.
RotationNumberRangeRead/writeInitial rotation range in degrees.
RotSpeedNumberRangeRead/writeRotation speed range.
SpreadAngleVector2Read/writeEmission cone on each axis, clamped to 0 through 360.
AccelerationVector3Read/writeConstant acceleration applied to particles. Must be finite.
DragnumberRead/writeVelocity damping, clamped to 0 through 1000.
WindAffectsDragbooleanRead/writeWhether wind influences drag.
ColorColorSequenceRead/writeColor over each particle's lifetime.
SizeNumberSequenceRead/writeSize over each particle's lifetime.
TransparencyNumberSequenceRead/writeTransparency over each particle's lifetime.
LightEmissionnumberRead/writeEmissive strength, clamped to 0 through 1.
BrightnessnumberRead/writeParticle brightness, clamped to 0 through 100.
ZOffsetnumberRead/writeDepth offset, clamped to -10000 through 10000.
TexturestringRead/writeParticle texture URI.
EmissionDirectionEnum.NormalIdRead/writeFace the particles emit from.
FlipbookLayoutEnum.ParticleFlipbookLayoutRead/writeFlipbook grid layout.
FlipbookModeEnum.ParticleFlipbookModeRead/writeFlipbook playback mode.
FlipbookFramerateNumberRangeRead/writeFlipbook frame rate, each bound clamped to 0 through 120.
VelocitySpreadnumberRead/writeConvenience setter for both SpreadAngle axes, clamped to 0 through 360.

Methods

SignatureDescription
Emit(count?: number)Spawns a burst of particles.
Clear()Removes all live particles.

Notes

  • Out-of-range numbers clamp rather than raise, except NaN and non-finite vectors, which raise an error for the affected property.
  • VelocitySpread writes the same value to both SpreadAngle components.
  • The parent must be a Part; the emitter uses the part transform for emission.
  • Changing Texture releases the previously loaded texture.
  • Color, size, and transparency sequences are copied on assignment.

See also

  • Part for the emitter's parent.
  • NumberSequenceValue and ColorSequenceValue for reusable sequences.

On this page