BIS fnc getParamValue: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " *\|= * " to " ") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...) |
||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
| arma3 | | arma3 | ||
|1.00 | |1.00 | ||
|gr1= Mission Parameters | |gr1= Mission Parameters | ||
|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". | |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". | ||
| paramClass call [[BIS_fnc_getParamValue]]; | | paramClass call [[BIS_fnc_getParamValue]]; | ||
|p1= paramClass: [[String]] - class name of one of [[Arma 3 Mission Parameters]] | |p1= paramClass: [[String]] - class name of one of [[Arma 3 Mission Parameters]] | ||
|[[Number]] - param value. Default: 0 | |[[Number]] - param value. Default: 0 | ||
|s2= [paramClass, defaultValue] call [[BIS_fnc_getParamValue]]; | |s2= [paramClass, defaultValue] call [[BIS_fnc_getParamValue]]; | ||
|p21= paramClass: [[String]] - class name of one of [[Arma 3 Mission Parameters]]|PARAMETER21= | |p21= paramClass: [[String]] - class name of one of [[Arma 3 Mission Parameters]]|PARAMETER21= | ||
|p22= defaultValue (Optional): [[Number]] - default value to return if param doesn't exist|PARAMETER22= | |p22= defaultValue (Optional): [[Number]] - default value to return if param doesn't exist|PARAMETER22= | ||
|r2=[[Number]] - param value. Default: 0 | |r2=[[Number]] - param value. Default: 0 | ||
|x1= <code>_viewDistance = "ViewDistance" [[call]] [[BIS_fnc_getParamValue]];</code> | |x1= <code>_viewDistance = "ViewDistance" [[call]] [[BIS_fnc_getParamValue]];</code> | ||
|x2= <code>_viewDistance = ["ViewDistance", 2] [[call]] [[BIS_fnc_getParamValue]];</code> | |x2= <code>_viewDistance = ["ViewDistance", 2] [[call]] [[BIS_fnc_getParamValue]];</code> | ||
| [[Arma 3 Mission Parameters]] | | [[Arma 3 Mission Parameters]] | ||
}} | }} | ||
Revision as of 23:02, 17 January 2021
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 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