getAllEnv3DSoundControllers: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|seealso= *\[\[([^ ]+)\]\], \[\[([^ ]+)\]\]" to "|seealso= $1 $2")
m (Fix's fix)
 
(6 intermediate revisions by the same user not shown)
Line 3: Line 3:
|game1= arma3
|game1= arma3
|version1= 2.08
|version1= 2.08
|branch= dev


|gr1= Sounds
|gr1= Sounds


|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.
|descr= Returns an array containing the names and values of environmental 3D sound controllers, variables that can be used in simple expressions when configuring sounds.
{{Feature | Important | The names of controllers are case sensitive }}
{{Feature|important|
{{Feature | Important | Please note that the name for the wind param for 3D controller is 'wind'. 'windy' is the name for 2D controller [[getAllEnvSoundControllers]]}}
* Controller names are case sensitive
* Wind param difference:
** {{hl|wind}} is for '''3D''' controller
** {{hl|wind'''y'''}} is for '''2D''' controller ([[getAllEnvSoundControllers]])
}}


|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:
Line 34: Line 37:
* {{hl|"ambientTemp"}}
* {{hl|"ambientTemp"}}
* {{hl|"snow"}}
* {{hl|"snow"}}
|shrink= y
}}
}}


|x1= <code>[[getAllEnv3DSoundControllers]] _thatTreeOverThere;
|x1= <sqf>
{{codecomment|/*
getAllEnv3DSoundControllers _thatTreeOverThere;
/*
returns e.g
returns e.g
[
[
Line 46: Line 49:
...
...
]
]
<nowiki/>*/}}</code>
*/
</sqf>


|seealso= [[getAllEnvSoundControllers]] [[getEnv3DSoundController]] [[allEnv3DSoundSources]] [[selectBestPlaces]] [[getSoundController]] [[getSoundControllerResult]] [[getEnvSoundController]] [[getAllSoundControllers]] [[getCustomSoundController]] [[setCustomSoundController]] [[getCustomSoundControllerCount]] [[Arma 3: Sound]]
|seealso= [[getAllEnvSoundControllers]] [[getEnv3DSoundController]] [[allEnv3DSoundSources]] [[selectBestPlaces]] [[getSoundController]] [[getSoundControllerResult]] [[getEnvSoundController]] [[getAllSoundControllers]] [[getCustomSoundController]] [[setCustomSoundController]] [[getCustomSoundControllerCount]] [[Arma 3: Sound]]
}}
}}

Latest revision as of 15:12, 30 September 2024

Hover & click on the images for description

Description

Description:
Returns an array containing the names and values of environmental 3D 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