Env soundscape
Jump to navigation
Jump to search
Entity Description
Entity Name: env_soundscape
An entity to control sound in an area. The active soundscape at any time is the last one that had line-of-sight to the player, and was within the radius.
Entity Values
Keys
- Name targetname <target_source>
- The name that other entities refer to this entity by.
- Parent parentname <target_destination>
- The name of this entity's parent in the movement hierarchy. Entities with parents move with their parent.
- Start Disabled StartDisabled <choices>
- Radius radius <integer>
- If set to -1, then the player can hear the soundscape as long as he can see it (regardless of distance to it).
- Soundscape soundscape <choices>
- The name of the soundscape to use. Corresponds to an entry in the soundscapes*.txt file in the hl2acripts directory. See also Listing of HL2 Soundscapes.
- Sound Position 0 position0 <target_destination>
- Sound Position 1 position1 <target_destination>
- Sound Position 2 position2 <target_destination>
- Sound Position 3 position3 <target_destination>
- Sound Position 4 position4 <target_destination>
- Sound Position 5 position5 <target_destination>
- Sound Position 6 position6 <target_destination>
- Sound Position 7 position7 <target_destination>
- Sound positions that will be referenced inside the soundscape text file. Usually used to position a set of sounds within the world.
Inputs
- Kill
- Removes this entity from the world.
- KillHierarchy
- Removes this entity and all its children from the world.
- AddOutput <string>
- Adds an entity I/O connection to this entity. Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>. Very dangerous, use with care.
- FireUser1
- Causes this entity's OnUser1 output to be fired.
- FireUser2
- Causes this entity's OnUser2 output to be fired.
- FireUser3
- Causes this entity's OnUser3 output to be fired.
- FireUser4
- Causes this entity's OnUser4 output to be fired.
- SetParent <string>
- Changes the entity's parent in the movement hierarchy.
- SetParentAttachment <string>
- Change this entity to attach to a specific attachment point on its parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment.
- ClearParent
- Removes this entity from the the movement hierarchy, leaving it free to move independently.
- Enable
- Enable the soundscape.
- Disable
- Disable the soundscape.
- ToggleEnabled
- Toggle the soundscape enabled state.
Outputs
- OnUser1
- Fired in response to FireUser1 input.
- OnUser2
- Fired in response to FireUser2 input.
- OnUser3
- Fired in response to FireUser3 input.
- OnUser4
- Fired in response to FireUser4 input.
- OnPlay
- Fired when this soundscape becomes the active one.
See Also
- Soundscapes - describes how to define new soundscapes and has more information on the use of this entity.
- Listing of HL2 Soundscapes - a list of soundscapes available in Half-Life 2.
- ambient_generic - an entity used for playing individual sounds at specific locations, usually intentionally triggered.