func_smokevolume

From Valve Developer Community

Jump to: navigation, search

This is a brush entity available in all Source games.

Contents

Entity Description

A brush entity that spawns smoke particles within its volume, commonly used for large, localised areas of fog. Use the trigger texture or the fog texture.

Note:The default material is particle/smoke_grenade1, which does not exist. However, particle/particle_smokegrenade does.

Keyvalues

  • Targetname:

Name <string>
The targetname other entities refer to this entity by.

  • EnableDisable:

Start Disabled <bool>
Stay dormant until activated (probably with the Enable input).
  • Color1
<color255> Particle color 1
  • Color2
<color255> Particle color 2
  • material
<material> The material to use for the particles.
  • ParticleDrawWidth
<float> The size of the particles, in units/inches/
  • ParticleSpacingDistance
<float> The distance between the particles inside the volume. The lower the number, the denser the particles, and the more overdraw there will be. It is best to keep it as high as you can without it looking bad.
  • DensityRampSpeed
<float> Time to go from density 0 to density 1, in seconds.
  • RotationSpeed
<float> The speed that the particles should rotate, in degrees per second.
  • MovementSpeed
<float> The speed that the particles should move around, in units/inches per second.
  • Density
<float> Particle density, from 0 to 1.

Flags

  • 1 : Emissive (Changes how the smoke particles are drawn. Emissive is 4 times more expensive to render.)

Inputs

  • Trigger:

TouchTest (New with Orange Box)
Triggers either the OnTouching or OnNotTouching outputs for whether anything is touching this entity.

TriggerOnce:

Toggle
Toggles this trigger between enabled and disabled states.

EnableDisable:

Enable
Disable
Enable/disable this entity from performing its task. It might also disappear from view.

Parentname:

SetParent <targetname>
Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment <string>
Attach to a named attachment on the current parent. The entity will teleport so that the position of its root bone matches that of the attachment.
SetParentAttachmentMaintainOffset <string>
As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
ClearParent
Removes this entity from its current movement hierarchy.

Targetname:

Kill
Removes this entity from the world.
KillHierarchy
Removes this entity and all its children from the world.
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.
  • SetRotationSpeed <float>
Set the particle rotation speed (in degrees per second).
  • SetMovementSpeed <float>
Set the particle movement speed (in inches per second).
  • SetDensity <float>
Set the particle density. It should be a range from 0 to 1.

Outputs

  • Trigger:

OnEndTouch
Fired when an entity stops touching this trigger. Only entities that passed this trigger's filters will cause this output to fire. (activator is the exiting entity)
OnEndTouchAll
Fires when the last entity in the entity's area exits this trigger or when this entity is disabled. Only entities that passed this trigger's filters are considered. (activator is the last exiting entity)
OnTouching (New with Orange Box)
OnNotTouching (New with Orange Box)
Fired when the TouchTest input is called.

TriggerOnce:

OnStartTouch
Fired when an entity starts touching this trigger. The touching entity must pass this trigger's filters to cause this output to fire. (activator is the toucher)
OnTrigger
Fired whenever the trigger is activated. (activator is the activator)

Targetname:

OnUser1 to OnUser4
Fired in response to the FireUser inputs; see User Inputs and Outputs.
OnKilled (New with Left 4 Dead)
Fired when the entity is killed and removed from the game.
Retrieved from "http://developer.valvesoftware.com/wiki/Func_smokevolume"
Personal tools