env_smokestack

From Valve Developer Community
Revision as of 04:19, 30 June 2013 by Doublethinking (talk | contribs) (Keyvalues)
Jump to: navigation, search

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

File:SmokeStack.jpg
Env_smokestack with Bubble Effect

Availability

Template:In game Template:Game-base In code it is represented by class CSmokeStack, defined in smokestack.cpp.

Keyvalues

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

Parentname:

Parent (parentname) <targetname>
Specifies a movement parent. An entity will maintain its initial offset from its parent. An attachment point can be added to the end of the name, separated by a comma.

Angles:

Pitch Yaw Roll (Y Z X) (angles) <angle>
This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.

Inputs

TurnOn
Turn on the smokestack.
TurnOff
Turn off the smokestack.
Toggle
Toggles the smokestack between on and off state.
JetLength <integer>
Set the length of the smoke trail.
Rate <integer>
Set the rate at which to emit smoke particles (particles per second).
Speed <integer>
Set the speed at which the smoke particles move after they're spawned.
SpreadSpeed <integer>
Set the amount of random spread in the velocity of the smoke particles after they're spawned.

Parentname:

SetParent <string>
Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment <string>
Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.
SetParentAttachmentMaintainOffset <string>
As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
ClearParent
Removes this entity from the the movement hierarchy, leaving it free to move independently.