Ambient generic: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Added numerical values to spawnflags)
m (→‎Flags: Described the practical use of the "Is NOT Looped" flag.)
Line 124: Line 124:
* 16: Start Silent
* 16: Start Silent


* 32: Is NOT Looped
* 32: Is NOT Looped - Can be repeatedly played using continuous ''PlaySound'' inputs. If not checked, a ''StopSound'' input is required to reset the sample before it can be played with another ''PlaySound'' input.


==Inputs==
==Inputs==

Revision as of 18:18, 26 March 2006

Template:Wrongtitle

Entity Description

Universal ambient sound. Use it to play and control a single sound.

Keyvalues

  • message
<sound> Name of the GameSound entry for the sound to play. Also supports direct .wav filenames.
  • health
<integer> Sound volume, expressed as a range from 0 to 10, where 10 is the loudest.
  • preset
<choices> Dynamic Preset
Literal Value Description
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
  • volstart
<integer> Start Volume
  • fadein
<integer> Fade in time (0-100)
  • fadeout
<integer> Fade out time (0-100)
  • pitch
<integer> Sound pitch, expressed as a range from 1 to 255, where 100 is the sound's default pitch.
  • pitchstart
<integer> Start pitch, expressed as a range from 1 to 255, where 100 is the sound's default pitch.
  • spinup
<integer> Spin up time (0-100)
  • spindown
<integer> Spin down time (0-100)
  • lfotype
<integer> LFO type 0)off 1)sqr 2)tri 3)rnd
  • lforate
<integer> LFO rate (0-1000)
  • lfomodpitch
<integer> LFO mod pitch (0-100)
  • lfomodvol
<integer> LFO mod vol (0-100)
  • cspinup
<integer> Incremental Spinup Count
  • radius
<string> Maximum distance at which this sound is audible.
  • SourceEntityName
<target_destination> If an entity is specified, sound will come from this named entity instead of the location of ambient_generic.

Flags

  • 1: Play everywhere
  • 16: Start Silent
  • 32: Is NOT Looped - Can be repeatedly played using continuous PlaySound inputs. If not checked, a StopSound input is required to reset the sample before it can be played with another PlaySound input.

Inputs

  • Pitch <integer>
Sets the sound pitch, expressed as a range from 1 to 255, where 100 is the sound's default pitch.
  • PlaySound
Starts the sound.
  • StopSound
Stops the sound if it is playing.
  • ToggleSound
Toggles the sound between playing and stopping.
  • Volume <integer>
Sets the sound volume, expressed as a range from 0 to 10, where 10 is the loudest.

Outputs

See Also