BIS fnc getCfgData: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1= Configs |GROUP1=
|gr1= Configs


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


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




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




| [[Array]], [[String]], [[Number]] or [[nil]] |Return value=
| [[Array]], [[String]], [[Number]] or [[nil]]


|exec= call |Execution=
|exec= call |Execution=


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


|p21= [[Array]] of [[Strings]] - [[missionConfigFile]] classes and an attribute |Alternative Parameter 1=
|p21= [[Array]] of [[Strings]] - [[missionConfigFile]] classes and an attribute


|r2= [[Array]], [[String]], [[Number]] or [[nil]] |Alternative Return Value=
|r2= [[Array]], [[String]], [[Number]] or [[nil]] |Alternative Return Value=




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


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


| [[BIS_fnc_getCfgDataArray]], [[BIS_fnc_getCfgDataObject]], [[BIS_fnc_getCfgDataPool]], [[BIS_fnc_getCfgDataBool]] |See also=
| [[BIS_fnc_getCfgDataArray]], [[BIS_fnc_getCfgDataObject]], [[BIS_fnc_getCfgDataPool]], [[BIS_fnc_getCfgDataBool]]
}}
}}



Revision as of 23:01, 17 January 2021

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:
_value = (configFile >> "BulletBubbles" >> "BulletBubbles1" >> "type") 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


Bottom Section