Env steam: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
(updates)
Line 1: Line 1:
{{lang|Env steam}}
[[File:Env_steam.jpg|thumb|right|250px|Keyvalue '''type''' set to ''normal'' on the left and ''heat wave'' on the right side.]]
[[File:Env_steam.jpg|thumb|right|250px|Keyvalue '''type''' set to ''normal'' on the left and ''heat wave'' on the right side.]]
{{base point|env_steam}} It is used to create a jet of steam, or heat wave distortion.  
{{base point|env_steam}} It is used to create a jet of steam, or heat wave distortion.  


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


== Keyvalues ==
{{bug|{{as}} Color is ''always'' white when the map is compiled with [[VRAD]].}}
{{KV|Initial State|choices|Start enabled?}}
:* 0 : Off
:* 1 : On
{{KV|Particle Type|choices|Steam effect type, see image on the top right.}}
:* 0 : Normal
:* 1 : Heat Wave
{{KV|Spread Speed|integer|The amount of random spread in the particle's velocity after they spawn.}}
{{KV|Speed|integer|The default speed at which the particles move after they spawn.}}
{{KV|Particle start size|integer|The initial size of the particles after they spawn.}}
{{KV|Particle end size|integer|The size of the particles at the point at which they are removed.}}
{{KV|Emission rate|integer|The rate of particle emission. i.e. particles per second.}}
{{KV|Color (R G B)|color255|Steam color, only used if Emissive flag is set.}}
{{KV|Length of steam jet|integer|The length of the jet determines the lifetime of each particle.}}
{{KV|Translucency|integer|Render alpha value.|}}
{{KV|How fast does the particles spin|float|Particle roll speed.}}
{{KV Targetname}}
{{KV Parentname}}
{{KV Angles}}


== Flags ==
{{code class|CSteamJet|steamjet.cpp}}
* 1 : Emissive
: Use the value specified in the <code>rendercolor</code> keyvalue. (If not checked, it will instead get the <code>rendercolor</code> from the environment.)
{{bug|In ''Alien Swarm'' the env_steam entity will always render white steam if map is compiled with vrad.}}


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


== Outputs ==
==Outputs==
{{O Targetname}}
{{O BaseEntity|l4d=1}}

Revision as of 17:42, 2 October 2018

English (en)Translate (Translate)
Keyvalue type set to normal on the left and heat wave on the right side.

Template:Base point It is used to create a jet of steam, or heat wave distortion.

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:Alien Swarm Color is always white when the map is compiled with VRAD.  [todo tested in ?]
C++ In code, it is represented by theCSteamJetclass, defined in thesteamjet.cppfile.

Flags

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

Keyvalues

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


Outputs

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