BIS fnc getParamValue: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "[[Arma 3 Mission Parameters" to "[[Arma 3: Mission Parameters") |
Lou Montana (talk | contribs) m (Text replacement - "[[Arma 3: Mission Parameters" to "[[Mission Parameters") |
||
| Line 10: | Line 10: | ||
|s1= paramClass call [[BIS_fnc_getParamValue]] | |s1= paramClass call [[BIS_fnc_getParamValue]] | ||
|p1= paramClass: [[String]] - class name of one of [[ | |p1= paramClass: [[String]] - class name of one of [[Mission Parameters]] | ||
|r1= [[Number]] - param value. Default: 0 | |r1= [[Number]] - param value. Default: 0 | ||
| Line 16: | Line 16: | ||
|s2= [paramClass, defaultValue] call [[BIS_fnc_getParamValue]] | |s2= [paramClass, defaultValue] call [[BIS_fnc_getParamValue]] | ||
|p21= paramClass: [[String]] - class name of one of [[ | |p21= paramClass: [[String]] - class name of one of [[Mission Parameters]] | ||
|p22= defaultValue (Optional): [[Number]] - default value to return if param doesn't exist | |p22= defaultValue (Optional): [[Number]] - default value to return if param doesn't exist | ||
| Line 25: | Line 25: | ||
|x2= <sqf>private _viewDistance = ["ViewDistance", 2] call BIS_fnc_getParamValue;</sqf> | |x2= <sqf>private _viewDistance = ["ViewDistance", 2] call BIS_fnc_getParamValue;</sqf> | ||
|seealso= [[ | |seealso= [[Mission Parameters]] [[getMissionConfigValue]] [[getMissionConfig]] [[BIS_fnc_storeParamsValues]] | ||
}} | }} | ||
Latest revision as of 17:42, 12 February 2024
Description
- Description:
- Returns the value of mission param given by the class name. This function is global and will return selected param value on any PC including JIP. For backward compatibility it also supports "param1" and "param2".
- Execution:
- call
- Groups:
- Mission Parameters
Syntax
- Syntax:
- paramClass call BIS_fnc_getParamValue
- Parameters:
- paramClass: String - class name of one of Mission Parameters
- Return Value:
- Number - param value. Default: 0
Alternative Syntax
- Syntax:
- [paramClass, defaultValue] call BIS_fnc_getParamValue
- Parameters:
- paramClass: String - class name of one of Mission Parameters
- defaultValue (Optional): Number - default value to return if param doesn't exist
- Return Value:
- Number - param value. Default: 0
Examples
- Example 1:
- Example 2:
Additional Information
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