env_steam

From Valve Developer Community

Revision as of 03:08, 20 January 2009 by VDCBot (Talk | contribs)
(diff) ← Older revision | Current revision (diff) | Newer revision → (diff)
Jump to: navigation, search

env_steam is a point entity available in all Source games.

Contents

Entity description

An entity used to create a jet of steam.

Keyvalues

  • Targetname:

Name <string>
The targetname other entities refer to this entity by.
  • Parentname:

Parent <targetname>
Specifies the targetname of this entity's movement parent. Entities with parents move with their parent.
  • Angles:

Pitch Yaw Roll (Y Z X) <angle>
This entity's angular orientation in the world.
  • InitialState
<boolean>
  • type
<boolean> If set, normal, otherwise heat wave
  • SpreadSpeed
<integer> The amount of random spread in the particle's velocity after they spawn.
  • Speed
<integer> The default speed at which the particles move after they spawn.
  • StartSize
<integer> The initial size of the particles after they spawn.
  • EndSize
<integer> The size of the particles at the point at which they are removed.
  • Rate
<integer> The rate of particle emission. i.e. particles per second.
  • rendercolor
<color255> Only used if Emissive flag is set.
  • JetLength
<integer> The length of the jet determines the lifetime of each particle.
  • renderamt
<byte> Translucency
  • rollspeed
<float> How fast does the particles spin

Flags

  • 1 : Emissive - Use the value specified in the rendercolor keyvalue. (If not checked, it will instead get the rendercolor from the environment.)

Inputs

  • Targetname:

Kill
Removes this entity from the world.
KillHierarchy
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 means infinite>
FireUser1 to FireUser4
Fire the OnUser outputs; see User Inputs and Outputs.
  • Parentname:

SetParent <targetname>
Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment <string>
Attach to a named attachment on the current parent. The entity will teleport so that the position of its root bone matches that of the attachment.
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 its current movement hierarchy.
  • TurnOn
Turns the steam jet on.
  • TurnOff
Turns the steam jet off.
  • Toggle
Toggles the steam jet between on and off.
  • JetLength <integer>
Sets the JetLength
  • Rate <integer>
Sets the Rate
  • Speed <integer>
Sets the Speed
  • SpreadSpeed <integer>

Outputs

  • Targetname:

OnUser1 to OnUser4
Fired in response to the FireUser inputs; see User Inputs and Outputs.
OnKilled (New with Left 4 Dead)
Fired when the entity is killed and removed from the game.
Personal tools