BIS fnc getCfg: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - ">\[ +(.*) *\] +(call|spawn)" to ">[$1] $2")
 
(45 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Configs


|1.00|= Game version
|descr= Smart-return config (extension for BIS_fnc_getCfgXXXX functions).
____________________________________________________________________________________________
Can by called 2 ways:
* 1st way - passing config directly
* 2nd way - passing array of strings or config and strings


| <pre>/*
|s1= input call [[BIS_fnc_getCfg]]
Author:
Killzone_Kid


Description:
|p1= input: [[Config]] or [[Array]] - can be [[Config]] path or array of strings with config names
Smart-return config (extension for BIS_fnc_getCfgXXXX functions)


Remark(s):
|r1= [[Config]]
Can by called 2 ways:
* 1st way - passing config directly
* 2nd way - passing array of strings or config and strings


Parameter(s):
|x1= <sqf>( configFile >> "BulletBubbles" >> "BulletBubbles1" ) call BIS_fnc_getCfg;</sqf>
_this: CONFIG
|x2= <sqf>[configFile >> "BulletBubbles" >> "BulletBubbles1"] call BIS_fnc_getCfg;</sqf>
_this: ARRAY
|x3= <sqf>[configFile, "BulletBubbles", "BulletBubbles1"] call BIS_fnc_getCfg;</sqf>
 
|x4= <sqf>["Hubs", "A1", "QuickStart", "trigger"] call BIS_fnc_getCfg;</sqf>
Example 1:
|x5= <sqf>["Hubs"] call BIS_fnc_getCfg;</sqf>
1st way of calling:
 
_cfg = (configfile >> "BulletBubbles" >> "BulletBubbles1") call BIS_fnc_getCfg;
_cfg = (missionconfigfile >> "Hubs" >> "A1" >> "QuickStart" >> "trigger") call BIS_fnc_getCfg;
Example 2:
2nd way of calling:
_cfg = [configfile >> "BulletBubbles" >> "BulletBubbles1"] call BIS_fnc_getCfg;
_cfg = [configfile, "BulletBubbles", "BulletBubbles1"] call BIS_fnc_getCfg;
_cfg = ["Hubs"] call BIS_fnc_getCfg;
_cfg = ["Hubs", "A1", "QuickStart", "trigger"] call BIS_fnc_getCfg;
 
Returns:
CONFIG
*/
 
// is array [string(, string...)]
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_getCfg]]; --> |= Syntax
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[configClasses]] [[configProperties]] [[missionConfigFile]] [[campaignConfigFile]] [[configName]] [[getArray]] [[getText]] [[getNumber]] [[inheritsFrom]] [[isClass]] [[isText]] [[configHierarchy]]
}}
}}
<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:getCfg}}]]
[[Category:Functions|{{uc:getCfg}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:getCfg}}]]

Latest revision as of 17:27, 8 November 2023

Hover & click on the images for description

Description

Description:
Smart-return config (extension for BIS_fnc_getCfgXXXX functions). Can by called 2 ways:
  • 1st way - passing config directly
  • 2nd way - passing array of strings or config and strings
Execution:
call
Groups:
Configs

Syntax

Syntax:
input call BIS_fnc_getCfg
Parameters:
input: Config or Array - can be Config path or array of strings with config names
Return Value:
Config

Examples

Example 1:
( configFile >> "BulletBubbles" >> "BulletBubbles1" ) call BIS_fnc_getCfg;
Example 2:
[configFile >> "BulletBubbles" >> "BulletBubbles1"] call BIS_fnc_getCfg;
Example 3:
[configFile, "BulletBubbles", "BulletBubbles1"] call BIS_fnc_getCfg;
Example 4:
["Hubs", "A1", "QuickStart", "trigger"] call BIS_fnc_getCfg;
Example 5:
["Hubs"] call BIS_fnc_getCfg;

Additional Information

See also:
configClasses configProperties missionConfigFile campaignConfigFile configName getArray getText getNumber inheritsFrom isClass isText configHierarchy

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