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

Env steam: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Spam revert)
 
(45 intermediate revisions by 26 users not shown)
Line 1: Line 1:
{{wrongtitle|title=env_steam}}
{{LanguageBar}}
==Entity Description==
{{CD2|CSteamJet|file1=steamjet.cpp}}
An entity used to create a jet of steam.
{{this is a|point entity|name=env_steam}} It is used to create a jet of steam, or heat wave distortion.
==Keyvalues==
 
* {{kv targetname}}
[[File:Env_steam.jpg|thumb|right|250px|Keyvalue '''type''' set to ''normal'' on the left and ''heat wave'' on the right side.]]
* {{kv parentname}}
 
* {{kv angles}}
The entity appears as a cone in Hammer, the shape indicates the direction the emitter outputs the particles (away from the point).
* '''InitialState'''
 
: {{boolean}}
{{bug|In {{as|4}}, color is ''always'' white when the map is compiled with [[VRAD]].|hidetested=1|only=as}}
* '''type'''
 
: {{boolean}} If set, normal, otherwise heat wave
{{altnames|name1=env_steamjet|misc={{note|However, env_steamjet faces left instead of forward.}} }}
* '''SpreadSpeed'''
: <integer> The amount of random spread in the particle's velocity after they spawn.
* '''Speed'''
: <integer> The default speed at which the particles move after they spawn.
* '''StartSize'''
: <integer> The initial size of the particles after they spawn.
* '''EndSize'''
: <integer> The size of the particles at the point at which they are removed.
* '''Rate'''
: <integer> The rate of particle emission. i.e. particles per second.
* '''rendercolor'''
: {{color}} Only used if Emissive flag is set.
* '''JetLength'''
: <integer> The length of the jet determines the lifetime of each particle.
* '''renderamt'''
: <[[byte]]> Translucency
* '''{{ep1 add|rollspeed}}'''
: <float> How fast does the particles spin


==Flags==
==Flags==
* 1 : Emissive - Use the value specified in the ''rendercolor'' keyvalue. (If not checked, it will instead get the ''rendercolor'' from the environment.)
{{Fl|1|Emissive|Uses the value specified in <code>rendercolor</code>. If not checked, color is automatically determined by environmental lighting.}}
 
==Keyvalues==
{{KV Targetname}}
{{KV|Initial State|intn=InitialState|choices|Start enabled?
:*0: Off
:*1: On}}
{{KV|Particle Type|intn=Type|choices|Steam effect type, see image on the top right.
:*0: Normal
:*1: Heat Wave}}
{{KV|Spread Speed|intn=SpreadSpeed|integer|The amount of random spread in the particle's velocity after they spawn.}}
{{KV|Speed|intn=Speed|integer|The default speed at which the particles move after they spawn.}}
{{KV|Particle start size|intn=StartSize|integer|The initial size of the particles after they spawn.}}
{{KV|Particle end size|intn=EndSize|integer|The size of the particles at the point at which they are removed.}}
{{KV|Emission rate|intn=Rate|integer|The rate of particle emission. i.e. particles per second.}}
{{KV|Length of steam jet|intn=JetLength|integer|The length of the jet determines the lifetime of each particle.}}
{{KV|How fast does the particles spin|intn=RollSpeed|float|Particle roll speed.}}
{{KV|Color (R G B)|intn=rendercolor|color255|Steam color, only used if ''Emissive'' flag is set.}}
{{KV|Translucency|intn=renderamt|byte|Render alpha value.}}
{{KV|Start Sound|intn=StartNoise|sound|only=l4ds|Sound to play when starting emission.}}


==Inputs==
==Inputs==
* {{i targetname}}
{{I|TurnOn|Turns the steam jet on.}}
* {{i parentname}}
{{I|TurnOff|Turns the steam jet off.}}
* '''TurnOn'''
{{I|Toggle|Toggles the steam jet between on and off.}}
: Turns the steam jet on.
{{I|JetLength|param=integer|Sets '''Length of steam jet'''.}}
* '''TurnOff'''
{{I|Rate|param=integer|Sets '''Emission rate'''.}}
: Turns the steam jet off.
{{I|Speed|param=integer|Sets '''Speed'''.}}
* '''Toggle'''
{{I|SpreadSpeed|param=integer|Sets '''Spread Speed'''.}}
: Toggles the steam jet between on and off.
{{I|Alpha|nofgd=1|Sets '''Translucency'''.}}
* '''JetLength <integer>'''
{{I|Color|nofgd=1|Sets '''Color'''.}}
: Sets the JetLength
{{I|[[Use]]|nofgd=1|deprecated=1|{{confirm|Doesn't work properly due to expecting a USE_TYPE of on or off?}}}}
* '''Rate <integer>'''
 
: Sets the Rate
== See Also ==
* '''Speed <integer>'''
* {{ent|env_steamjet}}
: Sets the Speed
* '''SpreadSpeed <integer>
==Outputs==
* {{o targetname}}
[[Category:Entities]]

Latest revision as of 10:22, 30 October 2025

English (en)Translate (Translate)
C++ class hierarchy
CSteamJet defined in C++ steamjet.cpp
↳CBaseParticleEntity
↳CBaseEntity

env_steam is a point entity available in all Source Source games. It is used to create a jet of steam, or heat wave distortion.

Keyvalue type set to normal on the left and heat wave on the right side.

The entity appears as a cone in Hammer, the shape indicates the direction the emitter outputs the particles (away from the point).

Icon-Bug.pngBug:In Alien Swarm Alien Swarm, color is always white when the map is compiled with VRAD.
AltNames.pngAltNames: This entity is also tied to env_steamjet.
Note.pngNote:However, env_steamjet faces left instead of forward.

Flags

Emissive : [1]
Uses the value specified in rendercolor. If not checked, color is automatically determined by environmental lighting.

Keyvalues

Name (targetname) <string>[ Edit ]
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

Initial State (InitialState) <choices>
Start enabled?
  • 0: Off
  • 1: On
Particle Type (Type) <choices>
Steam effect type, see image on the top right.
  • 0: Normal
  • 1: Heat Wave
Spread Speed (SpreadSpeed) <integer>
The amount of random spread in the particle's velocity after they spawn.
Speed (Speed) <integer>
The default speed at which the particles move after they spawn.
Particle start size (StartSize) <integer>
The initial size of the particles after they spawn.
Particle end size (EndSize) <integer>
The size of the particles at the point at which they are removed.
Emission rate (Rate) <integer>
The rate of particle emission. i.e. particles per second.
Length of steam jet (JetLength) <integer>
The length of the jet determines the lifetime of each particle.
How fast does the particles spin (RollSpeed) <float>
Particle roll speed.
Color (R G B) (rendercolor) <color255>
Steam color, only used if Emissive flag is set.
Translucency (renderamt) <byte>
Render alpha value.
Start Sound (StartNoise) <sound> (only in Left 4 Dead seriesLeft 4 Dead series)
Sound to play when starting emission.

Inputs

TurnOn
Turns the steam jet on.
TurnOff
Turns the steam jet off.
Toggle
Toggles the steam jet between on and off.
JetLength <integerRedirectInput/integer>
Sets Length of steam jet.
Rate <integerRedirectInput/integer>
Sets Emission rate.
Speed <integerRedirectInput/integer>
Sets Speed.
SpreadSpeed <integerRedirectInput/integer>
Sets Spread Speed.
Alpha  !FGD
Sets Translucency.
Color  !FGD
Sets Color.
Use  !FGD Obsolete
Deprecated.
Confirm:Doesn't work properly due to expecting a USE_TYPE of on or off?

See Also

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Env_steam&oldid=491620"