getAllEnvSoundControllers

From Bohemia Interactive Community
Revision as of 16:06, 17 April 2023 by Lou Montana (talk | contribs) (Some wiki formatting)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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.
  • 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.png2.08 "yearTime"
  • Arma 3 logo black.png2.08 "ambientTemp"
  • Arma 3 logo black.png2.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