getAudioOptionVolumes: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Some wiki formatting)
 
(35 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|=
{{RV|type=command
____________________________________________________________________________________________


| arma3dev |Game=
|game1= arma3
|version1= 1.94


|1.93|Game Version =(number surrounded by NO SPACES)
|gr1= Sounds


|arg= |Multiplayer Arguments =("local" or "global")
|descr= Returns profile audio volumes.


|eff= |Multiplayer Effects =("local" or "global")
|s1= [[getAudioOptionVolumes]]


|exec= |Multiplayer Execution =("server" or empty)
|r1= [[Array]] of [[Number]]s - [effects, music, radio, von, UI, map], where:
____________________________________________________________________________________________
* effects: [[Number]] - fx volume factor
* music: [[Number]] - music volume factor
* radio: [[Number]] - speech volume factor
* von: [[Number]] - Voice over Network (VoN) volume factor
* {{GVI|arma3|2.10|size= 0.75}} UI: [[Number]] - UI volume factor
* {{GVI|arma3|2.12|size= 0.75}} map: [[Number]] - map volume factor


| Returns profile audio volumes in format [effects, music, radio, von]. |Description=
|x1= <sqf>getAudioOptionVolumes params ["_effects", "_music", "_radio", "_von", "_ui", "_map"];</sqf>
____________________________________________________________________________________________


| [[getAudioOptionVolumes]] |Syntax=
|seealso= [[getSubtitleOptions]] [[soundVolume]] [[musicVolume]] [[radioVolume]] [[setPlayerVoNVolume]] [[getPlayerVoNVolume]]
 
| [[Array]] - [effects, music, radio, von]| Return Value=
____________________________________________________________________________________________
 
|x1= <code>_volumeSettings = [[getAudioOptionVolumes]];</code> |Example 1=
____________________________________________________________________________________________
 
|mp= - |Multiplayer Behaviour=
 
| [[getSubtitleOptions]] [[soundVolume]] [[musicVolume]] [[radioVolume]] |See Also=
}}
}}
<dl class="command_description">
<!-- BEGIN Note Section -->
<!-- For example:
<dd class="notedate">Posted on Month Day, Year - Time (UTC)</dd>
<dt class="note">'''[[User:User Name|User Name]]'''</dt>
<dd class="note">This is an example note. It is true and verifiable, and contains a little code snippet.
<code>[[if]] ([[_this]] == anExample) [[then]] { [[hint]] "Leave it here for others to read"; };</code></dd>
-->
<!-- END Note Section -->
</dl>
<h3 style="display:none">Bottom Section</h3>
<!-- Appropriate categories go here -->
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 12:34, 18 January 2023

Arma 3 logo black.png1.94
Hover & click on the images for description

Description

Description:
Returns profile audio volumes.
Groups:
Sounds

Syntax

Syntax:
getAudioOptionVolumes
Return Value:
Array of Numbers - [effects, music, radio, von, UI, map], where:
  • effects: Number - fx volume factor
  • music: Number - music volume factor
  • radio: Number - speech volume factor
  • von: Number - Voice over Network (VoN) volume factor
  • Arma 3 logo black.png2.10 UI: Number - UI volume factor
  • Arma 3 logo black.png2.12 map: Number - map volume factor

Examples

Example 1:
getAudioOptionVolumes params ["_effects", "_music", "_radio", "_von", "_ui", "_map"];

Additional Information

See also:
getSubtitleOptions soundVolume musicVolume radioVolume setPlayerVoNVolume getPlayerVoNVolume

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Retrieved from "https://community.bistudio.com/wiki?title=getAudioOptionVolumes&oldid=337334"