setCustomSoundController: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(format, not about case sensitivity)
m (Text replacement - " <nowiki>[</nowiki>" to " [<nowiki/>")
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{Command|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| arma3 |Game name=


|1.85|= Game version
|1.85|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| Sets value of the specified custom sound controller to be used in [[simple expression]]s. Returns [[true]] if value was set to the controller, [[false]] if command fails, for example if vehicle is not a transport or controller name is not recognised.<br><br>
| Sets value of the specified custom sound controller to be used in [[simple expression]]s in config. Returns [[true]] if value was set to the controller, [[false]] if command fails, for example if vehicle is not a transport or controller name is not recognised.<br><br>
{{Important | Custom sound controller name is <u>case sensitive</u> and of the following format:
{{Important | Custom sound controller name is <u>case sensitive</u> and of the following format:
<code>[[format]] ["CustomSoundController%1", _number]</code>
<code>[[format]] ["CustomSoundController%1", _number]</code>
Line 19: Line 19:
| [[Bool]] - [[true]] on success |Return value=
| [[Bool]] - [[true]] on success |Return value=
____________________________________________________________________________________________
____________________________________________________________________________________________
|x1 = Change value of CustomSoundController1 to 12<code>[[setCustomSoundController]] <nowiki>[</nowiki>[[vehicle]] [[player]], "CustomSoundController1", 12];</code>|EXAMPLE1=
|x1 = Change value of CustomSoundController1 to 12<code>[[setCustomSoundController]] [<nowiki/>[[vehicle]] [[player]], "CustomSoundController1", 12];</code>|EXAMPLE1=


____________________________________________________________________________________________
____________________________________________________________________________________________
| [[Arma 3 Sound]], [[getCustomSoundController]], [[getCustomSoundControllerCount]]  |SEEALSO=  
| [[Arma 3 Sound]], [[getCustomSoundController]], [[getCustomSoundControllerCount]], [[getSoundController]], [[getSoundControllerResult]], [[getAllSoundControllers]], [[getEnvSoundController]], [[getAllEnvSoundControllers]]  |SEEALSO=  
}}
}}



Revision as of 13:42, 19 March 2020

Hover & click on the images for description

Description

Description:
Sets value of the specified custom sound controller to be used in simple expressions in config. Returns true if value was set to the controller, false if command fails, for example if vehicle is not a transport or controller name is not recognised.

Custom sound controller name is case sensitive and of the following format:

format ["CustomSoundController%1", _number]

Where _number is a number from 1 to getCustomSoundControllerCount (currently 32)
Groups:
Uncategorised

Syntax

Syntax:
setCustomSoundController [vehicle, controller, value]
Parameters:
vehicle: Object - must be a transport type vehicle (doesn't work on characters or buildings)
controller: String - name of the custom sound controller. Need to be full string like i.e. "CustomSoundController1". Currently you can pick from "CustomSoundController1" to "CustomSoundController32"
value: Number - desired value
Return Value:
Bool - true on success

Examples

Example 1:
Change value of CustomSoundController1 to 12setCustomSoundController [vehicle player, "CustomSoundController1", 12];

Additional Information

See also:
Arma 3 SoundgetCustomSoundControllergetCustomSoundControllerCountgetSoundControllergetSoundControllerResultgetAllSoundControllersgetEnvSoundControllergetAllEnvSoundControllers

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

Notes

Bottom Section