This article's documentation is for anything that uses the Source engine. Click here for more information.

trigger_soundscape

From Valve Developer Community
Jump to navigation Jump to search
English (en)Translate (Translate)
Class hierarchy
CTriggerSoundscape
CBaseTrigger
CBaseToggle
CBaseEntity
soundscape.cpp
Toolstrigger.gif

trigger_soundscape is a brush entity available in all Source Source games. It automatically triggers an env_soundscape_triggerable whenever a player is inside its volume and not triggering any other soundscape entities. Something to take into consideration is that env_soundscape_triggerable will still act like regular env_soundscape which means it can be activated when getting into its line of sight and specified radius, so it should be placed somewhere out of reach of the player if this behavior is undesired.


Icon-Important.pngImportant:This is a preserved entity in Counter-Strike: SourceHalf-Life 2: DeathmatchDay of Defeat: SourcePortalTeam Fortress 2Left 4 DeadLeft 4 Dead 2Portal 2Counter-Strike: Global Offensive.
  • On a new round entities with this classname will intentionally not reset. You can use logic_auto to emulate resetting it.
  • Killing it removes it forever, as it is not respawned on a new round.
  • It cannot be spawned with a point_template.
  • Parenting this with non preserved entities may have undesirable effects.
Warning.pngWarning:This entity has special check if dead players or spectators are touching it. For living players this entity's brush model is used to determine if they are touching it, but for dead players or spectators AABB is used and they can also trigger outputs if some were specified. See lazy brush entities and the picture there.

Keyvalues

Soundscape (soundscape) <targetname>
The targetname of the env_soundscape_triggerable that this brush triggers.
Warning.pngRisk of Confusion:Not to be confused with the actual soundscape that the env_soundscape_triggerable then plays.
Warning.pngWarning:Player touching this trigger in its enabled state is all that matters for specified env_soundscape_triggerable to be activated. Filters or flags are ignored.
StartDisabled (StartDisabled) <boolean>
If true starts disabled

Inputs

Enable / Disable / Toggle
Enables, disables or toggles the trigger. Act of disabling it doesn't end the soundscape if it's already playing.
Icon-Important.pngImportant:Make sure to take into consideration that this is preserved entity so the effect of enabling or disabling will carry over during restart


Warning.pngWarning:As this entity is derived from CBaseTrigger it has regular trigger properties available. Filters and flags work on outputs but because this is a preserved entity and the filters are not, the filter will be lost upon round restart and not set up again. Another issue is dead players and spectator being able to trigger the outputs. Therefore it's not advised to be used for outputs as regular triggers are available.

See also