ParticleEmitter

Missing API Documentation

This API Class does not have any or complete API documentation. Please add API documentation if possible.

ParticleEmitter
Icon
Legacy IconsThese icon(s) are only a part of legacy Roblox Studio versions, or are unused as of the studio icons update.
Category	Effects
Added in	189 (March 2015)
Memory category	Instances
Inheritance
Object Instance ParticleEmitter

A generic particle system. This class was added on March 20, 2015, in version 189 (March 2015).

Properties

Acceleration: Vector3

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/Acceleration.

• Category: Motion.
• Serialization: can save and load.
• Thread safety: read safe

Brightness: float

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/Brightness.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

Color: ColorSequence

Determines the color of the emitted particles. This property is a ColorSequence, which allows for multiple colors present throughout the duration of the particle's animation.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

Drag: float

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/Drag.

• Category: Particles.
• Serialization: can save and load.
• Thread safety: read safe

EmissionDirection: NormalId

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/EmissionDirection.

• Category: Emission.
• Serialization: can save and load.
• Thread safety: read safe

Enabled: bool

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/Enabled.

• Category: Emission.
• Serialization: can save and load.
• Thread safety: read safe

FlipbookFramerate: NumberRange

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/FlipbookFramerate.

• Category: Flipbook.
• Serialization: can save and load.
• Thread safety: read safe

FlipbookIncompatible: string

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/FlipbookIncompatible.

• Category: Flipbook.
• Serialization: can save and load.
• Thread safety: read safe

FlipbookLayout: ParticleFlipbookLayout

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/FlipbookLayout.

• Category: Flipbook.
• Serialization: can save and load.
• Thread safety: read safe

FlipbookMode: ParticleFlipbookMode

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/FlipbookMode.

• Category: Flipbook.
• Serialization: can save and load.
• Thread safety: read safe

FlipbookSizeX: int

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/FlipbookSizeX.

• Category: Flipbook.
• Serialization: can save and load.
• Thread safety: read safe

FlipbookSizeY: int

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/FlipbookSizeY.

• Category: Flipbook.
• Serialization: can save and load.
• Thread safety: read safe

FlipbookStartRandom: bool

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/FlipbookStartRandom.

• Category: Flipbook.
• Serialization: can save and load.
• Thread safety: read safe

Lifetime: NumberRange

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/Lifetime.

• Category: Emission.
• Serialization: can save and load.
• Thread safety: read safe

LightEmission: float

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/LightEmission.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

LightInfluence: float

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/LightInfluence.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

LocalTransparencyModifier: float

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/LocalTransparencyModifier.

• Category: Appearance.
• Serialization: cannot load or save.
• Thread safety: read safe

LockedToPart: bool

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/LockedToPart.

• Category: Particles.
• Serialization: can save and load.
• Thread safety: read safe

Orientation: ParticleOrientation

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/Orientation.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

Rate: float

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/Rate.

• Category: Emission.
• Serialization: can save and load.
• Thread safety: read safe

RotSpeed: NumberRange

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/RotSpeed.

• Category: Emission.
• Serialization: can save and load.
• Thread safety: read safe

Rotation: NumberRange

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/Rotation.

• Category: Emission.
• Serialization: can save and load.
• Thread safety: read safe

Shape: ParticleEmitterShape

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/Shape.

• Category: EmitterShape.
• Serialization: can save and load.
• Thread safety: read safe

ShapeInOut: ParticleEmitterShapeInOut

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/ShapeInOut.

• Category: EmitterShape.
• Serialization: can save and load.
• Thread safety: read safe

ShapePartial: float

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/ShapePartial.

• Category: EmitterShape.
• Serialization: can save and load.
• Thread safety: read safe

ShapeStyle: ParticleEmitterShapeStyle

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/ShapeStyle.

• Category: EmitterShape.
• Serialization: can save and load.
• Thread safety: read safe

Size: NumberSequence

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/Size.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

Speed: NumberRange

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/Speed.

• Category: Emission.
• Serialization: can save and load.
• Thread safety: read safe

SpreadAngle: Vector2

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/SpreadAngle.

• Category: Emission.
• Serialization: can save and load.
• Thread safety: read safe

Squash: NumberSequence

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/Squash.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

Texture: ContentId

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/Texture.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

TimeScale: float

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/TimeScale.

• Category: Particles.
• Serialization: can save and load.
• Thread safety: read safe

Transparency: NumberSequence

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/Transparency.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

VelocityInheritance: float

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/VelocityInheritance.

• Category: Particles.
• Serialization: can save and load.
• Thread safety: read safe

VelocitySpread: float

• Not replicatedThis member is not replicated across the network boundary.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/VelocitySpread.

• Category: Emission.
• Serialization: can load only.
• Thread safety: read safe

WindAffectsDrag: bool

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/WindAffectsDrag.

• Category: Particles.
• Serialization: can save and load.
• Thread safety: read safe

ZOffset: float

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/ZOffset.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

Methods

Clear(): null

This class member is missing documentation. Create or add to its subpage at Class:ParticleEmitter/Clear.

• Thread safety: unsafe

Emit(particleCount: int = 16): null

Parameters

Name	Type	Default
particleCount	int	16

• Thread safety: unsafe

FastForward(numFrames: int): null

Parameters

Name	Type
numFrames	int

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

External links

• ParticleEmitter in the Roblox Creator Documentation
• ParticleEmitter in the Roblox API Reference