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

Env smokestack: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
 
(8 intermediate revisions by 8 users not shown)
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.
{{LanguageBar}}
 
[[File:Env smokestack.png|thumb|right|300px|<code>env_smokestack</code> using the FGD defaults.]]
[[Image:SmokeStack.jpg|thumb|right|300px|Env_smokestack with Bubble Effect]]
{{CD|CSmokeStack|file1=smokestack.cpp}}
==Availability==
{{This is a|point entity|name=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.
{{in game|point}} {{game-base}}
{{in code|class=class_c_smoke_stack.html CSmokeStack|file=smokestack_8cpp-source.html smokestack.cpp}}


== Keyvalues ==
== Keyvalues ==
{{KV|Name|target_source|The name that other entities refer to this entity by.}}
{{KV Targetname}}
{{KV|Initial State|choices|Initial state of the entity.}}
{{KV|Initial State|intn=InitialState|choices|Initial state of the entity.
:* 0 : Off
:*0: Off
:* 1 : On
:*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 at the base|intn=BaseSpread|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|Spread Speed|intn=SpreadSpeed|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|Speed|intn=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 start size|intn=StartSize|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|Particle end size|intn=EndSize|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|Emission rate|intn=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|Length of smoke trail|intn=JetLength|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 X/Y Angle|intn=WindAngle|angle|This specifies the wind direction. It is an angle in the XY plane.}}
{{KV|Wind Speed|integer|The strength of the wind.}}
{{KV|Wind Speed|intn=WindSpeed|integer|The strength of the wind.}}
{{KV|Particle material|string|Material of the smoke particles emitted by this stack.}}
{{KV|Particle material|intn=SmokeMaterial|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|Twist|intn=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|Roll Speed|intn=Roll|float|Amount of roll in degrees per second.}}
{{KV|Base Color (R G B)|color255}}
{{KV|Base Color (R G B)|intn=rendercolor|color255|The color of the particles.}}
{{KV|Translucency|integer}}
{{KV|Translucency|intn=renderamt|integer|How much you can see through the particles.}}
{{KV Parentname}}
{{KV|Wind Vector|intn=Wind|nofgd=1|vector|Wind direction, not limited to any axis.}}
{{KV Angles}}


== Inputs ==
== Inputs ==
{{IO|TurnOn|Turn on the smokestack.}}
{{I|TurnOn|Turn on the smokestack.}}
{{IO|TurnOff|Turn off the smokestack.}}
{{I|TurnOff|Turn off the smokestack.}}
{{IO|Toggle|Toggles the smokestack between on and off state.}}
{{I|Toggle|Toggles the smokestack between on and off state.}}
{{IO|JetLength|Set the length of the smoke trail.|param=integer}}
{{I|JetLength|param=integer|Sets '''Length of smoke trail'''.}}
{{IO|Rate|Set the rate at which to emit smoke particles (particles per second).|param=integer}}
{{I|Rate|param=integer|Sets '''Emission rate'''.}}
{{IO|Speed|Set the speed at which the smoke particles move after they're spawned.|param=integer}}
{{I|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}}
{{I|SpreadSpeed|param=integer|Sets '''Spread Speed'''.}}
{{I Parentname}}
{{I|Color|nofgd=1|param=color255|Sets '''Base Color'''.}}
{{I|Alpha|nofgd=1|param=int|Sets '''Translucency'''.}}
 
== See also ==
* {{ent|env_particlelight}}

Latest revision as of 22:29, 12 April 2025

English (en)Translate (Translate)
env_smokestack using the FGD defaults.
C++ Class hierarchy
CSmokeStack
↳CBaseParticleEntity
↳CBaseEntity
C++ smokestack.cpp

env_smokestack is a point entity available in all Source Source games. 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.

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

See also

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