Env smokestack: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Replaced In code template with Code class template.)
(updates)
Line 1: Line 1:
{{base_point|env_smokestack}} It spits out a constant stream of smoke. You can place up to two [[Env_particlelight|env_particlelight]] entities near the smoke stack to add ambient light to its particles.
{{lang|Env smokestack}}
[[File:Env smokestack.png|thumb|right|300px|<code>env_smokestack</code> using the FGD defaults.]]
{{base_point|env_smokestack}} It spits out a constant stream of smoke. You can place up to two {{ent|env_particlelight}}s near the smoke stack to add ambient light to its particles.


[[Image:SmokeStack.jpg|thumb|right|300px|Env_smokestack with Bubble Effect]]
{{code class|CSmokeStack|smokestack.cpp}}
==Availability==
{{in game|point}} {{game-base}}


{{Code class|CSmokeStack|[https://github.com/ValveSoftware/source-sdk-2013/blob/master/sp/src/game/server/smokestack.cpp smokestack.cpp]}}
==Keyvalues==
{{KV|Initial State (InitialState)|choices|Initial state of the entity.
:*0: Off
:*1: On}}
{{KV|Spread at the base (BaseSpread)|integer|Amount of random spread in the origins of the smoke particles when they're spawned.}}
{{KV|Spread Speed (SpreadSpeed)|integer|Amount of random spread in the velocity of the smoke particles after they're spawned.}}
{{KV|Speed (Speed)|integer|The speed at which the smoke particles move after they're spawned.}}
{{KV|Particle start size (StartSize)|integer|Size of the smoke particles when they're first emitted.}}
{{KV|Particle end size (EndSize)|integer|Size of the smoke particles at the point they fade out completely.}}
{{KV|Emission rate (Rate)|integer|Rate at which to emit smoke particles (i.e. particles to emit per second).}}
{{KV|Length of smoke trail (JetLength)|integer|Length of the smokestack. Lifetime of the smoke particles is derived from this & particle speed.}}
{{KV|Wind X/Y Angle (WindAngle)|angle|This specifies the wind direction. It is an angle in the XY plane.}}
{{KV|Wind Speed (WindSpeed)|integer|The strength of the wind.}}
{{KV|Particle material (SmokeMaterial)|string|Material of the smoke particles emitted by this stack.}}
{{KV|Twist (Twist)|integer|The amount, in degrees per second, that the smoke particles twist around the origin.}}
{{KV|Roll Speed (Roll)|float|Amount of roll in degrees per second.}}
{{KV|Base Color (R G B) (rendercolor)|color255|The color of the particles.}}
{{KV|Translucency (renderamt)|integer|How much you can see through the particles.}}
{{KV|Wind Vector (Wind)|nofgd=1|vector|Wind direction, not limited to any axis.}}
{{KV BaseEntity|css=1}}


== Keyvalues ==
==Inputs==
{{KV|Name|target_source|The name that other entities refer to this entity by.}}
{{KV|Initial State|choices|Initial state of the entity.}}
:* 0 : Off
:* 1 : On
{{KV|Spread at the base|integer|Amount of random spread in the origins of the smoke particles when they're spawned.}}
{{KV|Spread Speed|integer|Amount of random spread in the velocity of the smoke particles after they're spawned.}}
{{KV|Speed|integer|The speed at which the smoke particles move after they're spawned.}}
{{KV|Particle start size|integer|Size of the smoke particles when they're first emitted.}}
{{KV|Particle end size|integer|Size of the smoke particles at the point they fade out completely.}}
{{KV|Emission rate|integer|Rate at which to emit smoke particles (i.e. particles to emit per second).}}
{{KV|Length of smoke trail|integer|Length of the smokestack. Lifetime of the smoke particles is derived from this & particle speed.}}
{{KV|Wind X/Y Angle|integer|This specifies the wind direction. It is an angle in the XY plane. Wind<code>Speed</code> specifies the strength of the wind.}}
{{KV|Wind Speed|integer|The strength of the wind.}}
{{KV|Particle material|string|Material of the smoke particles emitted by this stack.}}
{{KV|Twist|integer|The amount, in degrees per second, that the smoke particles twist around the origin.}}
{{KV|Roll Speed|float|Amount of roll in degrees per second.}}
{{KV|Base Color (R G B)|color255|The color of the particles.}}
{{KV|Translucency|integer|How much you can see through the particles.}}
{{KV Parentname}}
{{KV Angles}}
 
== Inputs ==
{{IO|TurnOn|Turn on the smokestack.}}
{{IO|TurnOn|Turn on the smokestack.}}
{{IO|TurnOff|Turn off the smokestack.}}
{{IO|TurnOff|Turn off the smokestack.}}
{{IO|Toggle|Toggles the smokestack between on and off state.}}
{{IO|Toggle|Toggles the smokestack between on and off state.}}
{{IO|JetLength|Set the length of the smoke trail.|param=integer}}
{{IO|JetLength|param=integer|Sets '''Length of smoke trail'''.}}
{{IO|Rate|Set the rate at which to emit smoke particles (particles per second).|param=integer}}
{{IO|Rate|param=integer|Sets '''Emission rate'''.}}
{{IO|Speed|Set the speed at which the smoke particles move after they're spawned.|param=integer}}
{{IO|Speed|param=integer|Sets '''Speed'''.}}
{{IO|SpreadSpeed|Set the amount of random spread in the velocity of the smoke particles after they're spawned.|param=integer}}
{{IO|SpreadSpeed|param=integer|Sets '''Spread Speed'''.}}
{{I Parentname}}
{{IO|Color|nofgd=1|param=color255|Sets '''Base Color'''.}}
{{IO|Alpha|nofgd=1|param=int|Sets '''Translucency'''.}}
{{I BaseEntity}}
 
==Outputs==
{{O BaseEntity|l4d=1}}

Revision as of 23:48, 30 September 2018

English (en)Translate (Translate)
env_smokestack using the FGD defaults.

Template:Base point It spits out a constant stream of smoke. You can place up to two env_particlelights near the smoke stack to add ambient light to its particles.

C++ In code, it is represented by theCSmokeStackclass, defined in thesmokestack.cppfile.

Keyvalues

Initial State (InitialState) ([todo internal name (i)]) <choices>
Initial state of the entity.
  • 0: Off
  • 1: On
Spread at the base (BaseSpread) ([todo internal name (i)]) <integer>
Amount of random spread in the origins of the smoke particles when they're spawned.
Spread Speed (SpreadSpeed) ([todo internal name (i)]) <integer>
Amount of random spread in the velocity of the smoke particles after they're spawned.
Speed (Speed) ([todo internal name (i)]) <integer>
The speed at which the smoke particles move after they're spawned.
Particle start size (StartSize) ([todo internal name (i)]) <integer>
Size of the smoke particles when they're first emitted.
Particle end size (EndSize) ([todo internal name (i)]) <integer>
Size of the smoke particles at the point they fade out completely.
Emission rate (Rate) ([todo internal name (i)]) <integer>
Rate at which to emit smoke particles (i.e. particles to emit per second).
Length of smoke trail (JetLength) ([todo internal name (i)]) <integer>
Length of the smokestack. Lifetime of the smoke particles is derived from this & particle speed.
Wind X/Y Angle (WindAngle) ([todo internal name (i)]) <angle>
This specifies the wind direction. It is an angle in the XY plane.
Wind Speed (WindSpeed) ([todo internal name (i)]) <integer>
The strength of the wind.
Particle material (SmokeMaterial) ([todo internal name (i)]) <string>
Material of the smoke particles emitted by this stack.
Twist (Twist) ([todo internal name (i)]) <integer>
The amount, in degrees per second, that the smoke particles twist around the origin.
Roll Speed (Roll) ([todo internal name (i)]) <float>
Amount of roll in degrees per second.
Base Color (R G B) (rendercolor) ([todo internal name (i)]) <color255>
The color of the particles.
Translucency (renderamt) ([todo internal name (i)]) <integer>
How much you can see through the particles.
Wind Vector (Wind) ([todo internal name (i)]) <vector> !FGD
Wind direction, not limited to any axis.


Inputs

TurnOn
Turn on the smokestack.
TurnOff
Turn off the smokestack.
Toggle
Toggles the smokestack between on and off state.
JetLength <integerRedirectInput/integer>
Sets Length of smoke trail.
Rate <integerRedirectInput/integer>
Sets Emission rate.
Speed <integerRedirectInput/integer>
Sets Speed.
SpreadSpeed <integerRedirectInput/integer>
Sets Spread Speed.
Color <color255RedirectInput/color32> !FGD
Sets Base Color.
Alpha <integerRedirectInput/integer> !FGD
Sets Translucency.


Outputs

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