getAllEnv3DSoundControllers: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *E([a-z])" to "$1 - e$2")
Line 16: Line 16:
|s1= [[getAllEnv3DSoundControllers]] object
|s1= [[getAllEnv3DSoundControllers]] object


|p1= object: [[Object]] - Environmental sound source like a tree or a house, see [[allEnv3DSoundSources]]
|p1= object: [[Object]] - environmental sound source like a tree or a house, see [[allEnv3DSoundSources]]


|r1= [[Array]] in format [<nowiki/>["controllerA", valueA], ["controllerB", valueB], ...], controllers being, in order:
|r1= [[Array]] in format [<nowiki/>["controllerA", valueA], ["controllerB", valueB], ...], controllers being, in order:

Revision as of 14:06, 8 November 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
  • Wind param difference:
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:
getAllEnvSoundControllers 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