BIS fnc getCfgDataArray: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "Strings" to "Strings")
 
(37 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Configs


|1.00|= Game version
|descr= Gets an array defined in Config. If the value is not an array, it is retyped into one.<br><br>- Default syntax works for any config.<br>
____________________________________________________________________________________________
- Alternative syntax is for comfortable working with mission [[Description.ext|description.ext]].


| <pre>/*
|s1= config call [[BIS_fnc_getCfgDataArray]]


Description:
|p1= config: [[Config]] - [[Config]] path
Get an array from cfg. If the retrieved value is not an array, retype it to an array.


Remark(s):
|r1= [[Array]] or [[nil]]
* Can by called 2 ways:
* 1st way (general) works for any config.
* 2nd way is for comfortable working with mission description.ext.


Parameter(s):
|s2= array call [[BIS_fnc_getCfgDataArray]]
_this: CFG
_this: ARRAY of STRINGS - missionConfigFile classes and an attribute.


Example:
|p21= [[Array]] of [[String]]s - [[missionConfigFile]] classes and an attribute


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


_value = (missionconfigfile >> "Hubs" >> "A1" >> "position") call BIS_fnc_getCfgDataArray;
|x1= <sqf>private _array = (missionConfigFile >> "Characters" >> "Default" >> "equipAdjust") call BIS_fnc_getCfgDataArray;</sqf>


* 2nd way of calling:
|x2= <sqf>private _array = ["Characters","Default","equipAdjust"] call BIS_fnc_getCfgDataArray;</sqf>
 
_value = ["Hubs","A1","position"] call BIS_fnc_getCfgDataArray;
 
Returns:
ARRAY or nil
*/
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_getCfgDataArray]]; --> |= Syntax
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[BIS_fnc_getCfgData]] [[BIS_fnc_getCfgDataObject]] [[BIS_fnc_getCfgDataPool]] [[BIS_fnc_getCfgDataBool]]
}}
}}
<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: Configs|{{uc:getCfgDataArray}}]]
[[Category:Functions|{{uc:getCfgDataArray}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:getCfgDataArray}}]]

Latest revision as of 21:51, 16 February 2024

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 is retyped into one.

- Default syntax works for any config.
- Alternative syntax is for comfortable working with mission description.ext.
Execution:
call
Groups:
Configs

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:
private _array = (missionConfigFile >> "Characters" >> "Default" >> "equipAdjust") call BIS_fnc_getCfgDataArray;
Example 2:
private _array = ["Characters","Default","equipAdjust"] call BIS_fnc_getCfgDataArray;

Additional Information

See also:
BIS_fnc_getCfgData BIS_fnc_getCfgDataObject BIS_fnc_getCfgDataPool BIS_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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_getCfgDataArray&oldid=352627"