getAllSoundControllers: Difference between revisions

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


| arma3 |= Game name
|game1= arma3
|version1= 1.64


|1.64|= Game version
|gr1= Sounds
____________________________________________________________________________________________


| Returns an array containing names and values of the sound controllers that can be used in simple expressions when configuring sounds.|DESCRIPTION=
|descr= Returns an array containing names and values of the sound controllers that can be used in simple expressions when configuring sounds.
____________________________________________________________________________________________


| '''getAllSoundControllers''' vehicle|SYNTAX=
|s1= [[getAllSoundControllers]] vehicle
|p1 = vehicle: [[Object]] - must be a vehicle (does not work on soldiers)|=
| [[Array]] - <nowiki>[</nowiki>["controllerA", valueA], ["controllerB", valueB], ...]|RETURNVALUE=
____________________________________________________________________________________________
|x1 = <code>[[getAllSoundControllers]] [[vehicle]] [[player]];</code>
<pre>Result: [["rpm",0],["randomizer",0.874332],["speed",0],["thrust",0],...]]
</pre> |EXAMPLE1=


| [[Arma 3 Sound]], [[getSoundController]], [[getSoundControllerResult]], [[getEnvSoundController]], [[getAllEnvSoundControllers]], [[getCustomSoundController]], [[setCustomSoundController]], [[getCustomSoundControllerCount]]  |SEEALSO=
|p1= vehicle: [[Object]] - a '''vehicle''' - this does not work on humans
 
|r1= [[Array]] in format [<nowiki/>["controllerA", valueA], ["controllerB", valueB], ...], controllers being, in order:
{{Columns|4|
* {{hl|"rpm"}}
* {{hl|"randomizer"}}
* {{hl|"speed"}}
* {{hl|"thrust"}}
* {{hl|"campos"}}
* {{hl|"engineon"}}
* {{hl|"rotorspeed"}}
* {{hl|"rotorthrust"}}
* {{hl|"angvelocity"}}
* {{hl|"gmeterz"}}
* {{hl|"roughness"}}
* {{hl|"dustness"}}
* {{hl|"damper0"}}
* {{hl|"damper1"}}
* {{hl|"damper2"}}
* {{hl|"damper3"}}
* {{hl|"rock"}}
* {{hl|"sand"}}
* {{hl|"grass"}}
* {{hl|"mud"}}
* {{hl|"gravel"}}
* {{hl|"asphalt"}}
* {{hl|"gear"}}
* {{hl|"flaps"}}
* {{hl|"rotpos"}}
* {{hl|"water"}}
* {{hl|"apu"}}
* {{hl|"batteries"}}
* {{hl|"rpmstarter"}}
* {{hl|"rpm1"}}
* {{hl|"rpmstarter1"}}
* {{hl|"motordamage"}}
* {{hl|"transmissiondamage"}}
* {{hl|"rotorbrake"}}
* {{hl|"slingloadactive"}}
* {{hl|"latslip"}}
* {{hl|"latslipdrive"}}
* {{hl|"longslip"}}
* {{hl|"longslipdrive"}}
* {{hl|"scrubland"}}
* {{hl|"scrubobject"}}
* {{hl|"scrubtree"}}
* {{hl|"scrubbuilding"}}
* {{hl|"scrubarmor"}}
* {{hl|"engineeffectivity"}}
* {{hl|"rain"}}
* {{hl|"wind"}}
* {{hl|"lateralmovement"}}
* {{hl|"playerpos"}}
* {{hl|"rotordamage"}}
* {{hl|"distance"}}
* {{hl|"machcone"}}
* {{hl|"camint"}}
* {{hl|"camext"}}
* {{hl|"houses"}}
* {{hl|"meadow"}}
* {{hl|"forest"}}
* {{hl|"trees"}}
* {{hl|"altRadar"}}
* {{hl|"acceleration"}}
* {{hl|"CustomSoundController1"}}
* {{hl|"CustomSoundController2"}}
* {{hl|"CustomSoundController3"}}
* {{hl|"CustomSoundController4"}}
* {{hl|"CustomSoundController5"}}
* {{hl|"CustomSoundController6"}}
* {{hl|"CustomSoundController7"}}
* {{hl|"CustomSoundController8"}}
* {{hl|"CustomSoundController9"}}
* {{hl|"CustomSoundController10"}}
* {{hl|"CustomSoundController11"}}
* {{hl|"CustomSoundController12"}}
* {{hl|"CustomSoundController13"}}
* {{hl|"CustomSoundController14"}}
* {{hl|"CustomSoundController15"}}
* {{hl|"CustomSoundController16"}}
* {{hl|"CustomSoundController17"}}
* {{hl|"CustomSoundController18"}}
* {{hl|"CustomSoundController19"}}
* {{hl|"CustomSoundController20"}}
* {{hl|"CustomSoundController21"}}
* {{hl|"CustomSoundController22"}}
* {{hl|"CustomSoundController23"}}
* {{hl|"CustomSoundController24"}}
* {{hl|"CustomSoundController25"}}
* {{hl|"CustomSoundController26"}}
* {{hl|"CustomSoundController27"}}
* {{hl|"CustomSoundController28"}}
* {{hl|"CustomSoundController29"}}
* {{hl|"CustomSoundController30"}}
* {{hl|"CustomSoundController31"}}
* {{hl|"CustomSoundController32"}}
}}
}}


<h3 style="display:none">Notes</h3>
|x1= <sqf>
<dl class="command_description">
getAllSoundControllers vehicle player;
/*
returns e.g
[
["rpm",0],
["randomizer",0.874332],
["speed",0],
["thrust",0],
...
]
*/
</sqf>


 
|seealso= [[Arma 3: Sound]] [[getSoundController]] [[getSoundControllerResult]] [[getEnvSoundController]] [[getAllEnvSoundControllers]] [[getCustomSoundController]] [[setCustomSoundController]] [[getCustomSoundControllerCount]]
<h3 style="display:none">Bottom Section</h3>
}}
[[Category:Scripting Commands|getAllSoundControllers]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]

Latest revision as of 16:18, 17 April 2023

Hover & click on the images for description

Description

Description:
Returns an array containing names and values of the sound controllers that can be used in simple expressions when configuring sounds.
Groups:
Sounds

Syntax

Syntax:
getAllSoundControllers vehicle
Parameters:
vehicle: Object - a vehicle - this does not work on humans
Return Value:
Array in format [["controllerA", valueA], ["controllerB", valueB], ...], controllers being, in order:
  • "rpm"
  • "randomizer"
  • "speed"
  • "thrust"
  • "campos"
  • "engineon"
  • "rotorspeed"
  • "rotorthrust"
  • "angvelocity"
  • "gmeterz"
  • "roughness"
  • "dustness"
  • "damper0"
  • "damper1"
  • "damper2"
  • "damper3"
  • "rock"
  • "sand"
  • "grass"
  • "mud"
  • "gravel"
  • "asphalt"
  • "gear"
  • "flaps"
  • "rotpos"
  • "water"
  • "apu"
  • "batteries"
  • "rpmstarter"
  • "rpm1"
  • "rpmstarter1"
  • "motordamage"
  • "transmissiondamage"
  • "rotorbrake"
  • "slingloadactive"
  • "latslip"
  • "latslipdrive"
  • "longslip"
  • "longslipdrive"
  • "scrubland"
  • "scrubobject"
  • "scrubtree"
  • "scrubbuilding"
  • "scrubarmor"
  • "engineeffectivity"
  • "rain"
  • "wind"
  • "lateralmovement"
  • "playerpos"
  • "rotordamage"
  • "distance"
  • "machcone"
  • "camint"
  • "camext"
  • "houses"
  • "meadow"
  • "forest"
  • "trees"
  • "altRadar"
  • "acceleration"
  • "CustomSoundController1"
  • "CustomSoundController2"
  • "CustomSoundController3"
  • "CustomSoundController4"
  • "CustomSoundController5"
  • "CustomSoundController6"
  • "CustomSoundController7"
  • "CustomSoundController8"
  • "CustomSoundController9"
  • "CustomSoundController10"
  • "CustomSoundController11"
  • "CustomSoundController12"
  • "CustomSoundController13"
  • "CustomSoundController14"
  • "CustomSoundController15"
  • "CustomSoundController16"
  • "CustomSoundController17"
  • "CustomSoundController18"
  • "CustomSoundController19"
  • "CustomSoundController20"
  • "CustomSoundController21"
  • "CustomSoundController22"
  • "CustomSoundController23"
  • "CustomSoundController24"
  • "CustomSoundController25"
  • "CustomSoundController26"
  • "CustomSoundController27"
  • "CustomSoundController28"
  • "CustomSoundController29"
  • "CustomSoundController30"
  • "CustomSoundController31"
  • "CustomSoundController32"

Examples

Example 1:
getAllSoundControllers vehicle player; /* returns e.g [ ["rpm",0], ["randomizer",0.874332], ["speed",0], ["thrust",0], ... ] */

Additional Information

See also:
Arma 3: Sound getSoundController getSoundControllerResult getEnvSoundController getAllEnvSoundControllers getCustomSoundController setCustomSoundController getCustomSoundControllerCount

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