env_smoketrail

From Valve Developer Community
Revision as of 13:57, 24 February 2018 by Ficool2 (talk | contribs)

Jump to: navigation, search

env_smoketrail is a point entity available in all Source games.

Entity description

It creates a smoke trail.

In code it is represented by class SmokeTrail, defined in smoke_trail.cpp.

Keyvalues

Sprite Opacity <float>
Opacity of the sprites (range from 0 - 1).
Spawn Rate <float>
Number of particles to emit each second.
Particle Life Time <float>
Number of seconds until each particle dies.
Start Color <color255>
Starting color of the emitted particles.
End Color <color255>
Ending color of the emitted particles.
Emitter Life Time <float>
Number of seconds until the env_smoketrail stops emitting particles. 0 means never stop emitting particles.
Minimum Random Speed <float>
Minimum randomly-directed speed to use for emitted particles.
Maximum Random Speed <float>
Maximum randomly-directed speed to use for emitted particles.
Minimum Directed Speed <float>
Minimum speed along the env_smoketrail's forward direction (x axis) to use for emitted particles.
Maximum Directed Speed <float>
Maximum speed along the env_smoketrail's forward direction (x axis) to use for emitted particles.
Starting particle size <float>
Starting particle size.
Ending particle size <float>
Ending particle size.
Spawn radius <float>
Distance from env_smoketrail at which particles are emitted.
Fire Sprite <sprite>
Sprite to use for fire particles.
Bug: Does not function.
Smoke Puff <sprite>
Sprite to use for smoke puffs.
Bug: Does not function.

Targetname:

Name (targetname) <string>
The targetname that other entities refer to this entity by.
Entity Scripts (vscripts) <scriptlist> (in all games since <Left 4 Dead 2>)
Space delimited list of VScript files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions.
Script think function (thinkfunction) <string> (in all games since <Left 4 Dead 2>)
Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call.
Note:Try to avoid expensive operations in this function, as it may cause performance problems.

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.

Inputs

Targetname:

Kill
Removes this entity from the world.
KillHierarchy
Removes this entity and its children from the world.
Note:Entities already remove orphaned children upon being removed, but this input removes all children on the same frame, being marginally faster than Kill.
AddOutput <string>
Adds a keyvalue/output to this entity. It can be potentially very dangerous, use with care.
KV Format: <key> <value>
I/O 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.
Use  !FGD
Same as a player invoking +use; may not do anything depending on the entity. Can also be invoked by firing an output that does not specify an input.
RunScriptFile <script> (in all games since <Left 4 Dead 2>)
Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode <string> (in all games since <Left 4 Dead 2>)
Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console.
Bug: In <Left 4 Dead 2>, the code is executed in the script scope of the entity that fires the output, not the one receiving the input.
Warning: Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.
CallScriptFunction <string> (in all games since <Left 4 Dead 2>) !FGD
Execute a VScript function in the scope of the receiving entity.
SetLocalOrigin <coordinates> (in all games since <Alien Swarm>) !FGD
Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.
SetLocalAngles <angles> (in all games since <Alien Swarm>) !FGD
Set this entity's angles.

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.

Outputs

Targetname:

OnUser1 to OnUser4
These outputs each fire in response to the firing of the like-numbered FireUser1 to FireUser4 Input; see User Inputs and Outputs.
OnKilled  (only in <Left 4 Dead><Left 4 Dead 2>)
This output fires when the entity is killed and removed from the game.