BIS fnc configPath: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) (format) |
Lou Montana (talk | contribs) m (Text replacement - "|= |x2=" to "|Example1= |x2=") |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Function|= | {{Function|Comments= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| arma3 | | | arma3 |Game name= | ||
|1.00| | |1.00|Game version= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|Returns config path to given entry in given format |= | |Returns config path to given entry in given format |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [config, format, strict] call [[BIS_fnc_configPath]]; |= | | [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]] |= | |[[Array]], [[String]] or [[Config]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 23: | Line 23: | ||
<nowiki>[</nowiki>["configFile","CfgVehicles","Car"]] [[call]] [[BIS_fnc_configPath]]; // bin\config.cpp/CfgVehicles/Car | <nowiki>[</nowiki>["configFile","CfgVehicles","Car"]] [[call]] [[BIS_fnc_configPath]]; // bin\config.cpp/CfgVehicles/Car | ||
["bin\config.cpp/CfgVehicles/Car"] [[call]] [[BIS_fnc_configPath]]; // ["configFile","CfgVehicles","Car"] | ["bin\config.cpp/CfgVehicles/Car"] [[call]] [[BIS_fnc_configPath]]; // ["configFile","CfgVehicles","Car"] | ||
[configFile >> "CfgVehicles" >> "Car", ""] [[call]] [[BIS_fnc_configPath]]; // "configFile >> ""CfgVehicles"" >> ""Car"""</code> |= | [configFile >> "CfgVehicles" >> "Car", ""] [[call]] [[BIS_fnc_configPath]]; // "configFile >> ""CfgVehicles"" >> ""Car"""</code> |Example1= | ||
|x2= <code><nowiki>[</nowiki>["mary", "had", "a", "little", "lamb"], ""] [[call]] [[BIS_fnc_configPath]]; // "mary >> ""had"" >> ""a"" >> ""little"" >> ""lamb""" | |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 | <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> |= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|[[configHierarchy]] |= | |[[configHierarchy]] |SEEALSO= | ||
}} | }} | ||
Revision as of 13:29, 3 September 2019
Description
- Description:
- Returns config path to given entry in given format
- Execution:
- call
- Groups:
- Uncategorised
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
- See also:
- 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