getAllEnvSoundControllers: Difference between revisions

From Bohemia Interactive Community
(array of arrays)
m (Some wiki formatting)
 
(52 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 the names and values of environmental variables that can be used in simple expressions when configuring sounds.|DESCRIPTION=
|descr= Returns an array containing the names and values of environmental 2D sound controllers, variables that can be used in simple expressions when configuring sounds.
____________________________________________________________________________________________
{{Feature|important|
* Controller names are case sensitive
* Please note that the name for the wind param for '''2D''' controller is 'windy', 'wind' being the name for the '''3D''' controller [[getAllEnv3DSoundControllers]].
}}


| '''getAllEnvSoundControllers''' position |SYNTAX=
|s1= [[getAllEnvSoundControllers]] position
|p1 = position: [[Position]].|=
| [[Array]] - [["controllerA", valueA], ["controllerB", valueB], ...] |RETURNVALUE=
____________________________________________________________________________________________
|x1 = <code>[[getAllEnvSoundControllers]] [[position]] [[player]];</code>
<pre>Result:
[["rain",0],["night",0],["wind",0.161588],...]
</pre> |EXAMPLE1=


|p1= position: [[Position]]


|[[selectBestPlaces]], [[getSoundController]], [[getSoundControllerResult]], [[getEnvSoundController]], [[getAllSoundControllers]], [[getCustomSoundController]], [[setCustomSoundController]], [[getCustomSoundControllerCount]] , [[Arma 3 Sound]]  |SEEALSO=
|r1= [[Array]] in format [<nowiki/>["controllerA", valueA], ["controllerB", valueB], ...], controllers being, in order:
{{Columns|3|
* {{hl|"rain"}}
* {{hl|"night"}}
* {{hl|"windy"}}
* {{hl|"daytime"}}
* {{hl|"meadows"}}
* {{hl|"trees"}}
* {{hl|"houses"}}
* {{hl|"forest"}}
* {{hl|"sea"}}
* {{hl|"coast"}}
* {{hl|"altitudeGround"}}
* {{hl|"altitudeSea"}}
* {{hl|"shooting"}}
* {{hl|"deadbody"}}
* {{hl|"fog"}}
* {{GVI|arma3|2.08|size= 0.75}} {{hl|"yearTime"}}
* {{GVI|arma3|2.08|size= 0.75}} {{hl|"ambientTemp"}}
* {{GVI|arma3|2.08|size= 0.75}} {{hl|"snow"}}
}}
}}


<h3 style="display:none">Notes</h3>
|x1= <sqf>
<dl class="command_description">
getAllEnvSoundControllers position player;
/*
returns e.g
[
["rain",0],
["night",0],
["windy",0.161588],
...
]
*/
</sqf>


 
|seealso= [[getAllEnv3DSoundControllers]] [[getEnv3DSoundController]] [[allEnv3DSoundSources]] [[selectBestPlaces]] [[getSoundController]] [[getSoundControllerResult]] [[getEnvSoundController]] [[getAllSoundControllers]] [[getCustomSoundController]] [[setCustomSoundController]] [[getCustomSoundControllerCount]] [[Arma 3: Sound]]
<h3 style="display:none">Bottom Section</h3>
}}
[[Category:Scripting Commands|getAllEnvSoundControllers]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on March 25, 2018 - 17:49 (UTC)</dd>
<dt class="note">[[User:Tankbuster|Tankbuster]]</dt>
<dd class="note">
This command will return data on the following attributes;
rain, night, wind, daytime, meadows, trees, houses, forest, sea, coast, altitudeGround. alititudeSea, shooting, deadbody and fog
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 16:06, 17 April 2023

Arma 3 logo black.png 1.64
Hover & click on the images for description

Description

Description:
Returns an array containing the names and values of environmental 2D sound controllers, variables that can be used in simple expressions when configuring sounds.
⚠
  • Controller names are case sensitive
  • Please note that the name for the wind param for 2D controller is 'windy', 'wind' being the name for the 3D controller getAllEnv3DSoundControllers.
Groups:
Sounds

Syntax

Syntax:
getAllEnvSoundControllers position
Parameters:
position: Position
Return Value:
Array in format [["controllerA", valueA], ["controllerB", valueB], ...], controllers being, in order:
  • "rain"
  • "night"
  • "windy"
  • "daytime"
  • "meadows"
  • "trees"
  • "houses"
  • "forest"
  • "sea"
  • "coast"
  • "altitudeGround"
  • "altitudeSea"
  • "shooting"
  • "deadbody"
  • "fog"
  • Arma 3 logo black.png 2.08 "yearTime"
  • Arma 3 logo black.png 2.08 "ambientTemp"
  • Arma 3 logo black.png 2.08 "snow"

Examples

Example 1:
getAllEnvSoundControllers position player; /* returns e.g [ ["rain",0], ["night",0], ["windy",0.161588], ... ] */

Additional Information

See also:
getAllEnv3DSoundControllers getEnv3DSoundController allEnv3DSoundSources selectBestPlaces getSoundController getSoundControllerResult getEnvSoundController getAllSoundControllers getCustomSoundController setCustomSoundController getCustomSoundControllerCount Arma 3: Sound

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=getAllEnvSoundControllers&oldid=338912"