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

Revision as of 11:45, 2 November 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) <boolean>
Initial state of the entity.
  • 0: Off
  • 1: On
Spread at the base (BaseSpread) <float>
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) <float>
The speed at which the smoke particles move after they're spawned.
Particle start size (StartSize) <float>
Size of the smoke particles when they're first emitted.
Particle end size (EndSize) <float>
Size of the smoke particles at the point they fade out completely.
Emission rate (Rate) <float>
Rate at which to emit smoke particles (i.e. particles to emit per second).
Length of smoke trail (JetLength) <float>
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) <material>
Material of the smoke particles emitted by this stack.
Twist (Twist) <float>
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