Sound
Playing and stopping sound tags, looping sounds, music and the mixer classes.
- Functions
- 39
- Work in this build
- 29
- Compiled out
- 10
39 names
- sound_class_debug_sound_start
- sound_class_enable_ducker
- sound_class_set_gain
- sound_class_set_gain_db
- sound_class_show_channel
- sound_disable_acoustic_palette
- sound_enable_acoustic_palette
- sound_impulse_language_time
- sound_impulse_mark_as_outro
- sound_impulse_predict
- sound_impulse_start
- sound_impulse_start_3d
- sound_impulse_start_3d_editor
- sound_impulse_start_cinematic
- sound_impulse_start_editor
- sound_impulse_start_effect
- sound_impulse_start_effect_editor
- sound_impulse_start_naked
- sound_impulse_start_with_subtitle
- sound_impulse_stop
- sound_impulse_time
- sound_impulse_trigger
- sound_loop_spam
- sound_looping_activate_layer
- sound_looping_deactivate_layer
- sound_looping_predict
- sound_looping_resume
- sound_looping_set_alternate
- sound_looping_set_scale
- sound_looping_start
- sound_looping_start_editor
- sound_looping_start_with_effect
- sound_looping_stop
- sound_looping_stop_immediately
- sound_preload_dialogue_sounds
- sound_start_global_effect
- sound_start_timed_global_effect
- sound_stop_global_effect
- sound_suppress_ambience_update_on_revert
sound_class_debug_sound_start
compiled outNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_class_debug_sound_start <string> <boolean>) | void | 1163 |
sound_class_enable_ducker
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_class_enable_ducker <string> <boolean>) | void | 1167 |
console: sound_class_enable_ducker <string> <boolean>
sound_class_set_gain
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_class_set_gain <string> <real> <short>) | void | 1165 |
console: sound_class_set_gain <string> <real> <short>
sound_class_set_gain_db
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_class_set_gain_db <string> <real> <short>) | void | 1166 |
console: sound_class_set_gain_db <string> <real> <short>
sound_class_show_channel
compiled outNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_class_show_channel <string> <boolean>) | void | 1162 |
sound_disable_acoustic_palette
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_disable_acoustic_palette <string_id>) | void | 1172 |
console: sound_disable_acoustic_palette <string_id>
sound_enable_acoustic_palette
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_enable_acoustic_palette <string_id>) | void | 1171 |
console: sound_enable_acoustic_palette <string_id>
sound_impulse_language_time
→ longNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_impulse_language_time <sound>) | long | 1144 |
console: sound_impulse_language_time <sound>
Called 15 times by the shipped campaign scripts, with 1 argument.
sound_impulse_mark_as_outro
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_impulse_mark_as_outro <sound>) | void | 1147 |
console: sound_impulse_mark_as_outro <sound>
sound_impulse_predict
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_impulse_predict <sound>) | void | 1136 |
console: sound_impulse_predict <sound>
sound_impulse_start
Plays a sound tag at an object, at the given volume.
| Signature | Returns | Slot |
|---|---|---|
| (sound_impulse_start <sound> <object> <real>) | void | 1138 |
console: sound_impulse_start <sound> <object> <real>
Called 204 times by the shipped campaign scripts, with 3 arguments.
sound_impulse_start_3d
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_impulse_start_3d <sound> <real> <real>) | void | 1146 |
console: sound_impulse_start_3d <sound> <real> <real>
sound_impulse_start_3d_editor
compiled outNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_impulse_start_3d_editor <sound> <real> <real>) | void | 1571 |
sound_impulse_start_cinematic
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_impulse_start_cinematic <sound> <object> <real> <real> <real>) | void | 1139 |
console: sound_impulse_start_cinematic <sound> <object> <real> <real> <real>
sound_impulse_start_editor
compiled outNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_impulse_start_editor <sound> <object> <real>) | void | 1569 |
sound_impulse_start_effect
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_impulse_start_effect <sound> <object> <real> <string_id>) | void | 1140 |
console: sound_impulse_start_effect <sound> <object> <real> <string_id>
sound_impulse_start_effect_editor
compiled outNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_impulse_start_effect_editor <sound> <object> <real> <string_id>) | void | 1570 |
sound_impulse_start_naked
compiled outNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_impulse_start_naked <sound> <string_id> <string_id>) | void | 1148 |
sound_impulse_start_with_subtitle
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_impulse_start_with_subtitle <sound> <object> <real> <string_id> <string_id>) | void | 1141 |
console: sound_impulse_start_with_subtitle <sound> <object> <real> <string_id> <string_id>
sound_impulse_stop
Stops a sound started with sound_impulse_start.
| Signature | Returns | Slot |
|---|---|---|
| (sound_impulse_stop <sound>) | void | 1145 |
console: sound_impulse_stop <sound>
Called 2 times by the shipped campaign scripts, with 1 argument.
sound_impulse_time
2 overloads→ longNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_impulse_time <sound>) | long | 1142 |
| (sound_impulse_time <sound> <long>) | long | 1143 |
console: sound_impulse_time <sound>
Called 13 times by the shipped campaign scripts, with 1 argument.
sound_impulse_trigger
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_impulse_trigger <sound> <object> <real> <long>) | void | 1137 |
console: sound_impulse_trigger <sound> <object> <real> <long>
sound_loop_spam
compiled outNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_loop_spam) | void | 1160 |
sound_looping_activate_layer
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_looping_activate_layer <looping_sound> <long>) | void | 1158 |
console: sound_looping_activate_layer <looping_sound> <long>
sound_looping_deactivate_layer
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_looping_deactivate_layer <looping_sound> <long>) | void | 1159 |
console: sound_looping_deactivate_layer <looping_sound> <long>
sound_looping_predict
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_looping_predict <looping_sound>) | void | 1150 |
console: sound_looping_predict <looping_sound>
sound_looping_resume
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_looping_resume <looping_sound> <object> <real>) | void | 1153 |
console: sound_looping_resume <looping_sound> <object> <real>
sound_looping_set_alternate
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_looping_set_alternate <looping_sound> <boolean>) | void | 1157 |
console: sound_looping_set_alternate <looping_sound> <boolean>
sound_looping_set_scale
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_looping_set_scale <looping_sound> <real>) | void | 1156 |
console: sound_looping_set_scale <looping_sound> <real>
sound_looping_start
Starts a looping sound at an object, at the given volume.
| Signature | Returns | Slot |
|---|---|---|
| (sound_looping_start <looping_sound> <object> <real>) | void | 1152 |
console: sound_looping_start <looping_sound> <object> <real>
sound_looping_start_editor
compiled outNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_looping_start_editor <looping_sound> <object> <real>) | void | 1572 |
sound_looping_start_with_effect
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_looping_start_with_effect <looping_sound> <object> <real> <string_id>) | void | 1151 |
console: sound_looping_start_with_effect <looping_sound> <object> <real> <string_id>
sound_looping_stop
Stops a looping sound.
| Signature | Returns | Slot |
|---|---|---|
| (sound_looping_stop <looping_sound>) | void | 1154 |
console: sound_looping_stop <looping_sound>
sound_looping_stop_immediately
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_looping_stop_immediately <looping_sound>) | void | 1155 |
console: sound_looping_stop_immediately <looping_sound>
sound_preload_dialogue_sounds
compiled outNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_preload_dialogue_sounds <string>) | void | 1149 |
sound_start_global_effect
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_start_global_effect <string_id> <real>) | void | 1168 |
console: sound_start_global_effect <string_id> <real>
sound_start_timed_global_effect
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_start_timed_global_effect <string_id> <real> <real>) | void | 1169 |
console: sound_start_timed_global_effect <string_id> <real> <real>
sound_stop_global_effect
No description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_stop_global_effect <string_id>) | void | 1170 |
console: sound_stop_global_effect <string_id>
sound_suppress_ambience_update_on_revert
compiled outNo description yet; the release build dropped the engine's help text.
| Signature | Returns | Slot |
|---|---|---|
| (sound_suppress_ambience_update_on_revert) | void | 1403 |
Read from the function table in the shipped simulation DLL. A name is compiled out when every one of its slots points at the release build's shared stub evaluator; the console still accepts it and returns nothing. Descriptions are hand-written and incomplete; the engine's own help text does not survive in this build. See The Blam console for how the table was found and how the mod runs these.