Ambient generic (GoldSrc): Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
(Added all keyvalues, flags and info. Removed stub tag.)
Line 1: Line 1:
{{stub}}
{{GoldSource base point|ambient_generic}}
{{HL1}} {{HL1:OP4}} {{HL1:BS}}
 
An '''ambient_Generic''' is a [[Point entity|point entity]] available in all GoldSource games.


==Description==
==Description==
An ambient_Generic is essentially an audio player, that plays a ''single'' specified sound within a given radius inside a map. Ambient_generics are used to create sound effects throughout a map, either playing the sound ''once'', or continually repeating the sound (''looping''). Ambient_generic audio comes from WAV files located in the games' ''Sound'' file directory. '''Example:''' ''\Half-Life\Valve\Sound\Barney\Hello.WAV''
An ambient_Generic is essentially an audio player, that plays a ''single'' specified sound within a given radius inside a map. Ambient_generics are used to create sound effects throughout a map, either playing the sound ''once'', or continually repeating the sound (''looping''). <code>ambient_generic</code> audio comes from WAV files located in the games' ''Sound'' file directory. '''Example:''' ''\Half-Life\Valve\Sound\Barney\Hello.WAV''


==Key Values==
==Key Values==
{{Hl1 kv targetname}}
{{ScrollBox|title=Universal Ambient|
; WAV Name <code><[[sound]]></code>
: The file name of the sound to play. Relative to the mod/sound folder, for instance: <code>anbience/techamb1.wav</code>
; Volume <code><[[integer]]></code>
: A number between 1 and 10. The sound emitted will be scaled by this number where 10 is the loudest and 1 is almost completely silent.
; Dynamic Presets <code><choices></code>
: Modifies the sound with various effects and reverbs.
:* 0 : "None"
:* 1 : "Huge Machine"
:* 2 : "Big Machine"
:* 3 : "Machine"
:* 4 : "Slow Fade in"
:* 5 : "Fade in"
:* 6 : "Quick Fade in"
:* 7 : "Slow Pulse"
:* 8 : "Pulse"
:* 9 : "Quick pulse"
:* 10 : "Slow Oscillator"
:* 11 : "Oscillator"
:* 12 : "Quick Oscillator"
:* 13 : "Grunge pitch"
:* 14 : "Very low pitch"
:* 15 : "Low pitch"
:* 16 : "High pitch"
:* 17 : "Very high pitch"
:* 18 : "Screaming pitch"
:* 19 : "Oscillate spinup/down"
:* 20 : "Pulse spinup/down"
:* 21 : "Random pitch"
:* 22 : "Random pitch fast"
:* 23 : "Incremental spinup"
:* 24 : "Alien"
:* 25 : "Bizzare"
:* 26 : "Planet X"
:* 27 : "Haunted"
; Start Volume <code><integer></code>
: The volume to start a fade in at if fadein time is specified.
; Fade in time <code><integer></code>
: Time to fully fade from start volume to volume.
; Fade out time <code><integer></code>
: Time to fully fade from volume to start volume.
; Pitch <code><integer></code>
: A number from 1-255 that modifies the pitch of the sound where 100 is normal pitch.
; Start Pitch <code><integer></code>
: The pitch to start a fade in at if fadein time is specified.
; Spin up time <code><integer></code>
: The time it takes for each incremental spinup if specified to be used.
; Spin down time <code><integer></code>
: The time it takes for each incremental spindown if specified to be used.
; LFO type <code><integer></code>
: 0)off 1)sqr 2)tri 3)rnd {{todo|Explain what this does.}}
; LFO rate <code><integer></code>
: {{todo|Add description}}
; LFO mod pitch <code><integer></code>
: {{todo|Add description}}
; LFO mod vol <code><integer></code>
: {{todo|Add description}}
; Incremental spinup count <code><integer></code>
: The amount of incremental spinups to do if specified to be used.}}
==Flags==
* 1 : "Play Everywhere"
* 2 : "Small Radius"
* 4 : "Medium Radius"
* 8 : "Large Radius"
* 16 : "Start Silent"
* 32 : "Not Toggled"
==See also==
[[ambient_generic]] (Source Engine)
[[Category:Half-Life]][[Category:Half-Life Entities|A]][[Category:Entities]]

Revision as of 08:28, 15 December 2015

Template:GoldSource base point

Description

An ambient_Generic is essentially an audio player, that plays a single specified sound within a given radius inside a map. Ambient_generics are used to create sound effects throughout a map, either playing the sound once, or continually repeating the sound (looping). ambient_generic audio comes from WAV files located in the games' Sound file directory. Example: \Half-Life\Valve\Sound\Barney\Hello.WAV

Key Values

Name (targetname) <string>
The targetname that other entities refer to this entity by.
Universal Ambient:
WAV Name <sound>
The file name of the sound to play. Relative to the mod/sound folder, for instance: anbience/techamb1.wav
Volume <integer>
A number between 1 and 10. The sound emitted will be scaled by this number where 10 is the loudest and 1 is almost completely silent.
Dynamic Presets <choices>
Modifies the sound with various effects and reverbs.
  • 0 : "None"
  • 1 : "Huge Machine"
  • 2 : "Big Machine"
  • 3 : "Machine"
  • 4 : "Slow Fade in"
  • 5 : "Fade in"
  • 6 : "Quick Fade in"
  • 7 : "Slow Pulse"
  • 8 : "Pulse"
  • 9 : "Quick pulse"
  • 10 : "Slow Oscillator"
  • 11 : "Oscillator"
  • 12 : "Quick Oscillator"
  • 13 : "Grunge pitch"
  • 14 : "Very low pitch"
  • 15 : "Low pitch"
  • 16 : "High pitch"
  • 17 : "Very high pitch"
  • 18 : "Screaming pitch"
  • 19 : "Oscillate spinup/down"
  • 20 : "Pulse spinup/down"
  • 21 : "Random pitch"
  • 22 : "Random pitch fast"
  • 23 : "Incremental spinup"
  • 24 : "Alien"
  • 25 : "Bizzare"
  • 26 : "Planet X"
  • 27 : "Haunted"
Start Volume <integer>
The volume to start a fade in at if fadein time is specified.
Fade in time <integer>
Time to fully fade from start volume to volume.
Fade out time <integer>
Time to fully fade from volume to start volume.
Pitch <integer>
A number from 1-255 that modifies the pitch of the sound where 100 is normal pitch.
Start Pitch <integer>
The pitch to start a fade in at if fadein time is specified.
Spin up time <integer>
The time it takes for each incremental spinup if specified to be used.
Spin down time <integer>
The time it takes for each incremental spindown if specified to be used.
LFO type <integer>
0)off 1)sqr 2)tri 3)rnd
Todo: Explain what this does.
LFO rate <integer>
Todo: Add description
LFO mod pitch <integer>
Todo: Add description
LFO mod vol <integer>
Todo: Add description
Incremental spinup count <integer>
The amount of incremental spinups to do if specified to be used.

Flags

  • 1 : "Play Everywhere"
  • 2 : "Small Radius"
  • 4 : "Medium Radius"
  • 8 : "Large Radius"
  • 16 : "Start Silent"
  • 32 : "Not Toggled"

See also

ambient_generic (Source Engine)

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Ambient_generic_(GoldSrc)&oldid=194630"