BIS fnc getCfgDataArray: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|Game version=" to "|Game version= |gr1= Configs |GROUP1=")
m (Text replacement - "Strings" to "Strings")
 
(30 intermediate revisions by 2 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= Configs


|gr1= Configs |GROUP1=
|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]].


| 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>
|s1= config call [[BIS_fnc_getCfgDataArray]]
- Alternative syntax is for comfortable working with mission [[description.ext]].|Description=
____________________________________________________________________________________________


| config call [[BIS_fnc_getCfgDataArray]] |Syntax=
|p1= config: [[Config]] - [[Config]] path


|r1= [[Array]] or [[nil]]


|p1= config: [[Config]] - [[Config]] path |Parameter 1=
|s2= array call [[BIS_fnc_getCfgDataArray]]


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


| [[Array]] or [[nil]] |Return value=
|r2= [[Array]] or [[nil]]


|exec= call |Execution=
|x1= <sqf>private _array = (missionConfigFile >> "Characters" >> "Default" >> "equipAdjust") call BIS_fnc_getCfgDataArray;</sqf>
____________________________________________________________________________________________


|s2= array call [[BIS_fnc_getCfgDataArray]] |Alternative Syntax=
|x2= <sqf>private _array = ["Characters","Default","equipAdjust"] call BIS_fnc_getCfgDataArray;</sqf>


|p21= [[Array]] of [[Strings]] - [[missionConfigFile]] classes and an attribute |Alternative Parameter 1=
|seealso= [[BIS_fnc_getCfgData]] [[BIS_fnc_getCfgDataObject]] [[BIS_fnc_getCfgDataPool]] [[BIS_fnc_getCfgDataBool]]
 
|r2= [[Array]] or [[nil]] |Alternative Return Value=
 
 
|x1= <code> _array = ([[missionConfigFile]] >> "Characters" >> "Default" >> "equipAdjust") [[call]] [[BIS_fnc_getCfgDataArray]];</code>|Example 1=
 
|x2= <code> _array = ["Characters","Default","equipAdjust"] [[call]] [[BIS_fnc_getCfgDataArray]];</code>|Example 2=
____________________________________________________________________________________________
 
| [[BIS_fnc_getCfgData]], [[BIS_fnc_getCfgDataObject]], [[BIS_fnc_getCfgDataPool]], [[BIS_fnc_getCfgDataBool]] |See also=
}}
}}
<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 22: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"