Fire
A preconfigured particle emitter with the visual aesthetic of fire.
| Memory category | Instances |
|---|
Member index 11
Description
Fire is one of several preconfigured particle-emitting classes, alongside Smoke, Sparkles, and others. Like the others, it emits particles when parented to a BasePart or an Attachment while Enabled. This object is useful to create a quick visual effect for fire, but for more detailed work it's recommended that you use a ParticleEmitter instead.
Particles emit from the center of the parent in an upward (+Y) direction, but a negative Heat value may be used to emit particles downward (-Y). Using an Attachment as the parent instead of a BasePart allows for the emission position/direction to be modified by changing the Attachment.CFrame or related properties.
Fire objects consist of two emitters, each affected in various ways by the Size, Heat, Color, and SecondaryColor properties. Particles which emit from the smaller, secondary emitter have a significantly longer lifetime (and rise farther) than those emitted by the primary emitter.
When Enabled is off, existing particles continue to
render until they expire. However, if the Fire object's
Parent is set to nil, all existing particles
immediately disappear, similar to the behavior of
ParticleEmitter:Clear().
Fire objects emit no light on their own. To help create a cohesive environment around a burning object, try adding a PointLight with an orange Color.
History 33
- 626 Add
- 573 Change ReturnType of FastForward from void to null
- 553 Add
- 553 Change Default of size from to 5
- 553 Change PreferredDescriptor of size from to Size
- 553 Add
- 553 Change Default of TimeScale from to 1
- 553 Change Default of Size from to 5
- 553 Change Default of SecondaryColor from to Color3(0.545098, 0.313726, 0.215686)
- 553 Change Default of Heat from to 9
- 553 Change Default of Enabled from to true
- 553 Change Default of Color from to Color3(0.92549, 0.545098, 0.27451)
- 548 Add FastForward
- 508 Add TimeScale
- 486 Change ThreadSafety of size from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Size from ReadOnly to ReadSafe
- 486 Change ThreadSafety of SecondaryColor from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Heat from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Enabled from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Color from ReadOnly to ReadSafe
- 462 Change ThreadSafety of size from to ReadOnly
- 462 Change ThreadSafety of Size from to ReadOnly
- 462 Change ThreadSafety of SecondaryColor from to ReadOnly
- 462 Change ThreadSafety of Heat from to ReadOnly
- 462 Change ThreadSafety of Enabled from to ReadOnly
- 462 Change ThreadSafety of Color from to ReadOnly
- 61 Add size
- 47 Add Size
- 47 Add SecondaryColor
- 47 Add Heat
- 47 Add Enabled
- 47 Add Color
- 47 Add Fire
Members 11
Color
| Type | Default | |
|---|---|---|
| Color3 | 0.92549, 0.545098, 0.27451 | |
This property determines the color of the larger particles emitted by a Fire object. It is essentially the color of the outer portion of the flame.
In general, the cooler flames are on the outside of a fire. Therefore, fire looks more realistic if the outer portions are red or orange-yellow. A fire that is bright all throughout doesn't look very realistic, so avoid setting this property to yellow or white.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
Enabled
| Type | Default | |
|---|---|---|
| bool | true | |
This property, much like ParticleEmitter.Enabled, determines whether flame particles are emitted. Any particles already emitted will continue to render until their lifetime expires.
Since all fire particles are destroyed when the Fire object's
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 code example below).
local Debris = game:GetService("Debris")
local function douseFlames(fire)
fire.Enabled = false -- No more new particles
Debris:AddItem(fire, 2) -- Remove the object after existing particles have expired
end
douseFlames(part.Fire)
| 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
Heat
| Type | Default | |
|---|---|---|
| float | 9 | |
This property determines how fast particles are emitted from the
Fire object. It is limited to the range of -25 to 25
inclusive. Positive values are in the top (+Y) direction of the parent
BasePart or Attachment, while negative values are in the
downward (-Y) direction. It also affects the
ParticleEmitter.Acceleration of the inner particles.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true/false |
SecondaryColor
| Type | Default | |
|---|---|---|
| Color3 | 0.545098, 0.313726, 0.215686 | |
This property determines the color of the smaller particles emitted by a Fire object. It is essentially the color of the inner portion of the flame.
Note that the inner particles use a ParticleEmitter.LightEmission
of 1, so darker colors will instead cause the particles to appear
transparent, and black will stop rendering inner particles altogether.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 4
- 553 Change Default of SecondaryColor from to Color3(0.545098, 0.313726, 0.215686)
- 486 Change ThreadSafety of SecondaryColor from ReadOnly to ReadSafe
- 462 Change ThreadSafety of SecondaryColor from to ReadOnly
- 47 Add SecondaryColor
Size
| Type | Default | |
|---|---|---|
| float | 5 | |
This property determines the size of the flame particles. It must be in
the range of 2 to 30. Unlike ParticleEmitter.Size, the actual
size of the flames will not match 1:1 with the equivalent size in studs;
it is somewhat smaller.
If you add a PointLight as a sibling to the Fire object to generate light, try setting the light's Brightness and Range proportional to this property so that larger flames produce more light.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true/false |
TimeScale
| Type | Default | |
|---|---|---|
| float | 1 | |
A value between 0 and 1 than controls the speed of the particle
effect. 1 runs at normal speed, 0.5 runs at half speed, and 0
freezes time.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
size
| Type | Default | |
|---|---|---|
| float | 5 | |
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true/false |