Trigger soundscape: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Don't star flags. They're already stared.)
No edit summary
Line 1: Line 1:
{{wrongtitle|title=trigger_soundscape}}
{{base_brush|trigger_soundscape}} It automatically triggers an [[env_soundscape_triggerable]] whenever a player is inside its volume and not triggering any other soundscape entities.
{{base_brush}}
{{sensor_brush}}


== Entity description ==
{{tip|Use the [[convar]] <code>soundscape_debug</code> to examine which soundscape is active and why.}}
A brush [[trigger]] especially for triggering an [[env_soundscape_triggerable]] entity (specified in its ''Soundscape'' property).


This entity is triggered on three conditions:
== See also ==
* 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.}}
* [[Soundscapes]]
* [[env_soundscape_triggerable]]


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


== Keyvalues ==
{{KV|Soundscape|targetname|The [[env_soundscape_triggerable]] that this brush triggers.}}
*{{KV Trigger}}
{{KV Trigger}}
*'''soundscape'''
:<target_source> The name of the [[env_soundscape_triggerable]] entity to trigger.


== Flags ==
== Flags ==
Line 24: Line 17:


== Inputs ==
== Inputs ==
*{{I Trigger}}
{{I Trigger}}


== Outputs ==
== Outputs ==
*{{O Trigger}}
{{O Trigger}}
 
 
== See also ==
 
* [[Soundscapes]] - The general subject.
* [[env_soundscape_triggerable]] - An entity paired with this entity.


[[Category:Sound System]]
[[Category:Sound System]]

Revision as of 10:20, 29 May 2011

Template:Base brush It automatically triggers an env_soundscape_triggerable whenever a player is inside its volume and not triggering any other soundscape entities.

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

See also

Keyvalues

Soundscape ([todo internal name (i)]) <targetname>
The env_soundscape_triggerable that this brush triggers.
BaseTrigger
Filter Name (filtername) <filter>
A filter entity to test potential activators against.
Start Disabled (StartDisabled) <boolean>
Stay dormant until activated (with theEnableinput).

Flags

BaseTrigger
Everything (not including physics debris) : [64]
Clients (Survivors, Special Infected, Tanks Left 4 Dead seriesLeft 4 Dead series) : [1]
Only clients in vehicles : [32]
Only clients *not* in vehicles : [512]
Disallow Bots (removed since Left 4 Dead) : [4096]
NPCs (Common Infected, Witches Left 4 Dead seriesLeft 4 Dead series) : [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] Obsolete
Deprecated.
Equivalent to using Everything + filter_activator_class that filters func_pushable.

Inputs

BaseTrigger
Toggle
Toggles this trigger between enabled and disabled states.
Enable
Enable trigger
Disable
Disable trigger
TouchTest  (in all games since Source 2007)
Triggers either the OnTouching or OnNotTouching outputs for whether anything is touching this entity.
Icon-Bug.pngBug:Sleeping prop_physics will never fire "OnTouching". Also applies to entities using prop_physics as base.  (tested in: Half-Life 2)
StartTouch  (in all games since Source 2007) !FGD
Behave as if the !caller entity had just entered the trigger volume. Accepts non-physical entities.
EndTouch  (in all games since Source 2007) !FGD
Behave as if !caller had just exited the trigger volume.
DisableAndEndTouch  (only in Source 2013 MultiplayerTeam Fortress 2 branch)
Disables this trigger and calls EndTouch on all currently-touching entities.

Outputs

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.pngNote:Will also fire for entities touching it when trigger is disabled via Disable input
Warning.pngWarning:This includes entities which are deleted while inside the trigger. In this case !activator will be invalid.
Warning.pngWarning:OnEndTouch can fire before OnStartTouch under certain circumstances[How?] where both are fired on the same tick and each have the same delay.
Note.pngFix: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 Source 2007)
!activator = !caller = this entity
Fired if something is currently touching this trigger when TouchTest is fired.
OnNotTouching  (in all games since Source 2007)
!activator = !caller = this entity
Fired if nothing is currently touching this trigger when TouchTest is fired.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Trigger_soundscape&oldid=151981"