BIS fnc param: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "\[\[[cC]ategory:\{\{Name\|arma3\}\}: [fF]unctions\|\{\{uc:[a-z A-Z_]*\}\}\]\]" to "") |
Lou Montana (talk | contribs) m (Text replacement - "<code> +" to "<code>") |
||
| Line 42: | Line 42: | ||
<dt class="note">[[User:ffur2007slx2_5|ffur2007slx2_5]]</dt> | <dt class="note">[[User:ffur2007slx2_5|ffur2007slx2_5]]</dt> | ||
<dd class="note">{{GVI|arma3|1.28}} Use [[BIS_fnc_paramIn]] to load private path from parent parameters (loaded by [[BIS_fnc_param]]) | <dd class="note">{{GVI|arma3|1.28}} Use [[BIS_fnc_paramIn]] to load private path from parent parameters (loaded by [[BIS_fnc_param]]) | ||
<code> | <code>[[private]] ["_parent","_child0","_child1"]; | ||
[[private]] ["_parent","_child0","_child1"]; | |||
_parent = [_this,0,[],[[]]] [[call]] [[BIS_fnc_param]]; | _parent = [_this,0,[],[[]]] [[call]] [[BIS_fnc_param]]; | ||
_child0 = [_parent,0,[[missionNamespace]],[ [[missionNamespace]],[[grpNull]],[[objNull]] ]] [[call]] [[BIS_fnc_paramIn]]; | _child0 = [_parent,0,[[missionNamespace]],[ [[missionNamespace]],[[grpNull]],[[objNull]] ]] [[call]] [[BIS_fnc_paramIn]]; | ||
Revision as of 16:51, 7 February 2021
Description
- Description:
- Description needed
- Execution:
- call
- Groups:
- Arrays
Syntax
- Syntax:
- Syntax needed
- Parameters:
- input: Array - list of params
- index: Number - selected index
- defaultValue (Optional): Anything - default param (used when param is missing or of wrong type).
You can overload default value by declaring variable BIS_fnc_<functionName>_<index> in Namespace where BIS_fnc_param is called from.
BIS_fnc_paramIn is a variant of the function with overloading disabled. - dataTypes (Optional): Array - list of allowed type examples (e.g. ["",[],0,objNull])
- requiredCount (Optional): Number or Array - If value is Array, checks if it has required number of elements
- Return Value:
- Return value needed
Examples
- Example 1:
_target = [_this, 0, objNull, [objNull,[]], [2,3]] call BIS_fnc_param;- If (_this select 0) is not defined, default objnull is used.
- If (_this select 0) is defined, but is neither of type Object nor Array, error message is logged and default objNull is used.
- If (_this select 0) and is Array, but it is count is neither 2 nor 3, error message is logged and default objNull is used.
- Example 2:
_answer = [_this, 1, 42] call BIS_fnc_param;- If (_this select 1) is not defined, default 42 is used.
- No limit for data types or number of elements exists.
Additional Information
- See also:
- See also needed
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
- Posted: 21:55 Sep 6 2014
- ffur2007slx2_5
1.28 Use BIS_fnc_paramIn to load private path from parent parameters (loaded by BIS_fnc_param)
private ["_parent","_child0","_child1"]; _parent = [_this,0,[],[[]]] call BIS_fnc_param; _child0 = [_parent,0,missionNamespace,[ missionNamespace,grpNull,objNull ]] call BIS_fnc_paramIn; _child1 = [_parent,1,"",[""]] call BIS_fnc_paramIn;