getSoundControllerResult: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(syntax)
m (Some wiki formatting)
 
(63 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3dev |= Game name
|game1= arma3
|version1= 1.64


|1.63|= Game version
|gr1= Sounds
____________________________________________________________________________________________


| Returns calculated value of simple expression in config.
|descr= 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.


{{warning|This command is not final and might be changed in a near future.}}|= Description
|s1= vehicle [[getSoundControllerResult]] config


____________________________________________________________________________________________
|p1= vehicle: [[Object]] - transport vehicle


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


|r1= [[Number]]


| [[Arma_3_Sound]], [[getSoundController]], [[getEnvSoundController]], [[getAllEnvSoundControllers]], [[getAllSoundControllers]] |= See also
|x1= <sqf>_result = (vehicle player) getSoundControllerResult (configFile >> "cfgVehicles" >> typeOf (vehicle player) >> "sounds" >> "idle_ext" >> "volume");</sqf>
 
|x2= <sqf>
// mission config entry to reverse rain strength:
// myExpression = "rain factor [1,0]";
_result = "PaperCar" createVehicleLocal position player getSoundControllerResult (missionConfigFile >> "myExpression");
</sqf>
 
|seealso= [[Arma 3: Sound]] [[getSoundController]] [[getEnvSoundController]] [[getAllEnvSoundControllers]] [[getAllSoundControllers]] [[getCustomSoundController]] [[setCustomSoundController]] [[getCustomSoundControllerCount]]
}}
}}

Latest revision as of 23:09, 29 June 2022

Arma 3 logo black.png1.64
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:
Sounds

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: Sound getSoundController getEnvSoundController getAllEnvSoundControllers getAllSoundControllers getCustomSoundController setCustomSoundController getCustomSoundControllerCount

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=getSoundControllerResult&oldid=323118"