Env soundscape triggerable: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Directed link.)
(Redirected page to Env soundscape)
Line 1: Line 1:
{{wrongtitle|title=env_soundscape_triggerable}}
#redirect [[env_soundscape]]
{{base_point}}[[Category:Sound System]]
{{in code|class=class_c_env_soundscape_triggerable.html CEnvSoundscapeTriggerable|file=soundscape_8cpp-source.html soundscape.cpp}}
 
==Entity Description==
[[Image:env_soundscape.png|left]]A point entity that works like the [[env_soundscape]] entity except that it works in conjunction with the [[trigger_soundscape]] entity to determine when a player hears it. In some mods such as TF2, soundscapes cannot be "seen" through water, in which case a triggerable soundscape is useful workaround.
 
{{note|This entity has the same keyvalues, (non-existant) flags, inputs, and outputs as [[env_soundscape]].}}
{{clr}}
 
 
==Keyvalues==
* {{KV Targetname}}
* {{KV Parentname with warning}}
* {{KV EnableDisable}}
* '''radius'''
: <integer> Radius - If set to <code>-1</code>, then the player can hear the soundscape as long as the entity has [[line of sight]] to him (regardless of distance to it).
* '''soundscape'''
: <string> Soundscape - The name of the soundscape to use. Corresponds to an entry in the ''soundscapes_*.txt'' file in the ''hl2/scripts'' directory (normally packed into the ''source engine.gcf'' file).
:{| class=standard-table
! Literal Value || Description
|-
| Nothing || Nothing
|-
| Automatic || Automatic
|-
| Automatic_Dialog || Automatic (dialog)
|-
| GenericIndoor || Indoor
|-
| GenericOutdoor || Outdoor
|}
* '''position''0-7'''''
: <target_destination> Sound Position ''0-7'' - Sound positions that will be referenced inside the soundscape text file. Usually used to position a set of sounds within the world.
 
<!--This entity doesn't have any flags.-->
==Inputs==
* {{I Targetname}}
* {{I Parentname}}
* {{I EnableDisable}}
* '''Disabled'''
: {{TODO|Write description. (It's not a typo - both ''Disable'' and ''Disabled'' exists.)}}
* '''ToggleEnabled'''
: Toggle the soundscape enabled state.
 
==Outputs==
* {{O Targetname}}
* '''OnPlay'''
: Fired when this soundscape becomes the active one.
 
 
== See also ==
 
* [[Soundscapes]]
* [[trigger_soundscape]]
* [[env_soundscape]]
* [[env_soundscape_proxy]]
* {{Soundscape lists}}

Revision as of 09:13, 29 May 2011

Redirect to:

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Env_soundscape_triggerable&oldid=151979"