ambient_generic

From Valve Developer Community
Jump to: navigation, search
ambient_generic
EnglishFrançaisРусский简体中文
ambient_generic
Ambient generic.png
TypePoint entity
EngineGoldSrc Source Source 2
AvailabilityIn all games
 
Todo: The deprecated template {{Base point}}, {{Point ent}} or {{Tf2 point}} (and similar) was used. Use {{Entity}} instead.

ambient_generic is a point entity available in all Source Source games.

This entity plays a sound, either once or on loop and either from a location in the world or globally. Use it to play and control a soundscript sound, a raw .wav sample, or a scripted_sentence.

class hierarchy
CAmbientGeneric defined in ambientgeneric.cpp
CPointEntity
CBaseEntity
Tip.png Tip: This entity can be parented if the parentname keyvalue or SetParent input is used, even though they aren't listed in the FGD.
Bug.png Bug: ambient_generics used to play looping sounds in Counter-Strike: Source Counter-Strike: Source must be activated with a logic_auto, or they will stop playing once the first round starts.
Bug.png Bug: The ambient_generic will not update its position while the sound is playing if it is parented.
Bug.png Bug: Killing this entity while a looped sound is playing will make it play forever for the entire map duration. This also may cause looping sounds to stack up and eventually overflow the sound limit (detailed blow), even if they aren't audible.
Cpp-16px.png Code Fix: Problems with sounds being unstoppable can be avoided by adding this C++ code to your mod.
Bug.png Bug: Looping sounds might become attached to certain players when they are not supposed to. E.g., if you are away from a sound, and a player near the sound dies and then spectates you, the sound may become attached to you. The exact consistency/behavior of this bug is still unknown.
Bug.png Bug: Too many ambient_generics playing at once will cause the sound engine to become corrupted globally and potentially cause extreme lag! This occurs if the internal entity sound limit of 64 (32 in Counter-Strike: Global Offensive) is hit. Due to another bug, ambient_generics still "play" when outside the maximum distance, even if not audible to the client.
Placementtip.gif Workaround: Use env_soundscapes (which count towards a different static limit of 64) where possible and forcefully disable any sounds that aren't necessary to play yet. The amount of sounds currently playing can be visualized with the snd_show command.
Bug.png Bug: Looping sounds using LFO cannot be stopped via the StopSound input.
Note.png Note: The behavior of sound is different for mono and stereo. Stereo sounds only fade in and out (they are already using surrounding information built into them). Mono sounds are processed by the audio engine to sound like they are coming from a specific position.
Warning.png Warning: Using the Soundscript name of a sound, as opposed to its "raw" audio file, will apply all the soundscript settings.
Example: In Left 4 Dead 2 Left 4 Dead 2, the soundscript of dlc.Generator_start_run_loop is set to play everywhere but at lower volume even if "Play everywhere" is not set. But using its raw sound Generator_start_run_loop.wav works as intended.

Keyvalues

Sound Name (message) <string>
The soundscript name of, or direct path to, the sound to play. For scripted_sentences, type "!" followed by the sentence name. (Example: !COMBINE_THROW_GRENADE4)
Note.png Note: Playing music without a soundscript is not recommended due to a bug with the Play Everywhere flag.
Note.png Note: Using any sound characters in a direct path is, in a way, a soundscript.
Max Audible Distance (radius) <float>
Maximum distance in units at which the sound plays for a client.
Bug.png Bug: The sound still actually plays outside the distance.
Bug.png Bug: Sounds may still be audible far outside the distance due to DSP.
Note.png Note: Volume fades to nothing as the player approaches this distance, which can make it seem as if the sound stops playing too early.
SourceEntityName (SourceEntityName) <targetname>
If specified, the sound will play from this entity instead of the ambient_generic. If the target is an NPC capable of lipsynching, and phoneme data is found within the sound, the target will lip-sync to it.
Bug.png Bug: If the ambient_generic is Killed, the sound will play at the origin of the map (at 0,0,0).
Bug.png Bug: The entity must be spawned at map start, or else the sound will play at the location of the ambient_generic.
Bug.png Bug: Using AddOutput to assign the SourceEntityName after the entity spawns does not work.
Bug.png Bug: Multiple ambient_generics won't stack on the same entity.
Note.png Note: An ambient_generic will only play from a single entity. If there are multiple entities with the same target name, the sound will only play from the first one it finds.
Confirm:is this all games? only tested in Team Fortress 2.
Volume (health) <integer 0–10>
How loud to play the sound. 0 is silent and 10 is normal. Default is 10.
Tip.png Tip: This keyvalue doesn't allow decimals, but the Volume input does.
Bug.png Bug: The sound does not play at all if the volume is 0.
Start Volume (volstart) <integer 0–10>
Fade in time in seconds (fadeinsecs) <integer 0–100>
Fade out time in seconds (fadeoutsecs) <integer 0–100>
How long to spend fading in and out, and what volume to start at. Default is no fading.
Pitch (pitch) <integer 0–255>
Pitch, where 1 is low, 100 is normal, and 255 is high.
Bug.png Bug: Very high or very low values can cause other sounds to be distorted.
Start pitch (pitchstart) <integer 0–255>
Spin up time (spinup) <integer 0–100>
Spin down time (spindown) <integer 0–100>
How long to spend spinning pitch up/down at the start/end of playback, and what pitch to start at. Default is no spinning.
Dynamic Presets (preset) <choices>
Various DSP effects that can be applied.
LFO type (lfotype) <integer>
Type of Low Frequency Oscillation to employ.
0. Off (default)
1. Square Wave (alternate between low and high)
2. Triangle Wave (crossfade between high and low)
3. Random
LFO rate (lforate) <integer 0–1000>
How frequently the LFO effect repeats itself.
LFO modulation - pitch (lfomodpitch) <integer 0–100>
Affects the sound pitch or vibrato. Higher numbers change the pitch more; warbling singers use little, police sirens use a lot.
LFO modulation - volume (lfomodvol) <integer 0–100>
Affects the volume of the sound, causing it to "pulse." Similar to tremolo. At a really high rate, this can make the same effect as talking through fan blades.
Incremental Spinup Count (cspinup) <integer>
Appears to be a intended to increase pitch in time with ToggleSound inputs.
Bug.png Bug: Non-functional.

Targetname:
Name (targetname) <string>
The targetname that other entities refer to this entity by.

Flags

  •  [1] : Play everywhere
       Sound plays at a constant volume, no matter how far away the listener is from the sound source.To do: How does this interact with env_microphone sound detection?}
    Bug.png Bug: This flag is broken at engine level for sounds played from Soundscripts. It will only work when a sound is played with its raw filename.
  •  [16] : Start Silent
       The map will start without this sound playing. Enabled by default.
    Bug.png Bug: Looping sounds that do not start silent cannot be controlled!
  •  [32] : Is NOT Looped
       Changes how the ambient_generic handles stopping and starting playback. It won't stop a sound that loops from looping, but it is still very important to set it to the right value. You might not be able to stop and/or start the sound if it isn't!
    Bug.png Bug: Having this option ticked while using a looped sound WILL prevent you from controlling it!

Inputs

Pitch <integer>
Sets the sound pitch, expressed as a range from 1 to 255, where 100 is the sound's original pitch.
Bug.png Bug: Pitch will play the sound without informing the rest of the entity. This makes looping sounds unstoppable!.
PlaySound
Starts the sound.
StopSound
Stops a looping sound. Does not stop a non-looping sound; however, a non-looping sound can be stopped by using the Volume input with a value of 0.
Cpp-16px.png Code Fix: If necessary, you can allow this input to stop a non-looping sound via C++.
ToggleSound
Toggles a looping sound between playing and stopped. Behaves like PlaySound if the sound doesn't loop.
Volume <float>
Plays the sound at a volume from 0 to 10, where 10 is the loudest.
Bug.png Bug: Volume will play the sound without informing the rest of the entity. This makes looping sounds unstoppable! It is speculated that the input is supposed to change the volume at which the ambient_generic plays its sound when prompted by other inputs, not play it by itself.
Note.png Note: Setting the volume to 0 will cause the sound to pause, rather than play silently.
FadeIn <integer>
Fades the sound up to full volume over a specified number of seconds, with a range from 0 to 100 seconds.
Bug.png Bug: Non-functional outside of Portal 2 Portal 2.
FadeOut <integer>
Fades the sound to silence over a specified number of seconds, with a range from 0 to 100 seconds.
Bug.png Bug: Will bring the sound up to full volume (i.e., 10) before beginning to fade it.

See Also