ParticleEmitter
Emits and simulates textured particles.
- Creatable
Instance.new("ParticleEmitter")- Inherits
- Instance
- Replication
- Standard
Behavior
ParticleEmitter emits and simulates textured particles.
Summary
The acceleration applied to particles, in studs per second squared.
The restitution used when particles bounce from geometry.
The brightness multiplier applied to the rendered particles or strip.
The reduction in tangential particle velocity at collision.
Whether colliding particles bounce, die, stick, or ignore geometry.
The color applied when rendering this instance.
The color distribution along the effect.
The rate at which particle velocity is reduced.
The direction in which particles are initially emitted.
Whether particles spawn on the surface of the emission shape.
Whether the emitter continuously spawns particles at Rate.
The rate at which particle atlas frames advance.
The grid dimensions of the particle texture atlas.
The playback mode used to select atlas frames.
Whether each particle begins on a randomly selected atlas frame.
The duration for which a particle or trail segment remains visible, in seconds.
The self-illumination contribution of the effect.
The amount of scene lighting applied to the rendered effect.
Whether existing particles move with the emitter's parent.
The ParticleOperator used to update particle behavior.
The latest particle-operator error, or nil if no error is available.
The serialized parameter values supplied to the particle operator.
The particle billboard orientation relative to the camera or velocity.
The built-in particle settings preset applied to the emitter.
The number of particles emitted per second during continuous emission.
The seed used to generate the procedural pattern.
The SurfaceShader used to shade this material.
The particle size used for rendering.
The particle size distribution over normalized particle lifetime.
The initial emission speed of new particles, in studs per second.
The range from which initial particle speeds are sampled.
The secondary emitter triggered by particle events.
The number of secondary particles emitted for each triggering event.
SubEmitterTrigger: Enum.ParticleSubEmitterTrigger = Enum.ParticleSubEmitterTrigger.OnDeathparallel readThe particle event that triggers the secondary emitter.
The content identifier of the texture used by this instance.
The transparency distribution along the effect.
The fraction of the parent body's velocity added to new particles.
The spread applied to initial particle velocity.
The contribution of particles to volumetric emission.
Whether particles collide with world geometry.
The depth offset applied when rendering the effect.
Removes all live particles from this emitter.
Emits the specified number of particles immediately.
Returns this instance if it is an ExecutionGroup.
Returns the value of a particle operator parameter.
SetOperatorParameter(index: number, value: number | boolean | Vector2 | Vector3 | Color3 | { number }): ()serial onlySets a parameter used by a particle operator.
Callback invoked for a particle emission request.
Properties
Acceleration
ParticleEmitter.Acceleration: Vector3 = Vector3.new(0, 0, 0)The acceleration applied to particles, in studs per second squared.
Bounciness
ParticleEmitter.Bounciness: number = 0.4The restitution used when particles bounce from geometry.
Brightness
ParticleEmitter.Brightness: number = 1The brightness multiplier applied to the rendered particles or strip.
CollisionFriction
ParticleEmitter.CollisionFriction: number = 0.2The reduction in tangential particle velocity at collision.
CollisionMode
ParticleEmitter.CollisionMode: Enum.ParticleCollisionMode = Enum.ParticleCollisionMode.DisabledWhether colliding particles bounce, die, stick, or ignore geometry.
Color
ParticleEmitter.Color: Color3 = Color3.new(1, 1, 1)The color applied when rendering this instance.
ColorSequence
ParticleEmitter.ColorSequence: ColorSequenceThe color distribution along the effect.
Drag
ParticleEmitter.Drag: number = 0The rate at which particle velocity is reduced.
EmissionDirection
ParticleEmitter.EmissionDirection: Enum.NormalId = Enum.NormalId.TopThe direction in which particles are initially emitted.
EmitFromSurface
ParticleEmitter.EmitFromSurface: boolean = falseWhether particles spawn on the surface of the emission shape.
Enabled
ParticleEmitter.Enabled: boolean = trueWhether the emitter continuously spawns particles at Rate. Existing particles continue until their lifetime expires.
FlipbookFramerate
ParticleEmitter.FlipbookFramerate: NumberRange = NumberRange.new(1, 1)The rate at which particle atlas frames advance.
FlipbookLayout
ParticleEmitter.FlipbookLayout: Enum.ParticleFlipbookLayout = Enum.ParticleFlipbookLayout.NoneThe grid dimensions of the particle texture atlas.
FlipbookMode
ParticleEmitter.FlipbookMode: Enum.ParticleFlipbookMode = Enum.ParticleFlipbookMode.LoopThe playback mode used to select atlas frames.
FlipbookStartRandom
ParticleEmitter.FlipbookStartRandom: boolean = falseWhether each particle begins on a randomly selected atlas frame.
Lifetime
ParticleEmitter.Lifetime: number = 2The duration for which a particle or trail segment remains visible, in seconds.
LightEmission
ParticleEmitter.LightEmission: number = 0The self-illumination contribution of the effect.
LightInfluence
ParticleEmitter.LightInfluence: number = 1The amount of scene lighting applied to the rendered effect.
LockedToPart
ParticleEmitter.LockedToPart: boolean = falseWhether existing particles move with the emitter's parent.
Operator
ParticleEmitter.Operator: string = ""The ParticleOperator used to update particle behavior.
OperatorError
ParticleEmitter.OperatorError: string? = ""The latest particle-operator error, or nil if no error is available.
OperatorParameters
ParticleEmitter.OperatorParameters: string = "[]"The serialized parameter values supplied to the particle operator.
Orientation
ParticleEmitter.Orientation: Enum.ParticleOrientation = Enum.ParticleOrientation.FacingCameraThe particle billboard orientation relative to the camera or velocity.
Preset
ParticleEmitter.Preset: Enum.ParticleEmitterPreset = Enum.ParticleEmitterPreset.CustomThe built-in particle settings preset applied to the emitter.
Rate
ParticleEmitter.Rate: number = 20The number of particles emitted per second during continuous emission.
Seed
ParticleEmitter.Seed: number = 0The seed used to generate the procedural pattern.
Shader
ParticleEmitter.Shader: ParticleOperator? = nilThe SurfaceShader used to shade this material.
Size
ParticleEmitter.Size: number = 1The particle size used for rendering.
SizeSequence
ParticleEmitter.SizeSequence: NumberSequenceThe particle size distribution over normalized particle lifetime.
Speed
ParticleEmitter.Speed: number = 4The initial emission speed of new particles, in studs per second.
SpeedRange
ParticleEmitter.SpeedRange: NumberRangeThe range from which initial particle speeds are sampled.
SubEmitter
ParticleEmitter.SubEmitter: ParticleEmitter? = nilThe secondary emitter triggered by particle events.
SubEmitterCount
ParticleEmitter.SubEmitterCount: number = 4The number of secondary particles emitted for each triggering event.
SubEmitterTrigger
ParticleEmitter.SubEmitterTrigger: Enum.ParticleSubEmitterTrigger = Enum.ParticleSubEmitterTrigger.OnDeathThe particle event that triggers the secondary emitter.
Texture
ParticleEmitter.Texture: Content = "astasset://textures/particles/sparkles_main.dds"The content identifier of the texture used by this instance.
TransparencySequence
ParticleEmitter.TransparencySequence: NumberSequenceThe transparency distribution along the effect.
VelocityInheritance
ParticleEmitter.VelocityInheritance: number = 0The fraction of the parent body's velocity added to new particles.
VelocitySpread
ParticleEmitter.VelocitySpread: number = 0The spread applied to initial particle velocity.
VolumetricEmission
ParticleEmitter.VolumetricEmission: number = 0The contribution of particles to volumetric emission.
WorldCollision
ParticleEmitter.WorldCollision: boolean = falseWhether particles collide with world geometry.
ZOffset
ParticleEmitter.ZOffset: number = 0The depth offset applied when rendering the effect.
Methods
Clear
ParticleEmitter:Clear(): ()Removes all live particles from this emitter.
Emit
ParticleEmitter:Emit(particleCount: number?): ()Emits the specified number of particles immediately. This does not enable continuous emission.
GetExecutionGroup
ParticleEmitter:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
GetOperatorParameter
ParticleEmitter:GetOperatorParameter(index: number): (number, number, number, number)Returns the value of a particle operator parameter.
SetOperatorParameter
ParticleEmitter:SetOperatorParameter(index: number, value: number | boolean | Vector2 | Vector3 | Color3 | { number }): ()Sets a parameter used by a particle operator.
Events
OnEmitRequested
ParticleEmitter.OnEmitRequested: RBXScriptSignalCallback invoked for a particle emission request.
Inherited members
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying