Func smokevolume

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

• Template:Kv targetname
• Template:Kv enabledisable
• Color1

⇆#000000rgb(0,0,0)⇆ Particle color 1

• Color2

⇆#000000rgb(0,0,0)⇆ 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

• {| class="mw-collapsible mw-collapsed" style="background:initial;float:no;margin-bottom:1em;margin-left:0;padding-right:0.5em;border:1px solid rgba(255,255,255,0.1); border-left:solid 1px #8bb9e0; padding-left:1em;"

|+ style="text-align:left; white-space:nowrap; font-weight:bold; color:#ddd; " | BaseTrigger |

Toggle

Toggles this trigger between enabled and disabled states.

Enable

Enable trigger

Disable

Disable trigger

TouchTest  (in all games since )

Triggers either the OnTouching or OnNotTouching outputs for whether anything is touching this entity.

Bug:Sleeping prop_physics will never fire "OnTouching". Also applies to entities using prop_physics as base.  (tested in: )

StartTouch  (in all games since ) !FGD

Behave as if the !caller entity had just entered the trigger volume. Accepts non-physical entities.

EndTouch  (in all games since ) !FGD

Behave as if !caller had just exited the trigger volume.

DisableAndEndTouch  (only in )

Disables this trigger and calls EndTouch on all currently-touching entities.

|}

• 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

• {| class="mw-collapsible mw-collapsed" style="background:initial;float:no;margin-bottom:1em;margin-left:0;padding-right:0.5em;border:1px solid rgba(255,255,255,0.1); border-left:solid 1px #8bb9e0; padding-left:1em;"

|+ style="text-align:left; white-space:nowrap; font-weight:bold; color:#ddd; " | BaseTrigger |

OnStartTouch

!activator = entity that caused this output
!caller = this entity
Fired when a valid entity starts touching this trigger.

OnStartTouchAll

!activator = entity that caused this output
!caller = this entity
Fired when a valid entity starts touching this trigger, and no other entities are touching it. If there are any other entities touching the trigger when a new one begins to touch, only OnStartTouch will fire.

OnEndTouch

!activator = entity that caused this output
!caller = this entity
Fired when a valid entity stops touching this trigger.

Note:Will also fire for entities touching it when trigger is disabled via Disable input

Warning:This includes entities which are deleted while inside the trigger. In this case !activator will be invalid.

Warning:OnEndTouch can fire before OnStartTouch under certain circumstances^[How?] where both are fired on the same tick and each have the same delay.

Fix:Add a slight delay to OnEndTouch.

OnEndTouchAll

!activator = entity that caused this output
!caller = this entity
Fired when all valid entities stop touching this trigger.

OnTouching  (in all games since )

!activator = !caller = this entity
Fired if something is currently touching this trigger when TouchTest is fired.

OnNotTouching  (in all games since )

!activator = !caller = this entity
Fired if nothing is currently touching this trigger when TouchTest is fired.

|}