Env soundscape: Difference between revisions
Jump to navigation
Jump to search
m (→Keyvalues: Shortened) |
m (Fixed up things, adding some stuff, and generally did things I can't remember.) |
||
| Line 5: | Line 5: | ||
==Keyvalues== | ==Keyvalues== | ||
* {{kv targetname}} | |||
*{{kv targetname}} | * {{kv parentname}} | ||
*{{kv parentname}} | * {{kv enabledisable}} | ||
*{{kv enabledisable}} | * '''radius''' | ||
*'''radius''' | : <integer> Radius - If set to <code>-1</code>, then the player can hear the soundscape as long as he can see it (regardless of distance to it). | ||
:<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''' | ||
: <string> The name of the soundscape to use. Corresponds to an entry in the | : <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 | |||
|} | |||
* '''position''0-7''''' | * '''position''0-7''''' | ||
:<target_destination> 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. | ||
<!--This entity doesn't have any flags.--> | |||
==Inputs== | ==Inputs== | ||
* {{i targetname}} | * {{i targetname}} | ||
* {{i parentname}} | * {{i parentname}} | ||
* {{i enabledisable}} | * {{i enabledisable}} | ||
* '''Disabled''' | |||
: {{todo|Write description. (It's not a typo - both ''Disable'' and ''Disabled'' exists.)}} | |||
* '''ToggleEnabled''' | * '''ToggleEnabled''' | ||
: Toggle the soundscape enabled state. | : Toggle the soundscape enabled state. | ||
==Outputs== | ==Outputs== | ||
* {{o targetname}} | * {{o targetname}} | ||
* '''OnPlay''' | * '''OnPlay''' | ||
| Line 40: | Line 44: | ||
==See Also== | ==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. | ||
* [[List of CS:S Soundscapes]] - a list of soundscapes available for [[Counter-Strike: Source]]. | * [[List of CS:S Soundscapes]] - a list of soundscapes available for [[Counter-Strike: Source]]. | ||
Revision as of 01:32, 12 April 2006
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.
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.
- List of CS:S Soundscapes - a list of soundscapes available for Counter-Strike: Source.
- List of DoD:S Soundscapes - a list of soundscapes available for Day of Defeat: Source.
- List of HL2 Soundscapes - a list of soundscapes available for Half-Life 2.
- ambient_generic - an entity used for playing individual sounds at specific locations, usually intentionally triggered.