Trigger soundscape

Entity description

A brush trigger especially for triggering an env_soundscape_triggerable entity (specified in its Soundscape property).

This entity is triggered on three conditions:

• That the entity is enabled,
• that the player is within its volume,
• and that the player doesn't simultaneously trigger another soundscape entity.

Tip:Use the convar soundscape_debug to examine which soundscape is active and why.

In code this entity is represented by class CTriggerSoundscape, defined in soundscape.cpp.

Keyvalues

• {| 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 |

Filter Name (filtername) <filter>

A filter entity to test potential activators against.

Start Disabled (StartDisabled) <boolean>

Stay dormant until activated (with theEnableinput).

|}

• soundscape

<target_source> The name of the env_soundscape_triggerable entity to trigger.

Flags

BaseTrigger

Everything (not including physics debris) : [64] Clients (Survivors, Special Infected, Tanks ) : [1] Only clients in vehicles : [32] Only clients *not* in vehicles : [512] Disallow Bots (removed since ) : [4096] NPCs (Common Infected, Witches ) : [2] Only player ally NPCs : [16] Only NPCs in vehicles (respects player ally flag) : [2048] Physics Objects (not including physics debris) : [8] Physics debris (include also physics debris) : [1024] Pushables (Passes entities with classname func_pushable) : [4]  Deprecated. Equivalent to using Everything + filter_activator_class that filters func_pushable.

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.

|}

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.

|}

See also

• Soundscapes - The general subject.
• env_soundscape_triggerable - An entity paired with this entity.