API:Class/ParticleEmitter

ExplorerImageIndex80.pngParticleEmitter : Object Icon.pngInstance

The ParticleEmitter creates a stream of particles emanating from the emitter's parent. These particles are customizable in terms of Texture, Size, Color, Transparency, and Speed. Particle emitters must be parented to either an Attachment or BasePart to be rendered in the world.

Particle emitters spawn particles at a constant rate anywhere within the parent volume. This volume is 0 if parented to an attachment (this means that all the particles will be emitted from the WorldPosition of the attachment).

By default the particles move in the positive y-direction in the local space of its parent.

Properties

PropertiesmemberhiddenProperties [toggle]

Vector3Acceleration

Applies constant acceleration in world coordinates to all particles created by the emitter.

|RMD member="API:Class/ParticleEmitter/Acceleration"|Applies constant acceleration in world coordinates to all particles created by the emitter.|/RMD|
ColorSequenceColor

Determines the color of the particle when it first spawns, and the color of the particle at the end of its lifetime.

|RMD member="API:Class/ParticleEmitter/Color"|Determines the color of the particle when it first spawns, and the color of the particle at the end of its lifetime.|/RMD|
floatDrag

Sets the rate per second in which each particle will lose half of its speed by exponential decay.

|RMD member="API:Class/ParticleEmitter/Drag"|Sets the rate per second in which each particle will lose half of its speed by exponential decay.|/RMD|
NormalIdEmissionDirection

The face of the part where the particles emit from.

|RMD member="API:Class/ParticleEmitter/EmissionDirection"|The face of the part where the particles emit from.|/RMD|
boolEnabled

Toggles whether or not the ParticleEmitter is emitting particles.

|RMD member="API:Class/ParticleEmitter/Enabled"|Toggles whether or not the ParticleEmitter is emitting particles.|/RMD|
NumberRangeLifetime

Defines the maximum and minimum lifetime of a particle created by the emitter. Maximum is capped at 20 seconds.

|RMD member="API:Class/ParticleEmitter/Lifetime"|Defines the maximum and minimum lifetime of a particle created by the emitter. Maximum is capped at 20 seconds.|/RMD|
floatLightEmission

Sets how much the colors of the emitter's particles are blended with the colors behind them.

|RMD member="API:Class/ParticleEmitter/LightEmission"|Sets how much the colors of the emitter's particles are blended with the colors behind them.|/RMD|
floatLightInfluence

Controls how much emitted particles are influenced by the lighting engine.

|RMD member="API:Class/ParticleEmitter/LightInfluence"|Controls how much emitted particles are influenced by the lighting engine.|/RMD|
boolLockedToPart

Determines whether the particles rigidly move with the part they're being emitted from.

|RMD member="API:Class/ParticleEmitter/LockedToPart"|Determines whether the particles rigidly move with the part they're being emitted from.|/RMD|
floatRate

The rate at which particles are emitted per second.

|RMD member="API:Class/ParticleEmitter/Rate"|The rate at which particles are emitted per second.|/RMD|
NumberRangeRotSpeed

Determines the maximum and minimum rate of rotation for each particle created by the emitter. Measured in degrees per second.

|RMD member="API:Class/ParticleEmitter/RotSpeed"|Determines the maximum and minimum rate of rotation for each particle created by the emitter. Measured in degrees per second.|/RMD|
NumberRangeRotation

Determines the maximum and minimum rotation applied to a particle when it is created. Measured in degrees.

|RMD member="API:Class/ParticleEmitter/Rotation"|Determines the maximum and minimum rotation applied to a particle when it is created. Measured in degrees.|/RMD|
NumberSequenceSize

Determines the size of particles over time.

|RMD member="API:Class/ParticleEmitter/Size"|Determines the size of particles over time.|/RMD|
NumberRangeSpeed

Determines the maximum and minimum speed a particle will have when it is emitted. Measured in studs per second.

|RMD member="API:Class/ParticleEmitter/Speed"|Determines the maximum and minimum speed a particle will have when it is emitted. Measured in studs per second.|/RMD|
Vector2SpreadAngle

Determines how offset a particle can be fired from the local emitter direction of its parent, both horizontally and vertically. Measured in degrees.

|RMD member="API:Class/ParticleEmitter/SpreadAngle"|Determines how offset a particle can be fired from the local emitter direction of its parent, both horizontally and vertically. Measured in degrees.|/RMD|
ContentTexture

The texture used for the particle.

|RMD member="API:Class/ParticleEmitter/Texture"|The texture used for the particle.|/RMD|
NumberSequenceTransparency

Determines the transparency of the particle over time.

|RMD member="API:Class/ParticleEmitter/Transparency"|Determines the transparency of the particle over time.|/RMD|
floatVelocityInheritance

A number between 0 and 1 determining how the particles move relative to the emitter's parent part.

|RMD member="API:Class/ParticleEmitter/VelocityInheritance"|A number between 0 and 1 determining how the particles move relative to the emitter's parent part.|/RMD|
floatZOffset

Determines the screen offset particles in the emitter have. Used to control which particles are drawn on top.

|RMD member="API:Class/ParticleEmitter/ZOffset"|Determines the screen offset particles in the emitter have. Used to control which particles are drawn on top.|/RMD|
floatVelocitySpread [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/ParticleEmitter/VelocitySpread"|Deprecated. Do not use.|/RMD|
Applies constant acceleration in world coordinates to all particles created by the emitter.
Determines the color of the particle when it first spawns, and the color of the particle at the end of its lifetime.
Sets the rate per second in which each particle will lose half of its speed by exponential decay.
The face of the part where the particles emit from.
Toggles whether or not the ParticleEmitter is emitting particles.
Defines the maximum and minimum lifetime of a particle created by the emitter. Maximum is capped at 20 seconds.
Sets how much the colors of the emitter's particles are blended with the colors behind them.
Controls how much emitted particles are influenced by the lighting engine.
Determines whether the particles rigidly move with the part they're being emitted from.
The rate at which particles are emitted per second.
Determines the maximum and minimum rate of rotation for each particle created by the emitter. Measured in degrees per second.
Determines the maximum and minimum rotation applied to a particle when it is created. Measured in degrees.
Determines the size of particles over time.
Determines the maximum and minimum speed a particle will have when it is emitted. Measured in studs per second.
Determines how offset a particle can be fired from the local emitter direction of its parent, both horizontally and vertically. Measured in degrees.
The texture used for the particle.
Determines the transparency of the particle over time.
A number between 0 and 1 determining how the particles move relative to the emitter's parent part.
Determines the screen offset particles in the emitter have. Used to control which particles are drawn on top.
VelocitySpread [deprecated]
Deprecated. Do not use.
Inherited from Object Icon.pngInstance:
boolArchivable

Determines if an object can be Clone or saved to file.

|RMD member="API:Class/Instance/Archivable"|Determines if an object can be Clone or saved to file.|/RMD|
stringClassName [readonly]

The unique name of this type of Instance.

|RMD member="API:Class/Instance/ClassName"|The unique name of this type of Instance.|/RMD|
stringName

A non-unique identifier for the object.

|RMD member="API:Class/Instance/Name"|A non-unique identifier for the object.|/RMD|
Ref<Instance>Parent

The hierarchical parent of the object.

|RMD member="API:Class/Instance/Parent"|The hierarchical parent of the object.|/RMD|
intDataCost [LocalUserSecurity] [deprecated] [readonly]

Deprecated. Do not use.

|RMD member="API:Class/Instance/DataCost"|Deprecated. Do not use.|/RMD|
boolRobloxLocked [PluginSecurity]

If true, the object and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.

|RMD member="API:Class/Instance/RobloxLocked"|If true, the object and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.|/RMD|
boolarchivable [deprecated] [hidden]

Deprecated in favor of Archivable.

|RMD member="API:Class/Instance/archivable"|Deprecated in favor of Archivable.|/RMD|
stringclassName [deprecated] [readonly]

Deprecated in favor of ClassName.

|RMD member="API:Class/Instance/className"|Deprecated in favor of ClassName.|/RMD|
Determines if an object can be Clone or saved to file.
ClassName [readonly]
The unique name of this type of Instance.
A non-unique identifier for the object.
The hierarchical parent of the object.
DataCost [LocalUserSecurity] [deprecated] [readonly]
Deprecated. Do not use.
RobloxLocked [PluginSecurity]
If true, the object and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.
archivable [deprecated] [hidden]
Deprecated in favor of Archivable.
className [deprecated] [readonly]
Deprecated in favor of ClassName.

Functions

FunctionsmemberhiddenFunctions [toggle]

voidClear ( )

Clears any particles that are actively being emitted from the ParticleEmitter.

|RMD member="API:Class/ParticleEmitter/Clear"|Clears any particles that are actively being emitted from the ParticleEmitter.|/RMD|
voidEmit ( int particleCount = 16 )

Emits the given number of particles.

|RMD member="API:Class/ParticleEmitter/Emit"|Emits the given number of particles.|/RMD|
Clear ( )
Clears any particles that are actively being emitted from the ParticleEmitter.
Emit ( int particleCount = 16 )
Emits the given number of particles.
Inherited from Object Icon.pngInstance:
voidClearAllChildren ( )

Removes all descendants of the object.

|RMD member="API:Class/Instance/ClearAllChildren"|Removes all descendants of the object.|/RMD|
Ref<Instance>Clone ( )

Returns a copy of the object, including descendants, but only if the object is Archivable.

|RMD member="API:Class/Instance/Clone"|Returns a copy of the object, including descendants, but only if the object is Archivable.|/RMD|
voidDestroy ( )

Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.

|RMD member="API:Class/Instance/Destroy"|Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.|/RMD|
Ref<Instance>FindFirstAncestor ( string name )

Returns the first ancestor whose Name is equal to name, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestor"|Returns the first ancestor whose Name is equal to name, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstAncestorOfClass ( string className )

Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestorOfClass"|Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor that inherits the class className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestorWhichIsA"|Returns the first ancestor that inherits the class className, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstChild ( string name, bool recursive = false )

Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.

|RMD member="API:Class/Instance/FindFirstChild"|Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.|/RMD|
Ref<Instance>FindFirstChildOfClass ( string className )

Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.

|RMD member="API:Class/Instance/FindFirstChildOfClass"|Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.|/RMD|
Ref<Instance>FindFirstChildWhichIsA ( string className, bool recursive = false )

Returns the first child that inherits the class className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstChildWhichIsA"|Returns the first child that inherits the class className, or nil if none can be found.|/RMD|
array<Instance>GetChildren ( )

Returns an array of the object's children.

|RMD member="API:Class/Instance/GetChildren"|Returns an array of the object's children.|/RMD|
array<Instance>GetDescendants ( )

Returns an array containing all of the descendants of the instance.

|RMD member="API:Class/Instance/GetDescendants"|Returns an array containing all of the descendants of the instance.|/RMD|
stringGetFullName ( )

Returns a string which shows the object's ancestry chain.

|RMD member="API:Class/Instance/GetFullName"|Returns a string which shows the object's ancestry chain.|/RMD|
RBXScriptSignalGetPropertyChangedSignal ( string property )

Returns a signal that is fired when the specified property is changed on this object.

|RMD member="API:Class/Instance/GetPropertyChangedSignal"|Returns a signal that is fired when the specified property is changed on this object.|/RMD|
boolIsA ( string className )

Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.

|RMD member="API:Class/Instance/IsA"|Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.|/RMD|
boolIsAncestorOf ( Instance descendant )

Returns true if the object is an ancestor of the given descendant.

|RMD member="API:Class/Instance/IsAncestorOf"|Returns true if the object is an ancestor of the given descendant.|/RMD|
boolIsDescendantOf ( Instance ancestor )

Returns true if the object is a descendant of the given ancestor.

|RMD member="API:Class/Instance/IsDescendantOf"|Returns true if the object is a descendant of the given ancestor.|/RMD|
Ref<Instance>WaitForChild ( string childName, double timeOut )

Yields the current thread until a child with the given name is found, then returns the child. If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.

|RMD member="API:Class/Instance/WaitForChild"|Yields the current thread until a child with the given name is found, then returns the child.

If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.|/RMD|

stringGetDebugId ( int scopeLength = 4 ) [PluginSecurity] [notbrowsable]

Returns a coded string of the object's DebugId used internally by Roblox.

|RMD member="API:Class/Instance/GetDebugId"|Returns a coded string of the object's DebugId used internally by Roblox.|/RMD|
voidRemove ( ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Instance/Remove"|Deprecated. Do not use.|/RMD|
array<Instance>children ( ) [deprecated]

Deprecated in favor of GetChildren.

|RMD member="API:Class/Instance/children"|Deprecated in favor of GetChildren.|/RMD|
Instanceclone ( ) [deprecated]

Deprecated in favor of Clone.

|RMD member="API:Class/Instance/clone"|Deprecated in favor of Clone.|/RMD|
voiddestroy ( ) [deprecated]

Deprecated in favor of Destroy.

|RMD member="API:Class/Instance/destroy"|Deprecated in favor of Destroy.|/RMD|
InstancefindFirstChild ( string name, bool recursive = false ) [deprecated]

Deprecated in favor of FindFirstChild.

|RMD member="API:Class/Instance/findFirstChild"|Deprecated in favor of FindFirstChild.|/RMD|
array<Instance>getChildren ( ) [deprecated]

Deprecated in favor of GetChildren.

|RMD member="API:Class/Instance/getChildren"|Deprecated in favor of GetChildren.|/RMD|
boolisA ( string className ) [deprecated]

Deprecated in favor of IsA.

|RMD member="API:Class/Instance/isA"|Deprecated in favor of IsA.|/RMD|
boolisDescendantOf ( Instance ancestor ) [deprecated]

Deprecated in favor of IsDescendantOf.

|RMD member="API:Class/Instance/isDescendantOf"|Deprecated in favor of IsDescendantOf.|/RMD|
voidremove ( ) [deprecated]

Deprecated in favor of Remove.

|RMD member="API:Class/Instance/remove"|Deprecated in favor of Remove.|/RMD|
Removes all descendants of the object.
Clone ( )
Returns a copy of the object, including descendants, but only if the object is Archivable.
Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.
Returns the first ancestor whose Name is equal to name, or nil if none can be found.
Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.
Returns the first ancestor that inherits the class className, or nil if none can be found.
FindFirstChild ( string name, bool recursive = false )
Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.
Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.
FindFirstChildWhichIsA ( string className, bool recursive = false )
Returns the first child that inherits the class className, or nil if none can be found.
Returns an array of the object's children.
Returns an array containing all of the descendants of the instance.
Returns a string which shows the object's ancestry chain.
Returns a signal that is fired when the specified property is changed on this object.
IsA ( string className )
Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.
IsAncestorOf ( Instance descendant )
Returns true if the object is an ancestor of the given descendant.
Returns true if the object is a descendant of the given ancestor.
WaitForChild ( string childName, double timeOut )
Yields the current thread until a child with the given name is found, then returns the child. If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.
GetDebugId ( int scopeLength = 4 ) [PluginSecurity] [notbrowsable]
Returns a coded string of the object's DebugId used internally by Roblox.
Remove ( ) [deprecated]
Deprecated. Do not use.
children ( ) [deprecated]
Deprecated in favor of GetChildren.
clone ( ) [deprecated]
Deprecated in favor of Clone.
destroy ( ) [deprecated]
Deprecated in favor of Destroy.
findFirstChild ( string name, bool recursive = false ) [deprecated]
Deprecated in favor of FindFirstChild.
getChildren ( ) [deprecated]
Deprecated in favor of GetChildren.
isA ( string className ) [deprecated]
Deprecated in favor of IsA.
isDescendantOf ( Instance ancestor ) [deprecated]
Deprecated in favor of IsDescendantOf.
remove ( ) [deprecated]
Deprecated in favor of Remove.


Events

EventsmemberhiddenEvents [toggle]

Inherited from Object Icon.pngInstance:
AncestryChanged ( Instance child, Instance parent )

Fires when the Parent property of the object or one of its ancestors is changed.

|RMD member="API:Class/Instance/AncestryChanged"|Fires when the Parent property of the object or one of its ancestors is changed.|/RMD|
Changed ( string property )

Fires after a property of the object changes.

|RMD member="API:Class/Instance/Changed"|Fires after a property of the object changes.|/RMD|
ChildAdded ( Instance child )

Fires when a child is added to the object.

|RMD member="API:Class/Instance/ChildAdded"|Fires when a child is added to the object.|/RMD|
ChildRemoved ( Instance child )

Fires when a child is removed from the object.

|RMD member="API:Class/Instance/ChildRemoved"|Fires when a child is removed from the object.|/RMD|
DescendantAdded ( Instance descendant )

Fires when a descendant is added to the object.

|RMD member="API:Class/Instance/DescendantAdded"|Fires when a descendant is added to the object.|/RMD|
DescendantRemoving ( Instance descendant )

Fires before a descendant of the object is removed.

|RMD member="API:Class/Instance/DescendantRemoving"|Fires before a descendant of the object is removed.|/RMD|
childAdded ( Instance child ) [deprecated]

Deprecated in favor of ChildAdded.

|RMD member="API:Class/Instance/childAdded"|Deprecated in favor of ChildAdded.|/RMD|
Fires when the Parent property of the object or one of its ancestors is changed.
Changed ( string property )
Fires after a property of the object changes.
Fires when a child is added to the object.
Fires when a child is removed from the object.
DescendantAdded ( Instance descendant )
Fires when a descendant is added to the object.
Fires before a descendant of the object is removed.
childAdded ( Instance child ) [deprecated]
Deprecated in favor of ChildAdded.

|RMD member="API:Class/ParticleEmitter"|The ParticleEmitter creates a stream of particles emanating from the emitter's parent. These particles are customizable in terms of Texture, Size, Color, Transparency, and Speed. Particle emitters must be parented to either an Attachment or BasePart to be rendered in the world.
Particle emitters spawn particles at a constant rate anywhere within the parent volume. This volume is 0 if parented to an attachment (this means that all the particles will be emitted from the WorldPosition of the attachment).
By default the particles move in the positive y-direction in the local space of its parent. |/RMD|