BIS fnc getParamValue: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " {{Function|Comments=" to "{{Function|Comments=")
m (Text replacement - "[[Arma 3: Mission Parameters" to "[[Mission Parameters")
 
(31 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|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". |DESCRIPTION=
|descr=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]]; |SYNTAX=
|s1= paramClass call [[BIS_fnc_getParamValue]]


|p1= paramClass: [[String]] - class name of one of [[Arma 3 Mission Parameters]]|PARAMETER1=
|p1= paramClass: [[String]] - class name of one of [[Mission Parameters]]


|[[Number]] - param value. Default: 0|RETURNVALUE=
|r1= [[Number]] - param value. Default: 0


|s2= [paramClass, defaultValue] call [[BIS_fnc_getParamValue]]; |SYNTAX2=
|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 [[Mission Parameters]]
|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


|r2=[[Number]] - param value. Default: 0 |RETURNVALUE=
|r2=[[Number]] - param value. Default: 0
____________________________________________________________________________________________


|x1= <code>_viewDistance = "ViewDistance" [[call]] [[BIS_fnc_getParamValue]];</code> |Example1=
|x1= <sqf>private _viewDistance = "ViewDistance" call BIS_fnc_getParamValue;</sqf>


|x2= <code>_viewDistance = ["ViewDistance", 2] [[call]] [[BIS_fnc_getParamValue]];</code> |=
|x2= <sqf>private _viewDistance = ["ViewDistance", 2] call BIS_fnc_getParamValue;</sqf>
____________________________________________________________________________________________


| [[Arma 3 Mission Parameters]]|SEEALSO=
|seealso= [[Mission Parameters]] [[getMissionConfigValue]] [[getMissionConfig]] [[BIS_fnc_storeParamsValues]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Params|{{uc:getParamValue}}]]
[[Category:Functions|{{uc:getParamValue}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:getParamValue}}]]

Latest revision as of 17:42, 12 February 2024

Arma 3 logo black.png1.00
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:
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:
private _viewDistance = "ViewDistance" call BIS_fnc_getParamValue;
Example 2:
private _viewDistance = ["ViewDistance", 2] call BIS_fnc_getParamValue;

Additional Information

See also:
Mission Parameters getMissionConfigValue getMissionConfig BIS_fnc_storeParamsValues

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=BIS_fnc_getParamValue&oldid=352530"