Env soundscape: Difference between revisions
Jump to navigation
Jump to search
(TF2 List added) |
m (minoro) |
||
| Line 1: | Line 1: | ||
{{wrongtitle|title=env_soundscape}} | {{wrongtitle|title=env_soundscape}} | ||
==Entity | == Entity description == | ||
[[Image:{{PAGENAME}}.png|left]]An entity to control sound in an area. Soundscapes can play a collection of sounds complete with timing and random selections, soundscapes can also apply effects like an echo to their sounds and any others played while they are active. The actual effects and sounds need to be defined [[Soundscapes|outside of Hammer]] but this entity is required to implement them. The active soundscape at any time is the last one that had line-of-sight to the player, and was within the radius. | [[Image:{{PAGENAME}}.png|left]]An entity to control sound in an area. Soundscapes can play a collection of sounds complete with timing and random selections, soundscapes can also apply effects like an echo to their sounds and any others played while they are active. The actual effects and sounds need to be defined [[Soundscapes|outside of Hammer]] but this entity is required to implement them. The active soundscape at any time is the last one that had line-of-sight to the player, and was within the radius. | ||
{{clr}} | {{clr}} | ||
==Keyvalues== | == Keyvalues == | ||
* {{kv targetname}} | * {{kv targetname}} | ||
* {{kv parentname}} | * {{kv parentname}} | ||
| Line 29: | Line 29: | ||
: <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. | : <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. | ||
== Inputs == | |||
==Inputs== | |||
* {{i targetname}} | * {{i targetname}} | ||
* {{i parentname}} | * {{i parentname}} | ||
| Line 39: | Line 38: | ||
: Toggle the soundscape enabled state. | : Toggle the soundscape enabled state. | ||
==Outputs== | == Outputs == | ||
* {{o targetname}} | * {{o targetname}} | ||
* '''OnPlay''' | * '''OnPlay''' | ||
: Fired when this soundscape becomes the active one. | : Fired when this soundscape becomes the active one. | ||
==See | == See also == | ||
* [[Soundscapes]] - describes how to define new soundscapes and has more information on the use of this entity. | * [[Soundscapes]] - describes how to define new soundscapes and has more information on the use of this entity. | ||
* [[Env_soundscape (prefab)]] - a prefab containing | * [[Env_soundscape (prefab)]] - a prefab containing basic soundscape setup. | ||
* [[List of CS:S Soundscapes | * Soundscape lists - [[List of CS:S Soundscapes|CS:S]], [[List of DoD:S Soundscapes|DoD:S]], [[List of HL2 Soundscapes|HL2]], [[List of TF2 Soundscapes|TF2]]. | ||
* [[ambient_generic]] - an entity used for playing individual sounds at specific locations, usually intentionally triggered. | * [[ambient_generic]] - an entity used for playing individual sounds at specific locations, usually intentionally triggered. | ||
[[Category:Entities]] | [[Category:Entities]] | ||
Revision as of 07:07, 18 November 2007
Entity description
An entity to control sound in an area. Soundscapes can play a collection of sounds complete with timing and random selections, soundscapes can also apply effects like an echo to their sounds and any others played while they are active. The actual effects and sounds need to be defined outside of Hammer but this entity is required to implement them. The active soundscape at any time is the last one that had line-of-sight to the player, and was within the radius.
Keyvalues
- <integer> Radius - If set to
-1, then the player can hear the soundscape as long as he can see it (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).
Literal Value Description Nothing Nothing Automatic Automatic Automatic_Dialog Automatic (dialog) GenericIndoor Indoor GenericOutdoor Outdoor
- position0-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.
Inputs
- Todo: Write description. (It's not a typo - both Disable and Disabled exists.)
- ToggleEnabled
- Toggle the soundscape enabled state.
Outputs
- Template:O targetname
- 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.
- Env_soundscape (prefab) - a prefab containing basic soundscape setup.
- Soundscape lists - CS:S, DoD:S, HL2, TF2.
- ambient_generic - an entity used for playing individual sounds at specific locations, usually intentionally triggered.