getAllEnvSoundControllers

From Bohemia Interactive Community
Revision as of 10:55, 28 October 2021 by Killzone Kid (talk | contribs)
Jump to navigation Jump to search
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.
The names of controllers are case sensitive
Please note that the name for the wind param for 2D controller is 'windy'. 'wind' is the name for 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"
  • "yearTime"     (since Arma 3 v2.07.148385)
  • "ambientTemp"     (since Arma 3 v2.07.148385)
  • "snow"     (since Arma 3 v2.07.148385)

Examples

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

Additional Information

See also:
getAllEnv3DSoundControllersgetEnv3DSoundControllerallEnv3DSoundSourcesselectBestPlacesgetSoundControllergetSoundControllerResultgetEnvSoundControllergetAllSoundControllersgetCustomSoundControllersetCustomSoundControllergetCustomSoundControllerCountArma 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