Difference between revisions of "BIS fnc configPath"
Jump to navigation
Jump to search
m (template:command argument fix) |
m (template:command argument fix) |
||
Line 13: | Line 13: | ||
| [config, format, strict] call [[BIS_fnc_configPath]]; |SYNTAX= | | [config, format, strict] call [[BIS_fnc_configPath]]; |SYNTAX= | ||
− | |p1= config: [[Array]], [[String]] or [[Config]] - input config |= | + | |p1= config: [[Array]], [[String]] or [[Config]] - input config |PARAMETER1= |
− | |p2= format (Optional): [[Array]], [[String]] or [[Config]] - desired format of output. Default: [[Array]], unless [[Array]] is input, then [[Config]] is returned (see Example 1) |= | + | |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= |
− | |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 |= | + | |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= |
|[[Array]], [[String]] or [[Config]] |RETURNVALUE= | |[[Array]], [[String]] or [[Config]] |RETURNVALUE= |
Revision as of 14:28, 7 April 2019
Hover & click on the images for descriptions
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
- See also:
- configHierarchy
- Groups:
- Uncategorised