getAllEnvSoundControllers: Difference between revisions

Latest revision as of 16: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 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma3dev |= Game name
+|game1= arma3
+|version1= 1.64
-|1.63|= Game version
+|gr1= Sounds
-____________________________________________________________________________________________
-| Returns [[Array]] of 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]] |= Return value
-____________________________________________________________________________________________
-|x1 = <code>[[getAllEnvSoundControllers]] [[position]] [[player]];</code>
-<pre>Result:
-[["rain",0],["night",0],["wind",0.161588],["daytime",0.500069],["distance",211.536],["meadows",0.788513],["trees",0.211487],["houses",0],["forest",0],["sea",0],["coast",0],["altitudeGround",0],["altitudeSea",0.746414],["shooting",1],["deadBody",0]]
-</pre> |= Example1
+|p1= position: [[Position]]
-| [[Arma_3_Sound]], [[getSoundController]], [[getSoundControllerResult]], [[getEnvSoundController]], [[getAllSoundControllers]]  |= See also
+|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"}}
+}}
+|x1= <sqf>
+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]]
 }}