getSoundControllerResult: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Undo revision 96602 by Tom 48 97 (talk))
(see also)
(5 intermediate revisions by 4 users not shown)
Line 2: Line 2:
____________________________________________________________________________________________
____________________________________________________________________________________________


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


|1.63|= Game version
|1.64|= Game version
____________________________________________________________________________________________
____________________________________________________________________________________________


| Returns the calculated value of simple expression in config.|= Description
| Returns the calculated value of [[simple expression]] defined in config. Config could be any config entry, even [[missionConfigFile | mission config]] entry. It is more important that the vehicle is a transport and not any object. If the expression contains sound controllers, the controller values will be taken from the given vehicle. |DESCRIPTION=


____________________________________________________________________________________________
____________________________________________________________________________________________


| obj '''getSoundControllerResult''' configEntry |= Syntax
| vehicle '''getSoundControllerResult''' config |SYNTAX=
|p1 = obj: [[Object]] - not sure why it has to be here but it won't work otherwise.|=
|p1 = vehicle: [[Object]] - transport vehicle|=
|p2 = configEntry: [[Config]] - path to configured value, see example. Works only for cfgVehicles.|=
|p2 = config: [[Config]] - path to config entry containing the expression|=
| [[Number]] |= Return value
| [[Number]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
|x1 = <code>_result = ([[vehicle]] [[player]]) '''getSoundControllerResult''' ([[configFile]] [[gtgt|>>]] "cfgVehicles" [[gtgt|>>]] [[typeOf]] ([[vehicle]] [[player]]) [[gtgt|>>]] "sounds" [[gtgt|>>]] "idle_ext" [[gtgt|>>]] "volume");</code>
|x1= <code>_result = ([[vehicle]] [[player]]) [[getSoundControllerResult]] ([[configFile]] [[gtgt|>>]] "cfgVehicles" [[gtgt|>>]] [[typeOf]] ([[vehicle]] [[player]]) [[gtgt|>>]] "sounds" [[gtgt|>>]] "idle_ext" [[gtgt|>>]] "volume");</code>|example1=


|x2= <code>//-- mission config entry to reverse rain strength: <tt>myExpression = "rain factor [1,0]";</tt>
_result = "PaperCar" [[createVehicleLocal]] [[position]] [[player]] [[getSoundControllerResult]] ([[missionConfigFile]] >> "myExpression");</code>|example2=


| [[Arma 3 Sound]], [[getSoundController]], [[getEnvSoundController]], [[getAllEnvSoundControllers]], [[getAllSoundControllers]] |= See also
 
| [[Arma 3 Sound]], [[getSoundController]], [[getEnvSoundController]], [[getAllEnvSoundControllers]], [[getAllSoundControllers]], [[getCustomSoundController]], [[setCustomSoundController]], [[getCustomSoundControllerCount]]  |SEEALSO=
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|getSoundControllerResult]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]

Revision as of 11:43, 3 May 2019

Hover & click on the images for description

Description

Description:
Returns the calculated value of simple expression defined in config. Config could be any config entry, even mission config entry. It is more important that the vehicle is a transport and not any object. If the expression contains sound controllers, the controller values will be taken from the given vehicle.
Groups:
Uncategorised

Syntax

Syntax:
vehicle getSoundControllerResult config
Parameters:
vehicle: Object - transport vehicle
config: Config - path to config entry containing the expression
Return Value:
Number

Examples

Example 1:
_result = (vehicle player) getSoundControllerResult (configFile >> "cfgVehicles" >> typeOf (vehicle player) >> "sounds" >> "idle_ext" >> "volume");
Example 2:
//-- mission config entry to reverse rain strength: myExpression = "rain factor [1,0]"; _result = "PaperCar" createVehicleLocal position player getSoundControllerResult (missionConfigFile >> "myExpression");

Additional Information

See also:
Arma 3 SoundgetSoundControllergetEnvSoundControllergetAllEnvSoundControllersgetAllSoundControllersgetCustomSoundControllersetCustomSoundControllergetCustomSoundControllerCount

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