Cleanup is going to take awhile, so the site is back up but editing has been disabled.

Env soundscape

From HalfLife 2 Knowledge Base

Jump to: navigation, search

Contents

env_soundscape

Source(core) Point Entity


description

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.


properties

  • 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)
    • 0 - No
    • 1 - Yes
  • Radius radius(integer) - default: 128
    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) - default: The name of the soundscape to use. Corresponds to an entry in the soundscapes*.txt file in the hl2\scripts directory.
    Nothing
    • "Nothing" - Nothing
    • "Automatic" - Automatic
    • "Automatic_Dialog" - Automatic (dialog)
    • "GenericIndoor" - Indoor
    • "GenericOutdoor" - Outdoor
  • Sound Position 0 position0(target_destination)
    A sound position that will be referenced inside the soundscape text file. Usually used to position a set of sounds within the world.
  • Sound Position 1 position1(target_destination)
    A sound position that will be referenced inside the soundscape text file. Usually used to position a set of sounds within the world.
  • Sound Position 2 position2(target_destination)
    A sound position that will be referenced inside the soundscape text file. Usually used to position a set of sounds within the world.
  • Sound Position 3 position3(target_destination)
    A sound position that will be referenced inside the soundscape text file. Usually used to position a set of sounds within the world.
  • Sound Position 4 position4(target_destination)
    A sound position that will be referenced inside the soundscape text file. Usually used to position a set of sounds within the world.
  • Sound Position 5 position5(target_destination)
    A sound position that will be referenced inside the soundscape text file. Usually used to position a set of sounds within the world.
  • Sound Position 6 position6(target_destination)
    A sound position that will be referenced inside the soundscape text file. Usually used to position a set of sounds within the world.
  • Sound Position 7 position7(target_destination)
    A sound position that will be referenced inside the soundscape text file. Usually used to position a set of sounds within the world.


spawn flags

none.


inputs

  • Kill(void)
    Removes this entity from the world.
  • KillHierarchy(void)
    Removes this entity and all its children from the world.
  • AddOutput(string)
    Adds an entity I/O connection to this entity. Format
  • FireUser1(void)
    Causes this entity's OnUser1 output to be fired.
  • FireUser2(void)
    Causes this entity's OnUser2 output to be fired.
  • FireUser3(void)
    Causes this entity's OnUser3 output to be fired.
  • FireUser4(void)
    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 it's parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment.
  • ClearParent(void)
    Removes this entity from the the movement hierarchy, leaving it free to move independently.
  • Enable(void)
    Enable the soundscape.
  • Disabled(void)
    Disable the soundscape.
  • ToggleEnabled(void)
    Toggle the soundscape enabled state.

outputs

  • OnUser1(void)
    Fired in response to FireUser1 input.
  • OnUser2(void)
    Fired in response to FireUser2 input.
  • OnUser3(void)
    Fired in response to FireUser3 input.
  • OnUser4(void)
    Fired in response to FireUser4 input.
  • OnPlay(void)
    Fired when this soundscape becomes the active one.

related tutorials

Submit your tutorial for env_soundscape

Personal tools