View source for Env soundscape

{{LanguageBar}}
{{tabsBar|main=Env soundscape}}
{{CD|CEnvSoundscape|file1=soundscape.cpp}}
{{this is a|point entity|sprite=1|name=env_soundscape}} It changes the active [[soundscape]] of players, and defines where positioned sounds within it play from. A player must be within the entity's radius and be able to see it for the change to take place. The entity's soundscape will then play until another one takes over. If more than one soundscape entity is fighting for control, the nearest wins.
{{toc-right}}
{{PreservedEnt|env_soundscape}}

{{ent|env_soundscape_triggerable}} is a related entity identical to env_soundscape, but for use in conjunction with the brush entity {{ent|trigger_soundscape}}.

{{tip|In some games such as {{tf2|2}}, soundscape entities cannot be "seen" through water, in which case a [[env_soundscape_triggerable|triggerable]] soundscape is a useful workaround.}}
{{warning|This entity counts an [[edict]] in {{src13}} games (except {{tf2|2}}), inheriting the [[CPointEntity]] base class. In later branches{{which}} it is a server-only entity, inheriting the [[CServerOnlyEntity]] base class.}}
{{altnames|game={{hls|2}} and {{hldms|2}}|name1=env_sound|misc=<br>See [[List of HL:S Soundscapes]] for which soundscapes correspond to which {{goldsrc|2}} [[env_sound]] values.}}
==Keyvalues==
{{KV Targetname}}
{{KV|Radius|intn=radius|int|Defines the entity's sphere of influence. Players must also have [[LOS]] to the entity for it to trigger. -1 means infinite range.}}
{{KV|Soundscape|intn=soundscape|string|The name of the soundscape to play. Some examples are provided, but the actual list is not. The best way to browse soundscapes is from within the game with the <code>playsoundscape</code> console command.}}
{{KV|Sound Position 0|intn=position0|to=Sound Position 7|intn2=position7|targetname|Entities which define the location from which any positioned sounds play. Must be entities that the [[client]] knows about (e.g {{ent|info_target}} or anything visible).}}
:{{Confirm|What happens if a targetname used for sound position is used by multiple entities? Does it play from all of them, or the first one found?}}
{{KV EnableDisable}}

==Inputs==
{{IO|ToggleEnabled|Toggle the soundscape on/off.}}
{{I EnableDisable}}

==Outputs==
{{IO|OnPlay|Fired when this soundscape becomes the active one.}}

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

[[Category:Sound System]]