db_audiere_sound

From Valve Developer Community
Jump to: navigation, search


Entity Description

Db audiere sound.png
Plays a sound like the ambient_generic but with a different sound library: Audiere. This is useful for looping map music and playing sounds that play through the map exit, such as victory sounds. All sounds will play everywhere.

Keyvalues

  • Name
The name that other entities refer to this entity by.
  • Sound File
Path to sound file. Supported types: OGG, MP3, WAVE and FLAC. Note when you browse and select a sound it will look like for example: 'FX/ball_fx1.wav'. You must add a 'sound/' prefix to the file path, like so: 'sound/FX/ball_fx1.wav'. Also note for OGG and FLAC files you must manually type the file path in the Sound File field as the Hammer Sound Browser only shows MP3 and WAVE.
  • Volume
Volume (set between 0 and 1.0)

Inputs

  • Targetname:

Kill
Removes this entity from the world.
KillHierarchy
Removes this entity and its children from the world.
Note:Entities already remove orphaned children upon being removed, but this input removes all children on the same frame, being marginally faster than Kill.
AddOutput <string>
Adds a keyvalue/output to this entity. It can be potentially very dangerous, use with care.
KV Format: <key> <value>
I/O Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>
FireUser1 to FireUser4
Fire the OnUser outputs; see User Inputs and Outputs.
Use  !FGD
Same as a player invoking +use; may not do anything depending on the entity. Can also be invoked by firing an output that does not specify an input.
RunScriptFile <script> (in all games since <Left 4 Dead 2>)
Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode <string> (in all games since <Left 4 Dead 2>)
Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console.
Bug: In <Left 4 Dead 2>, the code is executed in the script scope of the entity that fires the output, not the one receiving the input.
Warning: Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.
CallScriptFunction <string> (in all games since <Left 4 Dead 2>) !FGD
Execute a VScript function in the scope of the receiving entity.
SetLocalOrigin <coordinates> (in all games since <Alien Swarm>) !FGD
Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.
SetLocalAngles <angles> (in all games since <Alien Swarm>) !FGD
Set this entity's angles.
  • PlaySound
Starts the sound.
  • StopSound
Stops the sound.

Outputs

Fired in response to FireUser1-4 inputs. See User Inputs and Outputs.

Flags

  • 1 - Start Active
  • 2 - Loop Sound
  • 4 - Stop sound on map exit (otherwise sound will still play through the menu)

See also