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

Ambient generic

From HalfLife 2 Knowledge Base

Jump to: navigation, search

Contents

ambient_generic

Source(core) Point Entity


description

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


properties

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


spawn flags

  • 1: Play everywhere - default: OFF
  • 16: Start Silent - default: ON
  • 32: Is NOT Looped - default: ON


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.
  • Pitch(integer)
    Sets the sound pitch, expressed as a range from 1 to 255, where 100 is the sound's default pitch.
  • PlaySound(void)
    Starts the sound.
  • StopSound(void)
    Stops the sound if it is playing.
  • ToggleSound(void)
    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

  • 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.


related tutorials

Submit your tutorial for ambient_generic

Personal tools