This article's documentation is for anything that uses the Source engine. Click here for more information.

env_fire

From Valve Developer Community
Jump to: navigation, search
English (en)中文 (zh)Translate (Translate)
Example of env_fire.
Env fire.png

env_fire is a point entity available in all Source Source games. It handles a single flame (_firesmoke) at its origin. The flame causes heat "damage" to other env_fire entities around it and will eventually ignite them, causing the fire to spread. env_firesource will add heat damage to nearby env_fire entities and ignite them/maintain ignition.

Note.pngNote:The fire may fall through the world on spawn if placed exactly at ground level. Place it a little bit above the ground to fix this.
Icon-Bug.pngBug*:This entity doesn't work in Portal Portal. Please see Portal:Env Fire fix for more details
Icon-Bug.pngBug*:While still available, it does not have particle effects in Team Fortress 2 Team Fortress 2. This method is recommended instead.
Class hierarchy
CFire
CBaseEntity
fire.cpp

Keyvalues

Name (targetname) <string>
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Duration (health) <integer>
Amount of time the fire will burn.
Size (firesize) <integer>
Height (in world units) of the flame.
Attack (fireattack) <integer>
Amount of time the fire takes to grow to full strength.
Type (firetype) <choices>
Either Natural or Plasma. Natural is a general all purpose flame, like a wood fire.
  • 0: Natural
  • 1: Plasma
    Warning.pngWarning:Effects for this type do not exist!
Ignition Point (ignitionpoint) <float>
Amount of heat 'damage' to take before this flame should ignite.
Damage Scale (damagescale) <float>
Multiplier of the burn damage done by the flame.
Light Color (LightColor) <color255> (in all games since Alien Swarm)
Color of dynamic light for this fire.
Light Radius Scale (LightRadiusScale) <float> (in all games since Alien Swarm)
Multiplier for the glow radius.
Light Brightness (LightBrightness) <integer> (in all games since Alien Swarm)
Integer exponent for the glow brightness.
Loop sound (LoopSound) <sound> (in all games since Alien Swarm)
Looping sound to play while this fire is burning.
Ignite sound (IgniteSound) <sound> (in all games since Alien Swarm)
One shot sound to play when the fire starts.
Start Disabled (StartDisabled) <boolean>
Stay dormant until activated.
Note.pngNote:Unless you also checked the "Start On" flag, env_fire will not automatically ignite even if you set this keyvalue to No. Likewise, env_fire will still ignite if you have the "Start On" flag checked, even if this key value is set to Yes.

Flags

Infinite Duration : [1]

Note.pngNote:In Alien Swarm, an env_fire cannot be extinguished with the fire extinguisher unless Infinite Duration is set.

Smokeless : [2]
Start On : [4]

Start Full : [8]

How?: as in, start out ready to ignite as soon as it's damaged?

Don't drop : [16]
No glow : [32]
Delete when out : [128]
Visible from above : [256] (removed since Alien Swarm)
No sound : [256] (in all games since Alien Swarm)
No ignite sound : [512] (in all games since Alien Swarm)
No fueling once lit : [1024] (in all games since Alien Swarm)
Fast burn think : [2048] (in all games since Alien Swarm)

Inputs

StartFire
Start the fire.
Extinguish <float>
Puts out the fire permanently in the number of seconds specified.
ExtinguishTemporary <float>
Puts out the fire temporarily in the number of seconds specified.

EnableDisable:

Enable / Disable
Enable/disable this entity from performing its task. It might also disappear from view.

Outputs

OnIgnited
Fires when the fire is first ignited.
OnExtinguished
Fires when the fire is fully extinguished.

ConVars/Commands

Cvar/CommandParameters or default valueDescriptorEffect
fire_maxabsorb50Arbitrary number (float)Upper limit for how much heat "damage" a fire can take before the damage begins to force the flame to grow. Heat is usually absorbed from other env_fires.
fire_absorbrate3Multiplier (float)Scalar for how fast fires can absorb heat.
fire_extscale12Multiplier (float)Effectively only a scalar for the Strength of an env_extinguisherjet.
fire_extabsorb5Multiplier (float)
Todo: Effect description.
fire_heatscale1.0Multiplier (float)Scalar for how much damage a fire can do (both to fires and other objects such as the player).
fire_incomingheatscale0.1Multiplier (float)Scalar for how much heat a fire can take from other fires if it is already ignited.
fire_dmgscale0.1Multiplier (float)
Todo: Effect description.
fire_dmgbase1Health AmountBase damage that a fire does to objects such as the player. This amount multiplies depending on the user's difficulty setting:
  • Easy: x1
  • Normal: x2
  • Hard: x3
fire_growthrate1.0Multiplier (float)Scalar for how much heat a fire can passively add to itself at once. Thinking interval is 0.1 seconds.
fire_dmginterval1.0SecondsOnce a fire has damaged something, it will wait this long before it can damage anything again.