Sparkles
A particle emitter with the visual aesthetic of sparkles.
Memory category | Instances |
---|
Member index 6
Description
Sparkles is one of several particle-emitting classes. Like other particle emitters of its kind, Sparkles objects emit particles when parented to a BasePart (such as a Part) or an Attachment within such a BasePart. Compared to the ParticleEmitter class, Sparkles lacks many different customization properties and special methods, such as ParticleEmitter.Lifetime or ParticleEmitter:Emit(). It is useful to create a quick special effect in a pinch; for more detailed work it is preferable to use a ParticleEmitter instead.
When Sparkles.Enabled is toggled off, particles emit by this object will continue to render until their lifetime expires. When a Sparkles object's Instance.Parent is set to nil (and/or Instance:Destroy()ed), all particles will instantly disappear. If this effect is not desired, try hiding the parent object at a far away position, then removing the Sparkles after a few seconds using Debris to give the last particles a chance to expire. This object does not have a ParticleEmitter:Clear() method, but it is possible to set the Instance.Parent to nil and back to the exact same object for the same effect.
Sparkles particles are only emitted from the center of BasePart to which they are parented. Parenting a Sparkles object to an Attachment instead allows customization of the particles' start position.
History 18
- 626 Add
- 573 Change ReturnType of FastForward from void to null
- 553 Change Default of TimeScale from to 1
- 553 Change Default of SparkleColor from to Color3(0.564706, 0.0980392, 1)
- 553 Change Default of Enabled from to true
- 553 Change Default of from to Color3(1, 1, 1)
- 548 Add FastForward
- 508 Add TimeScale
- 486 Change ThreadSafety of SparkleColor from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Enabled from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 462 Change ThreadSafety of SparkleColor from to ReadOnly
- 462 Change ThreadSafety of Enabled from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 47 Add SparkleColor
- 47 Add Enabled
- 47 Add
- 47 Add Sparkles
Members 6
Enabled
Type | Default | |
---|---|---|
bool | true |
The Enabled property, much like ParticleEmitter.Enabled,
determines whether sparkle particles are emit. Any particles already emit
will continue to render until their lifetime expires. This property is
useful for keeping pre-made sparkle effects off until they are needed
later. Since sparkle particles are destroyed when the Sparkle
object's
Instance.Parent is set to nil, this property is useful in allowing
existing particles the opportunity to expire before destroying the Fire
object altogether. See the function below.
local Debris = game:GetService("Debris")
local part = script.Parent
function stopSparkling(sparkles)
sparkles.Enabled = false -- No more new particles
Debris:AddItem(sparkles, 4) -- Remove the object after a delay (after existing particles have expired)
end
stopSparkling(part.Sparkles)
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | true |
FastForward
Parameters (1) | ||
---|---|---|
numFrames | int | |
Returns (1) | ||
null |
Security | RobloxScriptSecurity |
---|---|
Thread safety | Unsafe |
History 2
- 573 Change ReturnType of FastForward from void to null
- 548 Add FastForward
SparkleColor
Type | Default | |
---|---|---|
Color3 | 0.564706, 0.0980392, 1 |
This property functions identically to Sparkles.Color.
The SparkleColor property determines the color of all the particles emit by a Sparkles object (both existing and future particles). It behaves similarly to ParticleEmitter.Color, except that it is only one color and not a ColorSequence. Sparkles have a natural color sequence applied which is most apparent when this property is set to white; sparkles very faintly animate between a subtle green and red.
It should be noted that sparkles have a partial ParticleEmitter.LightEmission effect, so dark colors tend to render more transparent and white colors look very bright.
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | true |
History 4
- 553 Change Default of SparkleColor from to Color3(0.564706, 0.0980392, 1)
- 486 Change ThreadSafety of SparkleColor from ReadOnly to ReadSafe
- 462 Change ThreadSafety of SparkleColor from to ReadOnly
- 47 Add SparkleColor
TimeScale
Type | Default | |
---|---|---|
float | 1 |
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | true |