Difference between revisions of "configFile"

From Bohemia Interactive Community
Jump to navigation Jump to search
(see also)
m (Text replacement - "<!-- Note Section [A-Z]+ --> " to "")
 
(39 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{RV|type=command
____________________________________________________________________________________________
 
  
| arma |= Game name
+
|game1= arma1
  
|1.00|= Game version
+
|version1= 1.00
____________________________________________________________________________________________
 
  
| Return root of config entries hierarchy.<br />
+
|game2= arma2
See [[AllInOne Config]] for a full config extract as example. |= Description
 
____________________________________________________________________________________________
 
  
| [[Config]] <nowiki>=</nowiki> '''configFile''' |= Syntax
+
|version2= 1.00
  
| [[Config]] |= Return value
+
|game3= arma2oa
____________________________________________________________________________________________
 
  
|x1= <code>_isMyClassActive = [[isClass]] ([[configFile]] / "CfgPatches" / "MyClass");</code> |= Example 1
+
|version3= 1.51
____________________________________________________________________________________________
 
  
| [[configClasses]], [[missionConfigFile]], [[campaignConfigFile]], [[config/name]], [[config greater greater name|config >> name]], [[configName]], [[count]], [[getArray]], [[getText]], [[getNumber]], [[inheritsFrom]], [[isArray]], [[isClass]], [[isNumber]], [[isText]], [[select]] |= See also
+
|game4= tkoh
  
 +
|version4= 1.00
 +
 +
|game5= arma3
 +
 +
|version5= 0.50
 +
 +
|gr1= Config
 +
 +
|descr= Return root of config entries hierarchy.
 +
 +
|s1= '''configFile'''
 +
 +
|r1= [[Config]]
 +
 +
|x1= <code>_isMyClassActive = [[isClass]] ([[configFile]] >> "CfgPatches" >> "MyClass");</code>
 +
 +
|seealso= [[missionConfigFile]] [[campaignConfigFile]]
 
}}
 
}}
  
<h3 style="display:none">Notes</h3>
 
 
<dl class="command_description">
 
<dl class="command_description">
<!-- Note Section BEGIN -->
+
<dd class="notedate">Posted on Jul 19, 2014 - 20:08</dd>
<dd class="notedate">Posted on Apr 3, 2014 - 00:37
+
<dt class="note">[[User:ffur2007slx2_5|ffur2007slx2_5]]<dd class="note">
<dt class="note">'''[[User:ffur2007slx2_5|ffur2007slx2_5]]'''<dd class="note">
+
{{GVI|arma3|1.24}} It is recommended to use [[configClasses]] instead of [[BIS_fnc_getCfgSubClasses]] and [[BIS_fnc_uniqueClasses]] on subclasses collection or conditional selection.
In ArmA3 ver 1.14 there’re several comfortable workarounds with [[configFile]] for collecting subclasses. As for traditional workaround like:
+
<code>_faces = "[[true]]" [[configClasses]] ([[configFile]] >> "CfgFaces");
<code>
+
{{cc|same as:}} _faces = (configfile >> "CfgFaces") [[call]] [[BIS_fnc_getCfgSubClasses]];
(configfile >> "CfgFaces") call {
 
  private ["_classes"];
 
  _classes = [];
 
  for "_i" from 0 to ((count _this) - 1) do 
 
  {
 
    if (isClass (_this select _i)) then
 
  {
 
  _classes set [count _classes, configName (_this select _i)];
 
  };
 
  };
 
  _classes
 
};
 
//return: ["Default"……"O_Colonel"] 8 items
 
 
</code>
 
</code>
Alternative recommended workaround by using: [[BIS_fnc_getCfgSubClasses]] e.g.
+
<code>//Extract all animals:
<code>
+
animals = "([[configName]] _x [[isKindOf]] 'animal')" [[configClasses]] ([[configFile]] >> "CfgVehicles");
(configfile >> "CfgFaces") call BIS_fnc_getCfgSubClasses
+
{{cc|same as:}}
//Same as traditional workaround
+
animals = [];
 +
[([[configFile]] >> "CfgVehicles"),{
 +
[[if]] (([[configName]] _this) [[isKindOf]] “animal”) [[then]] {
 +
  animals [[set]] [<nowiki/>[[count]] animals, _this]
 +
  }
 +
}
 +
] [[call]] [[BIS_fnc_uniqueClasses]];
 
</code>
 
</code>
Another powerful replacement is using [[BIS_fnc_returnChildren]] to collect grandchildren classes with desired level, e.g.
+
Return nested subclasses, currently still [[BIS_fnc_returnChildren]]
<code>
+
<code>{{cc|Return all nested config classes}}
[(configfile >> "CfgFaces"),1,true,true] call BIS_fnc_returnChildren;
+
<nowiki>[</nowiki>[[configFile]] >> "CfgFaces",1, [[true]], [[true]]] [[call]] [[BIS_fnc_returnChildren]];
//Return all children faces with a total number at 68
 
 
</code>
 
</code>
And as for another advanced workaround for direct processing collected classes, use [[BIS_fnc_uniqueClasses]]. E.g.
 
<code>
 
my_array = [];
 
[(configfile >> "BombCrater"),
 
  {
 
    my_array set [count my_array,(_this select 2) call bis_fnc_getcfgdata]
 
  }
 
] call BIS_fnc_uniqueClasses;
 
//return [[0,0,0],[0,0,0],[0,0,0]]
 
</code>
 
<!-- Note Section END -->
 
 
</dl>
 
</dl>
 
<h3 style="display:none">Bottom Section</h3>
 
 
[[Category:Scripting Commands|CONFIGFILE]]
 
[[Category:Scripting Commands ArmA|CONFIGFILE]]
 
[[Category:Command_Group:_System_Commands|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 

Latest revision as of 01:34, 6 April 2021

Hover & click on the images for descriptions

Description

Description:
Return root of config entries hierarchy.

Syntax

Syntax:
configFile
Return Value:
Config

Examples

Example 1:
_isMyClassActive = isClass (configFile >> "CfgPatches" >> "MyClass");

Additional Information

See also:
missionConfigFile campaignConfigFile
Groups:
Config

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
Posted on Jul 19, 2014 - 20:08
ffur2007slx2_5
Arma 31.24 It is recommended to use configClasses instead of BIS_fnc_getCfgSubClasses and BIS_fnc_uniqueClasses on subclasses collection or conditional selection. _faces = "true" configClasses (configFile >> "CfgFaces"); // same as: _faces = (configfile >> "CfgFaces") call BIS_fnc_getCfgSubClasses; //Extract all animals: animals = "(configName _x isKindOf 'animal')" configClasses (configFile >> "CfgVehicles"); // same as: animals = []; [(configFile >> "CfgVehicles"),{ if ((configName _this) isKindOf “animal”) then { animals set [count animals, _this] } } ] call BIS_fnc_uniqueClasses; Return nested subclasses, currently still BIS_fnc_returnChildren // Return all nested config classes [configFile >> "CfgFaces",1, true, true] call BIS_fnc_returnChildren;