getAllEnv3DSoundControllers: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Some wiki formatting)
(14 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 2D 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
Line 17: Line 20:
|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:
{{Columns|3|
{{Columns|3|
* <tt>"rain"</tt>
* {{hl|"rain"}}
* <tt>"night"</tt>
* {{hl|"night"}}
* <tt>"wind"</tt>
* {{hl|"wind"}}
* <tt>"daytime"</tt>
* {{hl|"daytime"}}
* <tt>"distance"</tt>
* {{hl|"distance"}}
* <tt>"shooting"</tt>
* {{hl|"shooting"}}
* <tt>"meadows"</tt>
* {{hl|"meadows"}}
* <tt>"trees"</tt>
* {{hl|"trees"}}
* <tt>"houses"</tt>
* {{hl|"houses"}}
* <tt>"forest"</tt>
* {{hl|"forest"}}
* <tt>"sea"</tt>
* {{hl|"sea"}}
* <tt>"altitudeSea"</tt>
* {{hl|"altitudeSea"}}
* <tt>"altitudeGround"</tt>
* {{hl|"altitudeGround"}}
* <tt>"rainDrops"</tt>
* {{hl|"rainDrops"}}
* <tt>"yearTime"</tt>
* {{hl|"yearTime"}}
* <tt>"ambientTemp"</tt>
* {{hl|"ambientTemp"}}
* <tt>"snow"</tt>
* {{hl|"snow"}}
|shrink= y
|shrink= y
}}
}}


|x1= <code>[[getAllEnv3DSoundControllers]] _thatTreeOverThere;
|x1= <sqf>
{{codecomment|/*
getAllEnv3DSoundControllers _thatTreeOverThere;
/*
returns e.g
returns e.g
[
[
Line 46: Line 50:
...
...
]
]
<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]]
}}
}}

Revision as of 12:14, 3 May 2022

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