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

func_dustmotes

From Valve Developer Community
Jump to: navigation, search
A func_dustmotes in cs_militiaCounter-Strike: Source.

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

Note.pngNote:This entity is affected by env_wind. The dustmotes can be carried through walls.
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_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

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 Counter-Strike: Global Offensive)
Sets if dust particles are affected by wind.
Name (targetname) <string>
The targetname that other entities refer to this entity by.

BModelParticleSpawner:
Start Disabled (StartDisabled) <choices>
Suspend spawning particles after spawning ? Default value is 0
  • 0: No
  • 1: Yes
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) <choices>
Spawn the number of particles in SpawnRate immediately, and then go inactive ? Default value is 0
  • 0: No
  • 1: Yes


Inputs


Base:
AddContext <string>
Adds to the entity's list of response contexts. See Context.
AddOutput <string>
Assigns a new keyvalue/output on this entity. For keyvalues, some rely on extra necessary code to be ran and won't work if its simply just changed through this input. There is a strict format that must be followed:
// Format of changing KeyValues: "AddOutput [key] [value]"
//// Raw text:
"OnUser1" "!self,AddOutput,targetname new_name"

// Format of adding an Output: "AddOutput {targetname}:{inputname}:{parameter}:{delay}:{max times to fire, -1 means infinite}"
//// Raw text:
"OnUser1" "!self,AddOutput,OnUser1:SetParent:!activator:0.0:-1"
// Arguments can be left blank, but the empty blank should still be contained.
//// Raw text:
"OnUser1" "!self,AddOutput,OnUser1:ClearParent::0.0:-1"
ClearContext
Removes all contexts from this entity's list.
ClearParent
Removes this entity from the the movement hierarchy, leaving it free to move independently.
FireUser1 to FireUser4
Fires the respectiveOnUseroutputs; see User Inputs and Outputs.
Kill
Removes this entity and any entities parented to it from the world.
KillHierarchy
Functions the same as Kill, although this entity and any entities parented to it are killed on the same frame, being marginally faster thanKillinput.
RemoveContext <string>
Remove a context from this entity's list. The name should match the key of an existing context.
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.
Use  !FGD
Same as a player invoking +use; no effect in most cases.
DispatchResponse <string> !FGD
Dispatches a response to the entity. See Response and Concept.
DispatchEffect <string> (removed since Left 4 Dead) !FGD
Dispatches a special effect from the entity's origin; See also List of Client Effects. Replaced by the particle system since Left 4 Dead.
RunScriptFile <script> (in all games since Left 4 Dead 2) (also in Team Fortress 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) (also in Team Fortress 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.
Icon-Bug.pngBug:In Hammer, using string arguments will corrupt the VMF file's structure, making the file unviewable for the next Hammer session.
Note.pngFix:Remove the string argument manually with a text editor.
Note.pngNote:Team Fortress 2 Backtick characters ` are replaced with quotation marks at runtime, allowing quotation marks to be used when normally not possible.
CallScriptFunction <string> (in all games since Left 4 Dead 2) (also in Team Fortress 2) !FGD
Calls a VScript function defined in the scope of the receiving entity.
TerminateScriptScope  (only in Team Fortress 2) !FGD
Destroys the script scope of the receving 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.

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