getAllEnvSoundControllers: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<dl class="command_description"> <dt></dt>" to "<dl class="command_description"> <dt></dt>")
m (Some wiki formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma3
|game1= arma3
 
|version1= 1.64
|1.64


|gr1= Sounds
|gr1= Sounds


| Returns an array containing the names and values of environmental variables that can be used in simple expressions when configuring sounds.
|descr= Returns an array containing the names and values of environmental variables that can be used in simple expressions when configuring sounds.
 
| '''getAllEnvSoundControllers''' position
|p1= position: [[Position]].
|r1= [[Array]] - [<nowiki/>["controllerA", valueA], ["controllerB", valueB], ...]


|x1= <code>[[getAllEnvSoundControllers]] [[position]] [[player]];</code>
|s1= [[getAllEnvSoundControllers]] position
<pre>Result:
[["rain",0],["night",0],["wind",0.161588],...]
</pre>


|[[selectBestPlaces]], [[getSoundController]], [[getSoundControllerResult]], [[getEnvSoundController]], [[getAllSoundControllers]], [[getCustomSoundController]], [[setCustomSoundController]], [[getCustomSoundControllerCount]] , [[Arma 3: Sound]]
|p1= position: [[Position]]
}}


{{GameCategory|arma3|Scripting Commands}}
|r1= [[Array]] in format [<nowiki/>["controllerA", valueA], ["controllerB", valueB], ...], controllers being, in order:
* "rain"
* "night"
* "wind"
* "daytime"
* "meadows"
* "trees"
* "houses"
* "forest"
* "sea"
* "coast"
* "altitudeGround"
* "altitudeSea"
* "shooting"
* "deadbody"
* "fog"


<dl class="command_description">
|x1= <code>[[getAllEnvSoundControllers]] [[position]] [[player]];
{{codecomment|/*
returns e.g
[
["rain",0],
["night",0],
["wind",0.161588],
...
]
<nowiki/>*/}}</code>


<dt></dt>
|seealso= [[selectBestPlaces]], [[getSoundController]], [[getSoundControllerResult]], [[getEnvSoundController]], [[getAllSoundControllers]], [[getCustomSoundController]], [[setCustomSoundController]], [[getCustomSoundControllerCount]], [[Arma 3: Sound]]
<dd class="notedate">Posted on March 25, 2018 - 17:49 (UTC)</dd>
}}
<dt class="note">[[User:Tankbuster|Tankbuster]]</dt>
<dd class="note">
This command will return data on the following attributes;
rain, night, wind, daytime, meadows, trees, houses, forest, sea, coast, altitudeGround. alititudeSea, shooting, deadbody and fog
</dd>
</dl>

Revision as of 19:21, 12 June 2021

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 variables that can be used in simple expressions when configuring sounds.
Groups:
Sounds

Syntax

Syntax:
getAllEnvSoundControllers position
Parameters:
position: Position
Return Value:
Array in format [["controllerA", valueA], ["controllerB", valueB], ...], controllers being, in order:
  • "rain"
  • "night"
  • "wind"
  • "daytime"
  • "meadows"
  • "trees"
  • "houses"
  • "forest"
  • "sea"
  • "coast"
  • "altitudeGround"
  • "altitudeSea"
  • "shooting"
  • "deadbody"
  • "fog"

Examples

Example 1:
getAllEnvSoundControllers position player; /* returns e.g [ ["rain",0], ["night",0], ["wind",0.161588], ... ] */

Additional Information

See also:
selectBestPlacesgetSoundControllergetSoundControllerResultgetEnvSoundControllergetAllSoundControllersgetCustomSoundControllersetCustomSoundControllergetCustomSoundControllerCountArma 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=269790"