getAllEnvSoundControllers: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|seealso= *\[\[([^ ]+)\]\], \[\[([^ ]+)\]\]" to "|seealso= $1 $2")
m (Some wiki formatting)
 
(6 intermediate revisions by the same user not shown)
Line 7: Line 7:


|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 2D controller is 'windy'. 'wind' is the name for 3D controller [[getAllEnv3DSoundControllers]]}}
* 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]].
}}


|s1= [[getAllEnvSoundControllers]] position
|s1= [[getAllEnvSoundControllers]] position
Line 31: Line 33:
* {{hl|"deadbody"}}
* {{hl|"deadbody"}}
* {{hl|"fog"}}
* {{hl|"fog"}}
* {{hl|"yearTime"}}     ''(since Arma 3 v2.07.148385)''
* {{GVI|arma3|2.08|size= 0.75}} {{hl|"yearTime"}}
* {{hl|"ambientTemp"}}     ''(since Arma 3 v2.07.148385)''
* {{GVI|arma3|2.08|size= 0.75}} {{hl|"ambientTemp"}}
* {{hl|"snow"}}     ''(since Arma 3 v2.07.148385)''
* {{GVI|arma3|2.08|size= 0.75}} {{hl|"snow"}}
|shrink= y
}}
}}


|x1= <code>[[getAllEnvSoundControllers]] [[position]] [[player]];
|x1= <sqf>
{{codecomment|/*
getAllEnvSoundControllers position player;
/*
returns e.g
returns e.g
[
[
Line 46: Line 48:
...
...
]
]
<nowiki/>*/}}</code>
*/
</sqf>


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

Latest revision as of 16:06, 17 April 2023

Arma 3 logo black.png1.64
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
Retrieved from "https://community.bistudio.com/wiki?title=getAllEnvSoundControllers&oldid=338912"