Class
Sparkles
A particle emitter with the visual aesthetic of sparkles.
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.
Properties 4#
ColorColor3 | Determines the color of the sparkle particles.ReadSafeDeprecatedHiddenNotReplicated |
Enabledboolean | Determines whether sparkles are emit.ReadSafe |
SparkleColorColor3 | Determines the color of the sparkle particles.ReadSafe |
TimeScalefloat | Controls the speed of the sparkle effect.ReadSafe |
Color: Color3#
HiddenNotReplicatedReadSafeDeprecated
Deprecated. This property is deprecated in favor of Sparkles.SparkleColor,
which does the exact same thing.
The Color 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.
Enabled: boolean#
ReadSafe
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.
SparkleColor: Color3#
ReadSafe
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.
TimeScale: float#
ReadSafe
A value from 0 to 1 that controls the speed of the sparkle effect. A value of 1 runs the effect at normal speed, 0.5 runs it at half speed, and 0 freezes the effect.
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild