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

Trigger soundscape: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Underlinked|date=January 2024}}
{{LanguageBar}}
 
{{CD|CTriggerSoundscape|file1=soundscape.cpp}}
<!-- When this page is updated to {{langsp}} or {{language subpage}} instead of {{lang}}, please move {{this is a}} to the base page, as it is automatically translated. -->{{lang}}{{CD|CTriggerSoundscape|file1=soundscape.cpp}}
[[File:Toolstrigger.gif|left]]
[[File:Toolstrigger.gif|left]]
{{this is a|brush entity|name=trigger_soundscape}} It automatically triggers an {{ent|env_soundscape_triggerable}} whenever a player is inside its volume and not triggering any other soundscape entities.
{{this is a|brush entity|name=trigger_soundscape}} It automatically triggers an {{ent|env_soundscape_triggerable}} whenever a player is inside its volume and not triggering any other soundscape entities.
Line 7: Line 6:


== Keyvalues ==
== Keyvalues ==
{{KV|Soundscape|intn=soundscape|target|Targetname of the {{ent|env_soundscape_triggerable}} that this brush triggers. {{ModernConfusion|Not to be confused with the actual soundscape that the <tt>env_soundscape_triggerable</tt> then plays.}}}}
{{KV|Soundscape|intn=soundscape|target|'''Targetname''' of the {{ent|env_soundscape_triggerable}} that this brush triggers.  
{{KV|Filter Name|intn=filtername|filter|A filter entity to test potential [[activator]]s against.}}
:{{Confusion|Not to be confused with the actual soundscape that the <tt>env_soundscape_triggerable</tt> then plays.}}}}
:{{bug|Non-functional, will always trigger the soundscape and any [[outputs]].}}
{{KV|StartDisabled|intn=StartDisabled|boolean|If true starts disabled}}
::{{ModernConfirm|Which games does this apply to other than {{src13mp}}?}}
{{Warning|Doesn't use filters or flags to determine whether the soundscape should be activated or not. }}
 
== Inputs ==
{{I|Enable / Disable / Toggle|Enables, disables or toggles the trigger. Act of disabling it doesn't stop the soundscape from playing. (make sure to take into consideration that this is preserved entity)}}
 
{{note|As this entity is derived from CBaseTrigger it has [[CBaseTrigger|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 so it's not advised to be used for those purposes as regular triggers are available.}}


== See also ==
== See also ==
*[[Soundscape]]
* [[Soundscape]]
*{{ent|env_soundscape_triggerable}}
* {{ent|env_soundscape_triggerable}}


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

Revision as of 16:16, 1 October 2024

English (en)Translate (Translate)
C++ Class hierarchy
CTriggerSoundscape
CBaseTrigger
CBaseToggle
CBaseEntity
C++ 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.

Icon-Important.pngImportant:This is a preserved entity in Counter-Strike: SourceHalf-Life 2: DeathmatchDay of Defeat: SourceTeam Fortress 2Left 4 DeadLeft 4 Dead 2Portal 2Counter-Strike: Global Offensive.
If the game has round restart mechanics this entity may not behave as expected:
More info
  • 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.

Keyvalues

Soundscape (soundscape) <targetname>
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.
StartDisabled (StartDisabled) <boolean>
If true starts disabled
Warning.pngWarning:Doesn't use filters or flags to determine whether the soundscape should be activated or not.

Inputs

Enable / Disable / Toggle
Enables, disables or toggles the trigger. Act of disabling it doesn't stop the soundscape from playing. (make sure to take into consideration that this is preserved entity)
Note.pngNote: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 so it's not advised to be used for those purposes as regular triggers are available.

See also