Func smokevolume

From Valve Developer Community

The title given to this article is incorrect due to technical limitations. The correct title is func_smokevolume.

This Brush-based Entity is available in all Source Games.

Table of contents
1 Entity Description
2 Keyvalues
3 Flags
4 Inputs
5 Outputs
[edit]

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.

Image:note.png Note: The default material is particle/smoke_grenade1, which does not exist. However, particle/particle_smokegrenade does.
[edit]

Keyvalues

Defines the name that other entities refer to this entity by.
  • hammerid [New with Orange Box]
<integer readonly> This id is used for debugging purposes in Hammer.
  • StartDisabled
<boolean>
  • 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.
[edit]

Flags

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

Inputs

  • Kill
Removes this entity from the world.
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 == infinite)>
Causes this entity's OnUser1-4 outputs to be fired. See User Inputs and Outputs.
Changes the entity's parent in the movement hierarchy.
Change this entity to attach to a specific attachment point on its parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment.
Change this entity to attach to a specific attachment point on it's parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment. The entity will maintain it's position relative to the Parent's Origin and Angles at the time it is attached.
Removes this entity from its current movement hierarchy.
  • Enable
Enable this entity.
  • Disable
Disable this entity.
  • Toggle
Toggles this trigger between enabled and disabled states.
  • TouchTest [New with Orange Box]
Triggers either OnTouching or OnNotTouching for whether anything is touching this entity.
  • 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.
[edit]

Outputs

Fired in response to FireUser1-4 inputs. See User Inputs and Outputs.
!activator = activator
  • 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 = toucher
  • OnTrigger
Fired whenever the trigger is activated.
!activator = activator
  • OnEndTouch
Fired when an entity stops touching this trigger. Only entities that passed this trigger's filters will cause this output to fire.
!activator = 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 = last exiting entity
  • OnTouching [New with Orange Box]
Fired when this entity's TouchTest is called.
  • OnNotTouching [New with Orange Box]
Fired when this entity's TouchTest is called.
Retrieved from "http://developer.valvesoftware.com/wiki/Func_smokevolume"