Func dustmotes: Difference between revisions

Latest revision as of 17:14, 11 November 2024

A func_dustmotes in cs_militia

.

Class hierarchy
CFunc_DustMotes ↳CFunc_Dust ↳CBaseEntity
`func_dust.cpp`

func_dustmotes is a brush entity available in all Source games. It spawns sparkling dust motes within its volume.

Note:This entity is affected by env_wind. The dustmotes can be carried through walls.

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_dustcloud except that the size of sprites created by func_dustcloud will scale realistically depending on the viewing distance, and ones created by this entity 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

Minimum Particle Size (SizeMin) <string>: Minimum size a dust mote should be. The units aren't exactly clear, but 100 is the highest you should probably be going.

Maximum Particle Size (SizeMax) <string>: Maximum size a dust mote should be.

Alpha (Alpha) <integer>: Transparency of the particles. 255 is fully opaque, 0 is invisible (won't render at all).

Affected By Wind (AffectedByWind) <boolean> (in all games since ): Sets if dust particles are affected by wind.

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: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.

@@ Line 1: / Line 1: @@
-{{wrongtitle|title=func_dustmotes}}
+{{LanguageBar}}
-{{base_brush}}
+[[File:Func_dustmotes_example_css.jpg|thumb|right|260px|A <code>func_dustmotes</code> in <code>cs_militia</code>{{css}}.]]
+{{CD|CFunc_DustMotes|file1=1}}
+{{this is a|brush entity|name=func_dustmotes}} It spawns sparkling dust motes within its volume.{{sfx_brush}}
-==Entity Description==
+{{note|This entity is affected by {{ent|env_wind}}. The dustmotes can be carried through walls.}}
-A [[brush entity]] that spawns sparkling dust motes within its volume.
-{{sfx_brush}}
+{{note|The default [[material]] is <code>particle/sparkles.vmt</code>. It is normally extremely low-res, so consider overriding this .[[vmt]] for improved appearance.}}
-* See also [[func_dustcloud]]
+{{note|This entity is functionally identical to {{ent|func_dustcloud}} except that the size of sprites created by <code>func_dustcloud</code> will scale realistically depending on the viewing distance, and ones created by ''this'' entity will always take up the same amount of screen space regardless of viewing distance.}}
 ==Keyvalues==
-* {{kv targetname}}
+{{KV Targetname}}
-* {{kv enabledisable}}
+{{KV|Minimum Particle Size|intn=SizeMin|string|Minimum size a dust mote should be. The units aren't exactly clear, but 100 is the highest you should probably be going.}}
-* '''Color'''
+{{KV|Maximum Particle Size|intn=SizeMax|string|Maximum size a dust mote should be.}}
-: {{color}} Particle Color
+{{KV|Alpha|intn=Alpha |integer|Transparency of the particles. 255 is fully opaque, 0 is invisible (won't render at all).}}
-* '''SpawnRate'''
+{{KV|Affected By Wind|intn=AffectedByWind|boolean|since=CSGO|Sets if dust particles are affected by wind.}}
-: <integer> Number of particles to spawn, per second.
+{{KV BModelParticleSpawner}}
-* '''SpeedMax'''
-: <integer> Maximum speed that the particles can move after spawning.
-* '''LifetimeMin'''
-: <integer> Minimum number of seconds until each particle dies. Particles live for a random duration between this and 'Maximum Particle Lifetime'.
-* '''LifetimeMax'''
-: <integer> Maximum number of seconds until each particle dies. Particles live for a random duration between 'Minimum Particle Lifetime' and this.
-* '''DistMax'''
-: <integer> Maximum distance at which particles are visible. They fade to translucent at this distance.
-* '''Frozen'''
-: {{boolean}} If set, this entity spawns the number of particles in SpawnRate immediately, and then goes inactive.
-* '''SizeMin'''
-: <integer> Minimum Particle Size
-* '''SizeMax'''
-: <integer> Maximum Particle Size
-* '''Alpha'''
-: <[[byte]]>
 ==Inputs==
-* {{i targetname}}
+{{I BModelParticleSpawner}}
-* '''TurnOn'''
-: Turn on.
-* '''TurnOff'''
-: Turn off.
-==Outputs==
+== See Also ==
-* {{o targetname}}
+* {{ent|func_dustcloud}}

Func dustmotes: Difference between revisions

Latest revision as of 17:14, 11 November 2024

Keyvalues

Inputs

See Also

Navigation menu

Search