Sounds
62 scripting commands. Also as Markdown for agents.
- addMusicEventHandlerAdds playMusic event handler. Returns id of the handler or -1 when failed. Like addMissionEventHandler, the music event handler is attached to the…
- allEnv3DSoundSourcesReturns all environmental 3D sound sources (Objects) like trees and houses in camera vicinity.
- commandChatTypes text to the command radio channel. The text will be visible only on the PC where command was executed. If you need the message to show on all…
- commandRadioSends the audio message to the command radio channel. The message is defined in CfgRadio in the description.ext file or config radio protocol. The…
- createSoundSourceCreates a sound source of the given type (type is the name of the subclass of CfgVehicles which is pointing to the sound defined in CfgSFX).
- createSoundSourceLocalSame as createSoundSource but with local effect - the created sound is not transferred to other clients.
- customRadioSends the message to the custom radio channel. The message is defined in the description.ext file or radio protocol.
- directSaySends given audio message to the direct channel. Command operates just like xxxxRadio commands, but the sound is played over direct channel and is…
- enableAudioFeatureGet the state of or enable/disable an audio feature. Available features are `"lowpass"` and `"building_interior"`. - Arma 3 v2.14 it is possible to…
- enableEnvironmentEnable/disable environmental effects: ambient life and/or ambient sound.
- enableRadioEnable and disable radio messages to be heard and shown in the left lower corner of the screen - the order-giving unit can still be heard…
- enableSentencesEnables radio transmissions to be heard and seen on screen. It does not affect KBTell conversations.
- environmentEnabledReturns status of enableEnvironment command
- environmentVolumeReturns the current environment volume (set by fadeEnvironment)
- fadeEnvironmentChanges the master environment volume smoothly within the given time and is different from enableEnvironment global mute option. The default volume…
- fadeMusicChanges the current music volume to the given value smoothly within the given time.
- fadeRadioChanges the radio volume smoothly within the given time.
- fadeSoundChanges the sound volume smoothly within the given time.
- fadeSpeechChanges the master speech volume smoothly within the given time. The default volume is 1.0.
- getAllEnv3DSoundControllersReturns an array containing the names and values of environmental 3D sound controllers, variables that can be used in simple expressions when…
- getAllEnvSoundControllersReturns an array containing the names and values of environmental 2D sound controllers, variables that can be used in simple expressions when…
- getAllSoundControllersReturns an array containing names and values of the sound controllers that can be used in simple expressions when configuring sounds.
- getAudioOptionVolumesReturns profile audio volumes.
- getCustomSoundControllerReturns current value set to the controller (see setCustomSoundController).
- getCustomSoundControllerCountReturns current number of custom sound controllers supported by the engine for the given vehicle (currently 32)
- getEnv3DSoundControllerReturns value of the specified 3D controller, see getAllEnv3DSoundControllers.
- getEnvSoundControllerReturns value of the specified controller, see getAllEnvSoundControllers
- getMusicPlayedTimeReturns elapsed time in seconds for currently playing music track.
- getSoundControllerReturns value of the given sound controller.
- getSoundControllerResultReturns the calculated value of simple expression defined in config. Config could be any config entry, even mission config entry. It is more…
- globalRadioSends the audio message to the global radio channel. The message is defined in CfgRadio in the description.ext file or config radio protocol. The…
- groupRadioSends the audio message to the group radio channel. The message is defined in CfgRadio in the description.ext file or config radio protocol.
- musicVolumeReturns the current music volume (set by fadeMusic)
- onBriefingGroupSelect a sound declared in the Description.ext of the mission to be played the first time the Group tab is selected in the briefing.
- onBriefingNotesSelect a sound declared in the Description.ext of the mission to be played the first time the Notes tab is selected in the briefing.
- onBriefingPlanSelect a sound declared in the Description.ext of the mission to be played the first time the Plan tab is selected in the briefing.
- onBriefingTeamSwitchSelect a sound defined in the CfgSounds of the mission to be played the first time the TeamSwitch tab is selected in the briefing.
- pitchReturns the pitch of a persons voice.
- playMusicPlays music defined in Description.ext's CfgMusic or config.cpp. If the *musicName* could not be found a message is logged into the .rpt file: `Music…
- playSoundPlays a sound from CfgSounds. Sound can be defined in missionConfigFile, configFile or campaignConfigFile.
- playSound3DPlays positional sound with given *filename* on every computer on network. To stop the sound use stopSound
- playSoundUIPlays given CfgSounds sound or a sound file given by file path through a dedicated UI sound channel unaffected by the global mixer volumes. If the…
- preloadSoundMakes sure that a sound can start playing without any delay once it is needed. Command works in Arma 3 but might not be implemented in earlier Arma…
- radioVolumeReturns the current radio volume (set by fadeRadio).
- removeAllMusicEventHandlersRemoves all music track event handlers of given type.
- removeMusicEventHandlerRemoves specified music track event handler. See Arma 3: Event Handlers#Music Event Handlers.
- sayMake unit say given sound. The sound is defined in CfgSounds. If the unit is a person, it will also perform the corresponding lipsync effect provided…
- say2DPlays given sound in 2D.
- say3DLets an object say given sound in 3D space. This allows broadcasting of positional music or sound from a source, without having to script a fade…
- setCustomSoundControllerSets value of the specified custom sound controller to be used in simple expressions in config.
- setMusicEffectDefines a music track played on activation. If another track is playing already, this will stop it and start the new track.
- setMusicEventHandlerSets given music track event handler. Will overwrite other music event handlers.
- setPitchSets the pitch of a persons voice.
- setSoundEffectDefines the different sound effects for a trigger or a waypoint. To stop any sound, deactivate the trigger (might take up to 0.5 seconds to stop) or…
- setSpeakerSets the speaker of a person.
- sideRadioSends the audio message to the side radio channel. The message is defined in CfgRadio in the description.ext file or config radio protocol. The…
- soundParamsReturns various params for the given sound. The sound has to be playing otherwise command returns empty array [].
- soundVolumeReturns the current sound volume (set by fadeSound).
- speakerReturns the speaker class name of a unit.
- speechVolumeReturns the current speech volume (set by fadeSpeech)
- stopSoundTerminates the given sound. If sound object provided, such as say3D and there is .lip file playback attached, this playback will also terminate.
- vehicleRadioSends the audio message to the vehicle radio channel. The message is defined in CfgRadio in the description.ext file or config radio protocol. The…