Env smokestack

From Valve Developer Community

The title given to this article is incorrect due to technical limitations. The correct title is env_smokestack.

This point-based entity is available in all Source games.

Table of contents
1 Entity Description
2 Availability
3 Keyvalues
4 Inputs
5 Outputs
[edit]

Entity Description

An entity that spits out a constant stream of smoke. You can place up to two env_particlelight entities near the smoke stack to add ambient light to its particles.

[edit]

Availability

This point-based entity is available in: all Source games. In code it is represented by class CSmokeStack (http://doxygen.page.needed/class_c_smoke_stack.html), defined in smokestack.cpp (http://doxygen.page.needed/smokestack_8cpp-source.html).

[edit]

Keyvalues

Defines the name that other entities refer to this entity by.
  • hammerid [Episode Two Update]
<integer readonly> This id is used for debugging purposes in Hammer.
  • InitialState
<boolean>
  • BaseSpread
<float> Amount of random spread in the origins of the smoke particles when they're spawned.
  • SpreadSpeed
<integer> Amount of random spread in the velocity of the smoke particles after they're spawned.
  • Speed
<integer> The speed at which the smoke particles move after they're spawned.
  • StartSize
<float> Size of the smoke particles when they're first emitted.
  • EndSize
<float> Size of the smoke particles at the point they fade out completely.
  • Rate
<integer> Rate at which to emit smoke particles (i.e. particles to emit per second).
  • JetLength
<integer> Length of the smokestack. Lifetime of the smoke particles is derived from this & particle speed.
  • WindAngle
<integer> This specifies the wind direction. It is an angle in the XY plane. WindSpeed specifies the strength of the wind.
  • WindSpeed
<integer> The strength of the wind.
  • SmokeMaterial
<material> Material of the smoke particles emitted by this stack.
  • twist
<float> The amount, in degrees per second, that the smoke particles twist around the origin.
  • rendercolor
<color255> Base Color
  • renderamt
<integer> Translucency
  • roll [Episode One Update]
<float> Amount of roll in degrees per second.
[edit]

Inputs

  • Kill
Removes this entity from the world.
Removes this entity and all its children from the world.
  • AddOutput <string>
Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.
Format: <key> <value>
Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>
Causes this entity's OnUser1-4 outputs to be fired. See User Inputs and Outputs.
  • TurnOn
Turn on the smokestack.
  • TurnOff
Turn off the smokestack.
  • Toggle
Toggles the smokestack between on and off state.
  • JetLength <float>
Set the length of the smoke trail.
  • Rate <float>
Set the rate at which to emit smoke particles (particles per second).
  • Speed <float>
Set the speed at which the smoke particles move after they're spawned.
  • SpreadSpeed <float>
Set the amount of random spread in the velocity of the smoke particles after they're spawned.
[edit]

Outputs

Fired in response to FireUser1-4 inputs. See User Inputs and Outputs.
!activator = activator
Retrieved from "http://developer.valvesoftware.com/wiki/Env_smokestack"