BIS fnc getCfgData: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3>" to "")
m (Text replacement - "Strings" to "Strings")
(24 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function
{{RV|type=function


| arma3
|game1= arma3
 
|version1= 1.00
|1.00


|gr1= Configs
|gr1= Configs


| Smart-return number, text or array value from config.<br><br>- Default syntax works for any config.<br>
|descr= Smart-return number, text or array value from config.<br><br>- Default syntax works for any config.<br>
- Alternative syntax is for comfortable working with mission [[description.ext]].
- Alternative syntax is for comfortable working with mission [[Description.ext|description.ext]].
 
| config call [[BIS_fnc_getCfgData]]


|s1= config call [[BIS_fnc_getCfgData]]


|p1= config: [[Config]] - [[Config]] path
|p1= config: [[Config]] - [[Config]] path


 
|r1= [[Array]], [[String]], [[Number]] or [[nil]]
| [[Array]], [[String]], [[Number]] or [[nil]]
 
|exec= call |Execution=


|s2= array call [[BIS_fnc_getCfgData]]
|s2= array call [[BIS_fnc_getCfgData]]


|p21= [[Array]] of [[Strings]] - [[missionConfigFile]] classes and an attribute
|p21= [[Array]] of [[String]]s - [[missionConfigFile]] classes and an attribute
 
|r2= [[Array]], [[String]], [[Number]] or [[nil]] |Alternative Return Value=


|r2= [[Array]], [[String]], [[Number]] or [[nil]]


|x1= <code> _value = ([[configFile]] >> "BulletBubbles" >> "BulletBubbles1" >> "type") [[call]] [[BIS_fnc_getCfgData]];</code>
|x1= <sqf>private _value = (configFile >> "BulletBubbles" >> "BulletBubbles1" >> "type") call BIS_fnc_getCfgData;</sqf>


|x2= <code> _value = ([[missionConfigFile]] >> "Hubs" >> "A1" >> "QuickStart" >> "trigger") [[call]] [[BIS_fnc_getCfgData]];</code>
|x2= <sqf>private _value = (missionConfigFile >> "Hubs" >> "A1" >> "QuickStart" >> "trigger") call BIS_fnc_getCfgData;</sqf>


| [[BIS_fnc_getCfgDataArray]], [[BIS_fnc_getCfgDataObject]], [[BIS_fnc_getCfgDataPool]], [[BIS_fnc_getCfgDataBool]]
|seealso= [[BIS_fnc_getCfgDataArray]] [[BIS_fnc_getCfgDataObject]] [[BIS_fnc_getCfgDataPool]] [[BIS_fnc_getCfgDataBool]]
}}
}}
[[Category:Functions|{{uc:getCfgData}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:getCfgData}}]]

Revision as of 22:51, 16 February 2024

Hover & click on the images for description

Description

Description:
Smart-return number, text or array value from config.

- 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_getCfgData
Parameters:
config: Config - Config path
Return Value:
Array, String, Number or nil

Alternative Syntax

Syntax:
array call BIS_fnc_getCfgData
Parameters:
Array of Strings - missionConfigFile classes and an attribute
Return Value:
Array, String, Number or nil

Examples

Example 1:
private _value = (configFile >> "BulletBubbles" >> "BulletBubbles1" >> "type") call BIS_fnc_getCfgData;
Example 2:
private _value = (missionConfigFile >> "Hubs" >> "A1" >> "QuickStart" >> "trigger") call BIS_fnc_getCfgData;

Additional Information

See also:
BIS_fnc_getCfgDataArray 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