BIS fnc getCfgData: 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>/*
| 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]].|Description=
____________________________________________________________________________________________


Description:
| config call [[BIS_fnc_getCfgData]] |Syntax=
Smart-return number, text or array value from config.


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]], [[String]], [[Number]] or [[nil]] |Return value=


_value = (configfile >> "BulletBubbles" >> "BulletBubbles1") call BIS_fnc_getCfgData;
|exec= call |= Execution
_value = (missionconfigfile >> "Hubs" >> "A1" >> "QuickStart" >> "trigger") call BIS_fnc_getCfgData;
____________________________________________________________________________________________


* 2nd way of calling:
|s2= array call [[BIS_fnc_getCfgData]] |Alternative Syntax=


_value = ["Hubs","A1","QuickStart","trigger"] call BIS_fnc_getCfgData;
|p21= [[Array]] of [[Strings]] - [[missionConfigFile]] classes and an attribute |Alternative Parameter 1=


Returns:
|r2= [[Array]], [[String]], [[Number]] or [[nil]] |Alternative Return Value=
STRING or NUMBER or ARRAY or nil (if value not found)
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_getCfgData]]; --> |= Syntax
|x1= <code> _value = ([[configFile]] >> "BulletBubbles" >> "BulletBubbles1") [[call]] [[BIS_fnc_getCfgData]];</code>|Example 1=


|p1= |= Parameter 1
|x2= <code> _value = ([[missionConfigFile]] >> "Hubs" >> "A1" >> "QuickStart" >> "trigger") [[call]] [[BIS_fnc_getCfgData]];</code>|Example 1=
 
| |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
| [[BIS_fnc_getCfgDataArray]], [[BIS_fnc_getCfgDataObject]], [[BIS_fnc_getCfgDataPool]], [[BIS_fnc_getCfgDataBool]] |See also=
____________________________________________________________________________________________
}}
 
| |= See also


}}


<h3 style="display:none">Notes</h3>
<h3 style="display:none">Notes</h3>

Revision as of 12:36, 8 November 2018

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 comfortable working with mission description.ext.
Execution:
call
Groups:
Uncategorised

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:
_value = (configFile >> "BulletBubbles" >> "BulletBubbles1") call BIS_fnc_getCfgData;
Example 2:
_value = (missionConfigFile >> "Hubs" >> "A1" >> "QuickStart" >> "trigger") call BIS_fnc_getCfgData;

Additional Information

See also:
BIS_fnc_getCfgDataArrayBIS_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_getCfgData&oldid=110419"