func_dustcloud

From Valve Developer Community
Revision as of 10:15, 27 June 2018 by Pinsplash (talk | contribs) (synchronized with information on func_dustmotes)

Jump to: navigation, search
Func_dustcloud

func_dustcloud is a brush entity available in all Source games. It spawns randomly-sized dust particles within its volume. Use the trigger texture with this entity. The nodraw texture can also be used, but not recommended.

Tip:This entity is affected by env_wind.
Note:The default material is particle/sparkles.vmt. It is normally extremely low-res, so consider overriding this .vmt for improved appearance.
Note:This entity is functionally identical to func_dustmotes except that the size of sprites created by this entity will scale realistically depending on the viewing distance, and ones created by func_dustmotes will always take up the same amount of screen space regardless of viewing distance.

Keyvalues

Alpha <integer>
Transparency of the particles. 0 means that they are invisible, 255 means opaque.
Minimum Particle Size <string>
This value determines the minimum size the particles can be.
Maximum Particle Size <string>
This value determines the maximum size the particles can be.

Targetname:

Name <string>
The targetname that other entities refer to this entity by.
Entity Scripts <scriptlist> (New with 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 <string> (New with 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.

BModelParticleSpawner:

Start Disabled <boolean>
Don't create particles when spawned.
Particle Color (R G B) <color255>
Color of the particles.
Particle Per Second <integer>
Number of particles to spawn, per second.
Maximum Particle Speed <string>
Maximum speed that the particles can move after spawning.
Minimum Particle Lifetime <string>
Minimum number of seconds until each particle dies. Particles live for a random duration between this and 'Maximum Particle Lifetime'.
Maximum Particle Lifetime <string>
Maximum number of seconds until each particle dies. Particles live for a random duration between 'Minimum Particle Lifetime' and this.
Maximum Visible Distance <integer>
Maximum distance at which particles are visible. They fade to translucent at this distance.
Frozen <boolean>
When set, this entity spawns the number of particles in SpawnRate immediately, and then goes inactive.

Inputs

Targetname:

Kill
Removes this entity and any entities parented to it from the world.
KillHierarchy
Functions the same as Kill, although entities with a large number of children are killed marginally faster.
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.
Use  !FGD
Same as a player invoking +use; may not do anything. Can also be invoked by creating an output that does not specify an input.
This input is not included in Valve's FGDs.
RunScriptFile  <script> (New with 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> (New with 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> (New with Left 4 Dead 2) !FGD
Execute a VScript function in the scope of the receiving entity.
Note:This input is missing from some games FGD files.
SetLocalOrigin  <origin> (New with Alien Swarm) !FGD
Set this entity's origin in the map.
Note:This input is missing from some games FGD files.
SetLocalAngles  <angles> (New with Alien Swarm) !FGD
Set this entity's angles in the map.
Note:This input is missing from some games FGD files.

BModelParticleSpawner:

TurnOn
Turn on.
TurnOff
Turn off.

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  (New with Left 4 Dead)
This Output fires when the entity is killed and removed from the game.

See also