getAllEnvSoundControllers: Difference between revisions

Latest revision as of 17:06, 17 April 2023

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"
2.08 "yearTime"
2.08 "ambientTemp"
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

@@ Line 7: / Line 7: @@
 |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 | The names of controllers are case sensitive }}
+{{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]].
+}}
 |s1= [[getAllEnvSoundControllers]] position
@@ Line 15: / Line 18: @@
 |r1= [[Array]] in format [<nowiki/>["controllerA", valueA], ["controllerB", valueB], ...], controllers being, in order:
 {{Columns|3|
-* <tt>"rain"</tt>
+* {{hl|"rain"}}
-* <tt>"night"</tt>
+* {{hl|"night"}}
-* <tt>"windy"</tt>
+* {{hl|"windy"}}
-* <tt>"daytime"</tt>
+* {{hl|"daytime"}}
-* <tt>"meadows"</tt>
+* {{hl|"meadows"}}
-* <tt>"trees"</tt>
+* {{hl|"trees"}}
-* <tt>"houses"</tt>
+* {{hl|"houses"}}
-* <tt>"forest"</tt>
+* {{hl|"forest"}}
-* <tt>"sea"</tt>
+* {{hl|"sea"}}
-* <tt>"coast"</tt>
+* {{hl|"coast"}}
-* <tt>"altitudeGround"</tt>
+* {{hl|"altitudeGround"}}
-* <tt>"altitudeSea"</tt>
+* {{hl|"altitudeSea"}}
-* <tt>"shooting"</tt>
+* {{hl|"shooting"}}
-* <tt>"deadbody"</tt>
+* {{hl|"deadbody"}}
-* <tt>"fog"</tt>
+* {{hl|"fog"}}
-* <tt>"yearTime"</tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;''(since Arma 3 v2.07.148385)''
+* {{GVI|arma3|2.08|size= 0.75}} {{hl|"yearTime"}}
-* <tt>"ambientTemp"</tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;''(since Arma 3 v2.07.148385)''
+* {{GVI|arma3|2.08|size= 0.75}} {{hl|"ambientTemp"}}
-* <tt>"snow"</tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;''(since Arma 3 v2.07.148385)''
+* {{GVI|arma3|2.08|size= 0.75}} {{hl|"snow"}}
-|shrink= y
 }}
-|x1= <code>[[getAllEnvSoundControllers]] [[position]] [[player]];
+|x1= <sqf>
-{{codecomment|/*
+getAllEnvSoundControllers position player;
+/*
 	returns e.g
 	[
 		["rain",0],
 		["night",0],
-		["wind",0.161588],
+		["windy",0.161588],
 		...
 	]
-<nowiki/>*/}}</code>
+*/
+</sqf>
-|seealso= [[selectBestPlaces]], [[getSoundController]], [[getSoundControllerResult]], [[getEnvSoundController]], [[getAllSoundControllers]], [[getCustomSoundController]], [[setCustomSoundController]], [[getCustomSoundControllerCount]], [[Arma 3: Sound]]
+|seealso= [[getAllEnv3DSoundControllers]] [[getEnv3DSoundController]] [[allEnv3DSoundSources]] [[selectBestPlaces]] [[getSoundController]] [[getSoundControllerResult]] [[getEnvSoundController]] [[getAllSoundControllers]] [[getCustomSoundController]] [[setCustomSoundController]] [[getCustomSoundControllerCount]] [[Arma 3: Sound]]
 }}