getAllEnv3DSoundControllers

From Bohemia Interactive Community
Jump to navigation Jump to search
Hover & click on the images for description
Only available in Development branch(es) until its release with Arma 3 patch v2.08.

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 3D controller is 'wind'. 'windy' is the name for 2D controller getAllEnvSoundControllers
Groups:
Sounds

Syntax

Syntax:
getAllEnv3DSoundControllers object
Parameters:
object: Object - Environmental sound source like a tree or a house, see allEnv3DSoundSources
Return Value:
Array in format [["controllerA", valueA], ["controllerB", valueB], ...], controllers being, in order:
  • "rain"
  • "night"
  • "wind"
  • "daytime"
  • "distance"
  • "shooting"
  • "meadows"
  • "trees"
  • "houses"
  • "forest"
  • "sea"
  • "altitudeSea"
  • "altitudeGround"
  • "rainDrops"
  • "yearTime"
  • "ambientTemp"
  • "snow"

Examples

Example 1:
getAllEnv3DSoundControllers _thatTreeOverThere; /* returns e.g [ ["rain",0], ["night",0], ["wind",0.161588], ... ] */

Additional Information

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