BIS_fnc_param

0.50

Hover & click on the images for description

Description

Description:

Load a script parameter. See Functions Library (Arma 3) for detailed description.

This function is obsolete since the introduction of param and params.

Execution:

call

Groups:

Arrays

Syntax

Syntax:

[input,index,(defaultValue,dataTypes,requiredCount)] call BIS_fnc_param;

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:

Anything

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:

BIS_fnc_paramIn param params

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

(A3 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;