Env smokestack: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Robot: fixing template case.)
(Cleanup)
Line 1: Line 1:
{{wrongtitle|title=env_smokestack}}
{{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.
{{base_point}}
 
==Entity Description==
An entity that 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.


==Availability==
==Availability==
Line 9: Line 5:
{{in code|class=class_c_smoke_stack.html CSmokeStack|file=smokestack_8cpp-source.html smokestack.cpp}}
{{in code|class=class_c_smoke_stack.html CSmokeStack|file=smokestack_8cpp-source.html smokestack.cpp}}


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


==Outputs==
== Inputs ==
* {{O Targetname}}
{{IO|TurnOn|Turn on the smokestack.}}
{{IO|TurnOff|Turn off the smokestack.}}
{{IO|Toggle|Toggles the smokestack between on and off state.}}
{{IO|JetLength|Set the length of the smoke trail.|param=integer}}
{{IO|Rate|Set the rate at which to emit smoke particles (particles per second).|param=integer}}
{{IO|Speed|Set the speed at which the smoke particles move after they're spawned.|param=integer}}
{{IO|SpreadSpeed|Set the amount of random spread in the velocity of the smoke particles after they're spawned.|param=integer}}
{{I Parentname}}

Revision as of 06:54, 24 July 2011

Template:Base point 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.

Availability

Template:In game Template:Game-base Template:In code

Keyvalues

Name ([todo internal name (i)]) <string>
The name that other entities refer to this entity by.
Initial State ([todo internal name (i)]) <choices>
Initial state of the entity.
  • 0 : Off
  • 1 : On
Spread at the base ([todo internal name (i)]) <integer>
Amount of random spread in the origins of the smoke particles when they're spawned.
Spread Speed ([todo internal name (i)]) <integer>
Amount of random spread in the velocity of the smoke particles after they're spawned.
Speed ([todo internal name (i)]) <integer>
The speed at which the smoke particles move after they're spawned.
Particle start size ([todo internal name (i)]) <integer>
Size of the smoke particles when they're first emitted.
Particle end size ([todo internal name (i)]) <integer>
Size of the smoke particles at the point they fade out completely.
Emission rate ([todo internal name (i)]) <integer>
Rate at which to emit smoke particles (i.e. particles to emit per second).
Length of smoke trail ([todo internal name (i)]) <integer>
Length of the smokestack. Lifetime of the smoke particles is derived from this & particle speed.
Wind X/Y Angle ([todo internal name (i)]) <integer>
This specifies the wind direction. It is an angle in the XY plane. WindSpeed specifies the strength of the wind.
Wind Speed ([todo internal name (i)]) <integer>
The strength of the wind.
Particle material ([todo internal name (i)]) <string>
Material of the smoke particles emitted by this stack.
Twist ([todo internal name (i)]) <integer>
The amount, in degrees per second, that the smoke particles twist around the origin.
Roll Speed ([todo internal name (i)]) <float>
Amount of roll in degrees per second.
Base Color (R G B) ([todo internal name (i)]) <color255>
Translucency ([todo internal name (i)]) <integer>
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.
Pitch Yaw Roll (Y Z X) (angles) <QAngle>
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 <integerRedirectInput/integer>
Set the length of the smoke trail.
Rate <integerRedirectInput/integer>
Set the rate at which to emit smoke particles (particles per second).
Speed <integerRedirectInput/integer>
Set the speed at which the smoke particles move after they're spawned.
SpreadSpeed <integerRedirectInput/integer>
Set the amount of random spread in the velocity of the smoke particles after they're spawned.
Parentname:
SetParent <stringRedirectInput/string>
Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment <stringRedirectInput/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 <stringRedirectInput/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.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Env_smokestack&oldid=155729"