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

env_soundscape_proxy

From Valve Developer Community
Jump to: navigation, search
Underlinked - Logo.png
This article needs more links to other articles to help integrate it into the encyclopedia. Please help improve this article by adding links that are relevant to the context within the existing text.
January 2024


English (en)
... Icon-Important.png
class hierarchy
CEnvSoundscapeProxy defined in soundscape.cpp
CEnvSoundscape
CServerOnlyEntity
CBaseEntity
Env soundscape.png

env_soundscape_proxy is a point entity available in all Source Source games. It plays a soundscape with the properties set by an env_soundscape or env_soundscape_triggerable. This is convenient for soundscapes that can be triggered through many possible entrances/exits as it prevents the mapper from having to synchronize settings for many individual entities.

Note.pngNote: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, its properties including its position 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


Targetname:
Name (targetname) <string>
The targetname that other entities refer to this entity by.
Soundscape entity (MainSoundscapeName) <targetname>
The soundscape entity to become a copy of.
Radius (radius) <float>
Defines the entity's sphere of influence. Players must also have LOS to the entity for it to trigger. -1 means infinite range. A note inside the FGD file says this does not work, but it does.

EnableDisable:

Start Disabled (StartDisabled) <boolean>
Stay dormant until activated (with theEnableinput).

Inputs

ToggleEnabled
Toggle the soundscape on/off.

EnableDisable:

Enable
Disable
Enable/disable this entity from performing its task. It might also disappear from view.

Outputs

OnPlay
Fired when this soundscape becomes the active one.