This article's documentation is for anything that uses the Source engine. Click here for more information.

Func dustcloud: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(-added class hierarchy, cleanup)
(Remove note about using trigger texture/nodraw. Was added in 2007 and unless proof is given otherwise the texture makes no difference.)
Line 2: Line 2:
[[File:func_dustcloud.jpg|thumb|right|250px|Func_dustcloud]]
[[File:func_dustcloud.jpg|thumb|right|250px|Func_dustcloud]]
{{CD|CFunc_DustCloud|file1=1}}
{{CD|CFunc_DustCloud|file1=1}}
{{this is a|brush entity|name=func_dustcloud}} It spawns randomly-sized dust particles within its volume. Use the [[tool textures#trigger|trigger]] texture with this entity. The [[tool textures#nodraw|nodraw]] texture can also be used, but not recommended{{why}}.{{sfx_brush}}__NOTOC__
{{this is a|brush entity|name=func_dustcloud}} It spawns randomly-sized dust particles within its volume.{{sfx_brush}}__NOTOC__


{{bug|In {{Portal2}} : Particles may disappear in opened portals at some angles. More serious glitches may occur in other specific scenarios.}}
{{bug|In {{Portal2}} : Particles may disappear in opened portals at some angles. More serious glitches may occur in other specific scenarios.}}

Revision as of 17:01, 11 November 2024

English (en)Translate (Translate)
Func_dustcloud
C++ Class hierarchy
CFunc_DustCloud
CFunc_Dust
CBaseEntity
C++ func_dust.cpp

func_dustcloud is a brush entity available in all Source Source games. It spawns randomly-sized dust particles within its volume.

Icon-Bug.pngBug:In Portal 2 : Particles may disappear in opened portals at some angles. More serious glitches may occur in other specific scenarios.  [todo tested in ?]
Tip.pngTip:This entity is affected by env_wind.
Note.pngNote:The default material is particle/sparkles.vmt. It is normally extremely low-res, so consider overriding this .vmt for improved appearance.
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.

Keyvalues

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

Alpha (Alpha) <integer>
Transparency of the particles. 0 means that they are invisible, 255 means opaque.
Minimum Particle Size (SizeMin) <string>
This value determines the minimum size the particles can be.
Maximum Particle Size (SizeMax) <string>
This value determines the maximum size the particles can be.
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.

See also