BIS fnc getCfgDataArray: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(page filling)
Line 1: Line 1:
 
{{Function|Comments=
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| arma3 |Game name=


|1.00|= Game version
|1.00|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Gets an array defined in Config. If the value is not an array, it's retyped into one.|Description=
____________________________________________________________________________________________


Description:
| config call [[BIS_fnc_getCfgDataArray]] |Syntax=
Get an array from cfg. If the retrieved value is not an array, retype it to an array.


Remark(s):
* Can by called 2 ways:
* 1st way (general) works for any config.
* 2nd way is for comfortable working with mission description.ext.


Parameter(s):
|p1= config: [[Config]] - [[Config]] path |Parameter 1=
_this: CFG
_this: ARRAY of STRINGS - missionConfigFile classes and an attribute.


Example:


* 1st way of calling:
| [[Array]] or [[nil]] |Return value=


_value = (missionconfigfile >> "Hubs" >> "A1" >> "position") call BIS_fnc_getCfgDataArray;
|exec= call |= Execution
 
____________________________________________________________________________________________
* 2nd way of calling:
 
_value = ["Hubs","A1","position"] call BIS_fnc_getCfgDataArray;


Returns:
|s2= array call [[BIS_fnc_getCfgDataArray]] |Alternative Syntax=
ARRAY or nil
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p21= [[Array]] of [[Strings]] - [[missionConfigFile]] classes and an attribute |Alternative Parameter 1=
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_getCfgDataArray]]; --> |= Syntax
|r2= [[Array]] or [[nil]] |Alternative Return Value=


|p1= |= Parameter 1


| |= Return value
|x1= <code> _array = ([[missionConfigFile]] >> "Characters" >> "Default" >> "equipAdjust") [[call]] [[BIS_fnc_getCfgDataArray]];</code>|Example 1=
____________________________________________________________________________________________


|x1= <code></code> |=  
|x2= <code> _array = ["Characters","Default","equipAdjust"] [[call]] [[BIS_fnc_getCfgDataArray]];</code>|Example 1=
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[BIS_fnc_getCfgData]], [[BIS_fnc_getCfgDataObject]], [[BIS_fnc_getCfgDataPool]], [[BIS_fnc_getCfgDataBool]] |See also=
 
}}
}}


Revision as of 12:29, 8 November 2018

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Gets an array defined in Config. If the value is not an array, it's retyped into one.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
config call BIS_fnc_getCfgDataArray
Parameters:
config: Config - Config path
Return Value:
Array or nil

Alternative Syntax

Syntax:
array call BIS_fnc_getCfgDataArray
Parameters:
Array of Strings - missionConfigFile classes and an attribute
Return Value:
Array or nil

Examples

Example 1:
_array = (missionConfigFile >> "Characters" >> "Default" >> "equipAdjust") call BIS_fnc_getCfgDataArray;
Example 2:
_array = ["Characters","Default","equipAdjust"] call BIS_fnc_getCfgDataArray;

Additional Information

See also:
BIS_fnc_getCfgDataBIS_fnc_getCfgDataObjectBIS_fnc_getCfgDataPoolBIS_fnc_getCfgDataBool

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

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_getCfgDataArray&oldid=110415"