BIS_fnc_getParamValue

From Bohemia Interactive Community
Revision as of 21:27, 30 August 2019 by Lou Montana (talk | contribs) (Text replacement - "|= Game version" to "|Game version=")
Jump to navigation Jump to search


Hover & click on the images for description

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:
Uncategorised

Syntax

Syntax:
paramClass call BIS_fnc_getParamValue;
Parameters:
paramClass: String - class name of one of Arma 3 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 Arma 3 Mission Parameters
defaultValue (Optional): Number - default value to return if param doesn't exist
Return Value:
Number - param value. Default: 0

Examples

Example 1:
_viewDistance = "ViewDistance" call BIS_fnc_getParamValue;
Example 2:
_viewDistance = ["ViewDistance", 2] call BIS_fnc_getParamValue;

Additional Information

See also:
Arma 3 Mission Parameters

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