Func dustcloud: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Added a bug about the visual appearance of this entity.)
(added note about scaling)
Line 1: Line 1:
{{base brush|func_dustcloud}} It spawns randomly-sized dust particles within its volume. Use the [[tool textures#trigger|trigger]] texture with this entity.
{{base brush|func_dustcloud}} It spawns randomly-sized dust particles within its volume. Use the [[tool textures#trigger|trigger]] texture with this entity.


{{bug|This entity is hardcoded to use the material ''particle/sparkles.vmt'', which is now extremely low-res and shared with [[func_dustmotes]].  You may consider overriding this .vmt for improved appearance.}}
{{bug|This entity is hardcoded to use the material <code>particle\sparkles.vmt</code>, which is now extremely low-res and shared with {{ent|func_dustmotes}}.  You may consider overriding this .vmt for improved appearance.}}
 
{{note|This entity is functionally identical to <code>func_dustmotes</code> except that the size of sprites created by ''this'' entity will scale realistically depending on the viewing distance, and ones created by <code>func_dustmotes</code> will always take up the same amount of screen space regardless of viewing distance.}}


[[Image:func_dustcloud.jpg|thumb|right|250px|Func_dustcloud]]
[[Image:func_dustcloud.jpg|thumb|right|250px|Func_dustcloud]]
Line 7: Line 9:
{{sfx_brush}}
{{sfx_brush}}


== Keyvalues ==
==Keyvalues==
{{KV|Alpha|integer|Transparency of the particles. 0 means that they are invisible, 255 means opaque.}}
{{KV|Alpha|integer|Transparency of the particles. 0 means that they are invisible, 255 means opaque.}}
{{KV|Minimum Particle Size|string|This value determines the minimum size the particles can be.}}
{{KV|Minimum Particle Size|string|This value determines the minimum size the particles can be.}}
Line 14: Line 16:
{{KV BModelParticleSpawner}}
{{KV BModelParticleSpawner}}


== Inputs ==
==Inputs==
{{I Targetname}}
{{I Targetname}}
{{I BModelParticleSpawner}}
{{I BModelParticleSpawner}}


== Outputs ==
==Outputs==
{{O Targetname}}
{{O Targetname}}


== See also ==
==See also==
* [[func_dustmotes]]
*[[Smoke|Dust, Fog & Smoke]]
* [[Smoke|Dust, Fog & Smoke]]
*[[WiseWind|Wind and Dust]] - example VMF w/ explanation
* [[WiseWind|Wind and Dust]] - example VMF w/ explanation

Revision as of 02:37, 27 June 2018

Template:Base brush It spawns randomly-sized dust particles within its volume. Use the trigger texture with this entity.

Icon-Bug.pngBug:This entity is hardcoded to use the material particle\sparkles.vmt, which is now extremely low-res and shared with func_dustmotes. You may consider overriding this .vmt for improved appearance.  [todo tested in ?]
Note.pngNote: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.
Func_dustcloud

Keyvalues

Alpha ([todo internal name (i)]) <integer>
Transparency of the particles. 0 means that they are invisible, 255 means opaque.
Minimum Particle Size ([todo internal name (i)]) <string>
This value determines the minimum size the particles can be.
Maximum Particle Size ([todo internal name (i)]) <string>
This value determines the maximum size the particles can be.
Name (targetname) <string>[ Edit ]
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

BModelParticleSpawner:
Start Disabled (StartDisabled) <boolean>
Suspend spawning particles after spawning ? Default value is 0
Particle Color (R G B) (Color) <color255>
Color of the particles.
Particle Per Second (SpawnRate) <integer>
Number of particles to spawn, per second.
Note.pngNote:Fourth number effects transparency after reload.
Maximum Particle Speed (SpeedMax) <string>
Maximum speed that the particles can move after spawning.
Minimum Particle Lifetime (LifetimeMin) <string>
Minimum number of seconds until each particle dies. Particles live for a random duration between this and 'Maximum Particle Lifetime'.
Maximum Particle Lifetime (LifetimeMax) <string>
Maximum number of seconds until each particle dies. Particles live for a random duration between 'Minimum Particle Lifetime' and this.
Maximum Visible Distance (DistMax) <integer>
Maximum distance at which particles are visible. They fade to translucent at this distance.
Frozen (Frozen) <boolean>
Spawn the number of particles in SpawnRate immediately, and then go inactive ? Default value is 0


Inputs

BModelParticleSpawner:
TurnOn
Turn on.
TurnOff
Turn off.

Outputs

See also