Difference between revisions of "BIS fnc configPath"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (Text replacement - "|= |x2=" to "|Example1= |x2=")
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
  
{{Function|= Comments
+
{{Function|Comments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| arma3 |= Game name
+
| arma3 |Game name=
  
|1.00|= Game version
+
|1.00|Game version=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| <pre>/*
+
|Returns config path to given entry in given format |DESCRIPTION=
 +
____________________________________________________________________________________________
  
Description:
+
|  [config, format, strict] call [[BIS_fnc_configPath]]; |SYNTAX=
Return config path to given entry.
 
  
Parameter(s):
+
|p1= config: [[Array]], [[String]] or [[Config]] - input config |PARAMETER1=
0: CONFIG or ARRAY or STRING
+
|p2= format (Optional): [[Array]], [[String]] or [[Config]] - desired format of output. Default: [[Array]], unless [[Array]] is input, then [[Config]] is returned (see Example 1) |PARAMETER2=
1 (Optional): ARRAY or STRING or CONFIG - type of returned value (default: ARRAY)
+
|p3= strict (Optional): [[Boolean]] - by default the function will not attempt to construct a valid config before certain format conversions (see Example 2). Set this param to [[true]] to invoke the strict mode |PARAMETER3=
  
Returns:
+
|[[Array]], [[String]] or [[Config]] |RETURNVALUE=
ARRAY - list of classes (e.g., ["configfile","CfgVehicles"])
 
STRING - composed path (e.g., "configfile >> 'CfgVehicles'")
 
CONFIG - system path (e.g., configfile >> "CfgVehicles")
 
*/
 
 
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
 
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| <!-- [] call [[BIS_fnc_configPath]]; --> |= Syntax
+
|x1= <code>["configFile >> ""CfgVehicles"" >> ""Car"""] [[call]] [[BIS_fnc_configPath]]; // ["configFile","CfgVehicles","Car"]
 
+
<nowiki>[</nowiki>["configFile","CfgVehicles","Car"]] [[call]] [[BIS_fnc_configPath]]; // bin\config.cpp/CfgVehicles/Car
|p1= |= Parameter 1
+
["bin\config.cpp/CfgVehicles/Car"] [[call]] [[BIS_fnc_configPath]]; // ["configFile","CfgVehicles","Car"]
 
+
[configFile >> "CfgVehicles" >> "Car", ""] [[call]] [[BIS_fnc_configPath]]; // "configFile >> ""CfgVehicles"" >> ""Car"""</code> |Example1=
| |= Return value
 
____________________________________________________________________________________________
 
  
|x1= <code></code> |=  
+
|x2= <code><nowiki>[</nowiki>["mary", "had", "a", "little", "lamb"], ""] [[call]] [[BIS_fnc_configPath]]; // "mary >> ""had"" >> ""a"" >> ""little"" >> ""lamb"""
 +
<nowiki>[</nowiki>["mary", "had", "a", "little", "lamb"], "", [[true]]] [[call]] [[BIS_fnc_configPath]]; // "" invalid config
 +
["bin\config.cpp/CfgVehicles/Car", ""] [[call]] [[BIS_fnc_configPath]]; // "bin\config.cpp/CfgVehicles/Car"
 +
["bin\config.cpp/CfgVehicles/Car", "", [[true]]] [[call]] [[BIS_fnc_configPath]]; // "configFile >> ""CfgVehicles"" >> ""Car"""</code> |=  
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| |= See also
+
|[[configHierarchy]] |SEEALSO=
  
 
}}
 
}}

Latest revision as of 13:29, 3 September 2019

Introduced with Arma 3 version 1.00
  

Click on the images for descriptions

Introduced in

Game:
Arma 3
Version:
1.00

Description

Description:
Returns config path to given entry in given format

Syntax

Syntax:
[config, format, strict] call BIS_fnc_configPath;
Parameters:
config: Array, String or Config - input config
format (Optional): Array, String or Config - desired format of output. Default: Array, unless Array is input, then Config is returned (see Example 1)
strict (Optional): Boolean - by default the function will not attempt to construct a valid config before certain format conversions (see Example 2). Set this param to true to invoke the strict mode
Return Value:
Array, String or Config

Examples

Example 1:
["configFile >> ""CfgVehicles"" >> ""Car"""] call BIS_fnc_configPath; // ["configFile","CfgVehicles","Car"] [["configFile","CfgVehicles","Car"]] call BIS_fnc_configPath; // bin\config.cpp/CfgVehicles/Car ["bin\config.cpp/CfgVehicles/Car"] call BIS_fnc_configPath; // ["configFile","CfgVehicles","Car"] [configFile >> "CfgVehicles" >> "Car", ""] call BIS_fnc_configPath; // "configFile >> ""CfgVehicles"" >> ""Car"""
Example 2:
[["mary", "had", "a", "little", "lamb"], ""] call BIS_fnc_configPath; // "mary >> ""had"" >> ""a"" >> ""little"" >> ""lamb""" [["mary", "had", "a", "little", "lamb"], "", true] call BIS_fnc_configPath; // "" invalid config ["bin\config.cpp/CfgVehicles/Car", ""] call BIS_fnc_configPath; // "bin\config.cpp/CfgVehicles/Car" ["bin\config.cpp/CfgVehicles/Car", "", true] call BIS_fnc_configPath; // "configFile >> ""CfgVehicles"" >> ""Car"""

Additional Information

Execution:
call
Multiplayer:
-
See also:
configHierarchy

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section