This article's documentation is for anything that uses the Source engine. Click here for more information.

ambient_fmod

From Valve Developer Community
Jump to navigation Jump to search
English (en)Translate (Translate)

ambient_fmod is a point entity available in No More Room in Hell No More Room in Hell.

Entity Description

The ambient_fmod is a point entity that shares a lot in common with ambient_generic, as it serves as a replacement thanks to the FMOD audio engine featured in No More Room in Hell. While I cannot comprehensively summarise all the differences and similarities, it should perform similarly in function.

KeyValues

Name (targetname) <string>
The name that other entities refer to this entity by.
Entity Scripts (vscripts) <string>
Name(s) of script files that are executed after all entities have spawned.
Script think function (thinkfunction) <string>
Name of a function in this entity's script scope which will be called automatically.
Parent (parentname) <string>
The name of this entity's parent in the movement hierarchy. Entities with parents move with their parent.
Sound Name (message) <string>
Name of the GameSound entry for the sound to play. Also supports direct filenames. Supported formats: AIFF, ASF, ASX, DLS, FLAC, FSB, IT, M3U, MIDI, MOD, MP2, MP3, OGG, PLS, S3M, WAV, WAX, WMA, XM
Volume (volume) <float>
Sound volume, expressed as a range from 0.0 to 10.0, where 10.0 is the loudest.
Max Audible Distance (radius) <integer>
Maximum distance at which this sound is audible.
SourceEntityName (SourceEntityName) <string>
If an entity is specified, sound will come from this named entity instead of the location of ambient_fmod.

Flags

Play Everywhere : [1]
Audio can be heard everywhere.
Start Silent : [16]
Starts off silent.
Is NOT Looped : [32]
Chosen Audio file is not looped.
Music (Uses the music volume slider) : [64]
Treat Audio file as if it was music. Respects music volume.
Is NOT Occluded (Obstructions won't muffle sound) : [128]
Chosen Audio file will not be affected by sound muffling by walls.

Inputs

PlaySound
Starts the sound.
StopSound
Stops the sound if it is playing.
ToggleSound
Toggles the sound.
SetVolume
Sets the sound volume, expressed as a range from 0.0 to 10.0, where 10.0 is the loudest.
IncreaseVolume
Increases the volume by the specified amount. If this result is greater than the maximum volume, the volume will be set to maximum.
DecreaseVolume
Decreases the volume by the specified amount. If this result is less than the minimum volume, the volume will be set to 0 or silent.

Outputs

OnUser1 to OnUser4
Fired in response to the FireUser inputs.