getCustomSoundController: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Arma 3 ([^ACHJKLMTZ|])([^|]+)\]\]" to "Arma 3: $1$2")
m (Text replacement - "\] +\[" to "] [")
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma3
|game1= arma3
 
|version1= 1.86
|1.85


|gr1= Sounds
|gr1= Sounds


| Returns current value set to the controller (see [[setCustomSoundController]])
|descr= Returns current value set to the controller (see [[setCustomSoundController]]).


| '''getCustomSoundController''' [vehicle, controller]
|s1= [[getCustomSoundController]] [vehicle, controller]


|p1 = vehicle: [[Object]] - must be a transport type vehicle (doesn't work on characters or buildings)
|p1= vehicle: [[Object]] - a transport type vehicle. Does not work on characters or buildings


|p2 = controller: [[String]] - name of custom sound controller. Need to be full string like i.e. "CustomSoundController1". Currently you can pick from "CustomSoundController1" to "CustomSoundController32"
|p2= controller: [[String]] - name of custom sound controller - needs to be full string e.g "CustomSoundController1". It goes from "CustomSoundController1" to "CustomSoundController32"
| [[Number]]
|x1 = <code>[[getCustomSoundController]] [<nowiki/>[[vehicle]] [[player]], "CustomSoundController1"];</code>
|seealso= [[Arma 3: Sound]], [[setCustomSoundController]], [[getCustomSoundControllerCount]], [[getSoundController]], [[getSoundControllerResult]], [[getAllSoundControllers]], [[getEnvSoundController]], [[getAllEnvSoundControllers]]
}}


<dl class="command_description">
|r1= [[Number]]


|x1= <sqf>getCustomSoundController [vehicle player, "CustomSoundController1"];</sqf>


|x2= <sqf>
private _allCustomSoundControllers = [];
for "_i" from 1 to (getCustomSoundControllerCount vehicle player) do
{
_allCustomSoundControllers pushBack getCustomSoundController [vehicle player, format ["CustomSoundController%1", _i]];
};
</sqf>


{{GameCategory|arma3|Scripting Commands}}
|seealso= [[Arma 3: Sound]] [[setCustomSoundController]] [[getCustomSoundControllerCount]] [[getSoundController]] [[getSoundControllerResult]] [[getAllSoundControllers]] [[getEnvSoundController]] [[getAllEnvSoundControllers]]
}}

Latest revision as of 11:46, 5 May 2024

Arma 3 logo black.png1.86
Hover & click on the images for description

Description

Description:
Returns current value set to the controller (see setCustomSoundController).
Groups:
Sounds

Syntax

Syntax:
getCustomSoundController [vehicle, controller]
Parameters:
vehicle: Object - a transport type vehicle. Does not work on characters or buildings
controller: String - name of custom sound controller - needs to be full string e.g "CustomSoundController1". It goes from "CustomSoundController1" to "CustomSoundController32"
Return Value:
Number

Examples

Example 1:
getCustomSoundController [vehicle player, "CustomSoundController1"];
Example 2:
private _allCustomSoundControllers = []; for "_i" from 1 to (getCustomSoundControllerCount vehicle player) do { _allCustomSoundControllers pushBack getCustomSoundController [vehicle player, format ["CustomSoundController%1", _i]]; };

Additional Information

See also:
Arma 3: Sound setCustomSoundController getCustomSoundControllerCount getSoundController getSoundControllerResult getAllSoundControllers getEnvSoundController getAllEnvSoundControllers

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=getCustomSoundController&oldid=364165"