BIS fnc getCfgData: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Execution" to "|Execution=")
m (Some wiki formatting)
 
(32 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
____________________________________________________________________________________________


| 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.
- Alternative syntax is for comfortable working with mission [[description.ext]].|Description=
* Default syntax works for any config.
____________________________________________________________________________________________
* Alternative syntax is for working comfortably with [[Description.ext]].


| config call [[BIS_fnc_getCfgData]] |Syntax=
|s1= config call [[BIS_fnc_getCfgData]]


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


|p1= config: [[Config]] - [[Config]] path |Parameter 1=
|r1= [[Array]], [[String]], [[Number]] or [[nil]]


|s2= array call [[BIS_fnc_getCfgData]]


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


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


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


|p21= [[Array]] of [[Strings]] - [[missionConfigFile]] classes and an attribute |Alternative Parameter 1=
|x2= <sqf>private _value = (missionConfigFile >> "Hubs" >> "A1" >> "QuickStart" >> "trigger") call BIS_fnc_getCfgData;</sqf>


|r2= [[Array]], [[String]], [[Number]] or [[nil]] |Alternative Return Value=
|seealso= [[BIS_fnc_getCfgDataArray]] [[BIS_fnc_getCfgDataObject]] [[BIS_fnc_getCfgDataPool]] [[BIS_fnc_getCfgDataBool]]
 
 
|x1= <code> _value = ([[configFile]] >> "BulletBubbles" >> "BulletBubbles1" >> "type") [[call]] [[BIS_fnc_getCfgData]];</code>|Example 1=
 
|x2= <code> _value = ([[missionConfigFile]] >> "Hubs" >> "A1" >> "QuickStart" >> "trigger") [[call]] [[BIS_fnc_getCfgData]];</code>|Example 1=
____________________________________________________________________________________________
 
| [[BIS_fnc_getCfgDataArray]], [[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:getCfgData}}]]
[[Category:Functions|{{uc:getCfgData}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:getCfgData}}]]

Latest revision as of 22:03, 23 April 2024

Arma 3 logo black.png1.00
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 working comfortably with 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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_getCfgData&oldid=363873"