loadConfig

2.10

Hover & click on the images for description

⚠

Only available in Development branch(es) until its release with Arma 3 patch v2.10.

Description

Description:

Loads the given file as a Config. It can load .rvmat, .bisurf, .cpp, .bin, .sqm, and description.ext files (both binarized and unbinarized configs are supported).

⚠

Loading a config can be very slow. The config should only be loaded once and cached. For example, the result can be stored in a HashMap of File Path - Config pairs. (See Example 2)

Groups:

Config

Syntax

Syntax:

loadConfig path

Parameters:

path: String - Path to the file, which should be in a valid config format.

Return Value:

Config - Loaded config. Returns configNull if the file doesn't exist.

Examples

Example 1:

private _cfg = loadConfig "a3\data_f\default_super.rvmat"; //note: very slow! ~0.1200 ms on tested system getText (_cfg >> "Stage2" >> "uvSource");

Example 2:

//Using a cache to store loaded configs, since loading configs is very slow and should be done once. _fnc_loadConfig = { params ["_path"]; //initialize cache if not initialized yet if (isNil "TAG_configCache") then { TAG_configCache = createHashMap; }; private _cfg = TAG_configCache getOrDefault [_path, configNull]; //if path doesn't exist in the cache or cfg is null, load the config if (isNull _cfg) then { _cfg = loadConfig _path; TAG_configCache set [_path, _cfg]; }; _cfg; }; //the first call will be slow (~0.1200 ms), but subsequent calls are fast (~0.0050 ms) ["a3\data_f\default_super.rvmat"] call _fnc_loadConfig;

Example 3:

//Converting a config into hashmap _fnc_convertClass = { params ["_cfgClass"]; private _result = createHashMap; private _props = configProperties [_cfgClass, "true", true]; //Note: Hashmaps are case-sensitive. So configName cases have to be consistent (e.g. all lowercase) { if (isNumber _x) then {_result set [toLowerANSI configName _x, getNumber _x]; continue; }; if (isText _x) then {_result set [toLowerANSI configName _x, getText _x]; continue; }; if (isArray _x) then {_result set [toLowerANSI configName _x, getArray _x]; continue; }; } forEach _props; private _classes = "true" configClasses _cfgClass; { _result set [toLowerANSI configName _x, _x call _fnc_convertClass]; } forEach _classes; _result }; private _cfg = loadConfig "mission.sqm"; private _cfgMap = _cfg call _fnc_convertClass; //The following expression is similar to getNumber(_cfg >> "EditorData" >> "moveGridStep") //Notice that all strings are lowercase (which is how they were stored in hashmap) _cfgMap get "editordata" get "movegridstep";

Additional Information

See also:

>> configFile configClasses isText isNumber isArray isClass configName getText getNumber getArray

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