loadConfig - Revision history

Lou Montana: Text replacement - "seperat" to "separat"

2023-05-25T14:02:22Z

Text replacement - "seperat" to "separat"

← Older revision		Revision as of 16:02, 25 May 2023
Line 92:		Line 92:
	\|text= When trying to load a terrain surface name, like you get from Ammo Eventhandlers when you hit the terrain, you can simply use		\|text= When trying to load a terrain surface name, like you get from Ammo Eventhandlers when you hit the terrain, you can simply use
	<sqf>private _config = configFile >> "CfgSurfaces" >> _surfaceName;</sqf>		<sqf>private _config = configFile >> "CfgSurfaces" >> _surfaceName;</sqf>
	You can recognize surface names by them not having any \ path ~~seperators~~ in them, they usually start with gdt, for example "gdtvrsurface01".		You can recognize surface names by them not having any \ path separators in them, they usually start with gdt, for example "gdtvrsurface01".
	}}		}}

Lou Montana: Some wiki formatting

2023-03-18T02:00:41Z

Some wiki formatting

← Older revision		Revision as of 04:00, 18 March 2023
Line 6:		Line 6:
	\|gr1= Config		\|gr1= Config

	\|descr= Loads the given file as a [[Config]], allowing easy processing of the config file contents using commands such as [[configClasses]], [[configProperties]], [[config greater greater name\|>>]], etc. It can load .rvmat, .bisurf, .cpp, .bin, .sqm, and description.ext files (both binarized and unbinarized configs are supported).		\|descr= Loads the given file as a [[Config]], allowing easy processing of the config file contents using commands such as [[configClasses]], [[configProperties]], [[config greater greater name\|>>]], etc. It can load [[Rvmat File Format\|.rvmat]], .bisurf, [[CPP File Format\|.cpp]], [[BIN File Formats\|.bin]], [[Mission.sqm\|.sqm]], and [[Description.ext\|description.ext]] files (both binarized and unbinarized configs are supported).
	{{Feature\|important\|~~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 {{hl\|File Path → Config}} pairs. (~~See~~ {{Link\|#Example 2}}).}}		{{Feature\|important\|
	~~{{Feature\|important\|~~It is advised to store the generated config in a variable, otherwise it will get destroyed if it's not being referenced directly (see {{Link\|#Example 4}})}}		* Config loading can be very slow; the config should only be loaded once and cached, e.g in a [[HashMap]] of {{hl\|File Path → Config}} pairs (see {{Link\|#Example 3}}).
			* It is advised to store the generated config in a variable, otherwise it will get destroyed if it is not being referenced directly (see {{Link\|#Example 2}}).
			}}

	\|s1= [[loadConfig]] path		\|s1= [[loadConfig]] path
Line 22:		Line 24:

	\|x2= <sqf>		\|x2= <sqf>
			// INCORRECT - the config is destroyed after the first operator >> accesses it
			getNumber (loadConfig "mission.sqm" >> "ScenarioData" >> "respawnDelay");

			// CORRECT - the config is destroyed only when the variable _cfg is destroyed
			_cfg = loadConfig "mission.sqm";
			getNumber (_cfg >> "ScenarioData" >> "respawnDelay");
			</sqf>

			\|x3= <sqf>
	// using a hashmap to cache loaded configs, since loading configs is very slow and should be done once.		// using a hashmap to cache loaded configs, since loading configs is very slow and should be done once.
	private _fnc_loadConfig = {		private _fnc_loadConfig = {
	params ["_path"];		params ["_path"];
	// initialize cache if not initialized yet		// initialize cache if not initialized yet
	if (isNil "TAG_configCache") then {		if (isNil "TAG_configCache") then
			{
	TAG_configCache = createHashMap;		TAG_configCache = createHashMap;
	};		};
	private _cfg = TAG_configCache getOrDefault [_path, configNull];		private _cfg = TAG_configCache getOrDefault [_path, configNull];
	// if path doesn't exist in the cache or cfg is null, load the config		// if path doesn't exist in the cache or cfg is null, load the config
	if (isNull _cfg) then {		if (isNull _cfg) then
			{
	_cfg = loadConfig _path;		_cfg = loadConfig _path;
	TAG_configCache set [_path, _cfg];		TAG_configCache set [_path, _cfg];
Line 41:		Line 54:
	</sqf>		</sqf>

	\|x3= <sqf>		\|x4= <sqf>
	// converting a config into hashmap		// converting a config into hashmap
	private _fnc_convertClass = {		private _fnc_convertClass = {
Line 48:		Line 61:
	private _result = createHashMap;		private _result = createHashMap;
	private _props = configProperties [_cfgClass, "true", true];		private _props = configProperties [_cfgClass, "true", true];
	// ~~Note~~: Hashmaps are case-sensitive~~. So~~ configName cases have to be consistent (e.g. all lowercase)		// 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 (isNumber _x) then { _result set [toLowerANSI configName _x, getNumber _x]; continue; };
	if (isText _x) then {_result set [toLowerANSI configName _x, getText _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; };		if (isArray _x) then { _result set [toLowerANSI configName _x, getArray _x]; continue; };
	} forEach _props;		} forEach _props;

Line 59:		Line 72:
	_result set [toLowerANSI configName _x, _x call _fnc_convertClass];		_result set [toLowerANSI configName _x, _x call _fnc_convertClass];
	} forEach _classes;		} forEach _classes;

	_result;		_result;
	};		};

	private _cfg = loadConfig "mission.sqm";		private _cfg = loadConfig "mission.sqm";
	private _cfgMap = _cfg call _fnc_convertClass;		private _cfgMap = _cfg call _fnc_convertClass;

	// ~~The~~ following expression is similar to getNumber(_cfg >> "EditorData" >> "moveGridStep")		// the following expression is similar to getNumber(_cfg >> "EditorData" >> "moveGridStep")
	// ~~Notice~~ that all strings are lowercase (which is how they were stored in hashmap)		// note that all strings are lowercase (which is how they were stored in hashmap)
	_cfgMap get "editordata" get "movegridstep";		_cfgMap get "editordata" get "movegridstep";
	</sqf>		</sqf>

	\|seealso= [[loadFile]] [[config greater greater name\|>>]] [[configFile]] [[configClasses]] [[isText]] [[isNumber]] [[isArray]] [[isClass]] [[configName]] [[getText]] [[getNumber]] [[getArray]]		\|seealso= [[loadFile]] [[config greater greater name\|>>]] [[configFile]] [[configClasses]] [[isText]] [[isNumber]] [[isArray]] [[isClass]] [[configName]] [[getText]] [[getNumber]] [[getArray]]
	~~\|x4=<sqf>~~		}}
	~~// This one fails,~~
	~~// The config is destroyed after the first operator >> accesses it,~~
	~~// because it was stored in a temporary value~~
	~~getNumber (loadConfig "mission.sqm" >> "ScenarioData" >> "respawnDelay")~~
	~~</sqf>~~
	~~<sqf>~~
	~~// This one succeeds~~
	~~// The config is destroyed only when the variable _cfg is destroyed~~
	~~_cfg = loadConfig "mission.sqm";~~
	~~getNumber (_cfg >> "ScenarioData" >> "respawnDelay")~~
	~~</sqf>~~}}

	{{Note		{{Note

Leopard20 at 19:59, 17 March 2023

2023-03-17T19:59:26Z

← Older revision		Revision as of 21:59, 17 March 2023
Line 8:		Line 8:
	\|descr= Loads the given file as a [[Config]], allowing easy processing of the config file contents using commands such as [[configClasses]], [[configProperties]], [[config greater greater name\|>>]], etc. It can load .rvmat, .bisurf, .cpp, .bin, .sqm, and description.ext files (both binarized and unbinarized configs are supported).		\|descr= Loads the given file as a [[Config]], allowing easy processing of the config file contents using commands such as [[configClasses]], [[configProperties]], [[config greater greater name\|>>]], etc. It can load .rvmat, .bisurf, .cpp, .bin, .sqm, and description.ext files (both binarized and unbinarized configs are supported).
	{{Feature\|important\|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 {{hl\|File Path → Config}} pairs. (See {{Link\|#Example 2}}).}}		{{Feature\|important\|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 {{hl\|File Path → Config}} pairs. (See {{Link\|#Example 2}}).}}
	{{Feature\|important\|It is advised to store the generated config in a variable, otherwise it will get destroyed if it's not being referenced directly (see Example 4)}}		{{Feature\|important\|It is advised to store the generated config in a variable, otherwise it will get destroyed if it's not being referenced directly (see {{Link\|#Example 4}})}}

	\|s1= [[loadConfig]] path		\|s1= [[loadConfig]] path

Leopard20: Add note about config getting destroyed when not referenced directly

2023-03-17T19:51:44Z

Add note about config getting destroyed when not referenced directly

← Older revision		Revision as of 21:51, 17 March 2023
Line 8:		Line 8:
	\|descr= Loads the given file as a [[Config]], allowing easy processing of the config file contents using commands such as [[configClasses]], [[configProperties]], [[config greater greater name\|>>]], etc. It can load .rvmat, .bisurf, .cpp, .bin, .sqm, and description.ext files (both binarized and unbinarized configs are supported).		\|descr= Loads the given file as a [[Config]], allowing easy processing of the config file contents using commands such as [[configClasses]], [[configProperties]], [[config greater greater name\|>>]], etc. It can load .rvmat, .bisurf, .cpp, .bin, .sqm, and description.ext files (both binarized and unbinarized configs are supported).
	{{Feature\|important\|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 {{hl\|File Path → Config}} pairs. (See {{Link\|#Example 2}}).}}		{{Feature\|important\|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 {{hl\|File Path → Config}} pairs. (See {{Link\|#Example 2}}).}}
			{{Feature\|important\|It is advised to store the generated config in a variable, otherwise it will get destroyed if it's not being referenced directly (see Example 4)}}

	\|s1= [[loadConfig]] path		\|s1= [[loadConfig]] path
Line 69:		Line 70:

	\|seealso= [[loadFile]] [[config greater greater name\|>>]] [[configFile]] [[configClasses]] [[isText]] [[isNumber]] [[isArray]] [[isClass]] [[configName]] [[getText]] [[getNumber]] [[getArray]]		\|seealso= [[loadFile]] [[config greater greater name\|>>]] [[configFile]] [[configClasses]] [[isText]] [[isNumber]] [[isArray]] [[isClass]] [[configName]] [[getText]] [[getNumber]] [[getArray]]
	}}		\|x4=<sqf>
			// This one fails,
			// The config is destroyed after the first operator >> accesses it,
			// because it was stored in a temporary value
			getNumber (loadConfig "mission.sqm" >> "ScenarioData" >> "respawnDelay")
			</sqf>
			<sqf>
			// This one succeeds
			// The config is destroyed only when the variable _cfg is destroyed
			_cfg = loadConfig "mission.sqm";
			getNumber (_cfg >> "ScenarioData" >> "respawnDelay")
			</sqf>}}

	{{Note		{{Note

Lou Montana: Text replacement - "\|branch= *dev " to ""

2022-08-23T12:23:56Z

Text replacement - "\|branch= *dev " to ""

← Older revision		Revision as of 14:23, 23 August 2022
Line 2:		Line 2:

	\|game1= arma3		\|game1= arma3
	~~\|branch= dev~~
	\|version1= 2.10		\|version1= 2.10

Leopard20 at 15:58, 25 July 2022

2022-07-25T15:58:40Z

← Older revision		Revision as of 17:58, 25 July 2022
Line 69:		Line 69:
	</sqf>		</sqf>

	\|seealso= [[config greater greater name\|>>]] [[configFile]] [[configClasses]] [[isText]] [[isNumber]] [[isArray]] [[isClass]] [[configName]] [[getText]] [[getNumber]] [[getArray]]		\|seealso= [[loadFile]] [[config greater greater name\|>>]] [[configFile]] [[configClasses]] [[isText]] [[isNumber]] [[isArray]] [[isClass]] [[configName]] [[getText]] [[getNumber]] [[getArray]]
	}}		}}

Lou Montana: Some wiki formatting

2022-07-11T03:33:38Z

Some wiki formatting

← Older revision		Revision as of 05:33, 11 July 2022
Line 8:		Line 8:

	\|descr= Loads the given file as a [[Config]], allowing easy processing of the config file contents using commands such as [[configClasses]], [[configProperties]], [[config greater greater name\|>>]], etc. It can load .rvmat, .bisurf, .cpp, .bin, .sqm, and description.ext files (both binarized and unbinarized configs are supported).		\|descr= Loads the given file as a [[Config]], allowing easy processing of the config file contents using commands such as [[configClasses]], [[configProperties]], [[config greater greater name\|>>]], etc. It can load .rvmat, .bisurf, .cpp, .bin, .sqm, and description.ext files (both binarized and unbinarized configs are supported).
	{{Feature \| ~~Important~~ \| 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 {{ic\|File Path - Config}} pairs. (See Example 2)}}		{{Feature\|important\|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 {{hl\|File Path → Config}} pairs. (See {{Link\|#Example 2}}).}}

	\|s1= [[loadConfig]] path		\|s1= [[loadConfig]] path

	\|p1= path: [[String]] - ~~Path~~ to the file, which should be in a valid config format.		\|p1= path: [[String]] - path to the file, which should be in a valid config format.

	\|r1= [[Config]] - ~~Loaded~~ config. Returns [[configNull]] if the file doesn't exist.		\|r1= [[Config]] - loaded config. Returns [[configNull]] if the file doesn't exist.

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

	\|x2= <sqf>// ~~Using~~ a hashmap to cache loaded configs, since loading configs is very slow and should be done once.		\|x2= <sqf>
	_fnc_loadConfig = {		// using a hashmap to cache loaded configs, since loading configs is very slow and should be done once.
			private _fnc_loadConfig = {
	params ["_path"];		params ["_path"];
	// initialize cache if not initialized yet		// initialize cache if not initialized yet
Line 27:		Line 30:
	};		};
	private _cfg = TAG_configCache getOrDefault [_path, configNull];		private _cfg = TAG_configCache getOrDefault [_path, configNull];
	// if path doesn't exist in the cache or cfg is null, load the config		// if path doesn't exist in the cache or cfg is null, load the config
	if (isNull _cfg) then {		if (isNull _cfg) then {
	_cfg = loadConfig _path;		_cfg = loadConfig _path;
Line 35:		Line 38:
	};		};
	// the first call will be slow (~0.1200 ms), but subsequent calls are fast (~0.0050 ms)		// 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;</sqf>		["a3\data_f\default_super.rvmat"] call _fnc_loadConfig;
			</sqf>

			\|x3= <sqf>
			// converting a config into hashmap
			private _fnc_convertClass = {
			params ["_cfgClass"];

	~~\|x3=<sqf>// Converting a config into hashmap~~		private _result = createHashMap;
	~~_fnc_convertClass = {~~
	~~params ["_cfgClass"];~~

	private _result = createHashMap;
	private _props = configProperties [_cfgClass, "true", true];		private _props = configProperties [_cfgClass, "true", true];
	// Note: Hashmaps are case-sensitive. So configName cases have to be consistent (e.g. all lowercase)		// 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 (isNumber _x) then {_result set [toLowerANSI configName _x, getNumber _x]; continue; };
	if (isText _x) then {_result set [toLowerANSI configName _x, getText _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; };		if (isArray _x) then {_result set [toLowerANSI configName _x, getArray _x]; continue; };
	} forEach _props;		} forEach _props;

	private _classes = "true" configClasses _cfgClass;		private _classes = "true" configClasses _cfgClass;
	{		{
	_result set [toLowerANSI configName _x, _x call _fnc_convertClass];		_result set [toLowerANSI configName _x, _x call _fnc_convertClass];
	} forEach _classes;		} forEach _classes;
	_result		_result;
	};		};
	private _cfg = loadConfig "mission.sqm";		private _cfg = loadConfig "mission.sqm";
	private _cfgMap = _cfg call _fnc_convertClass;		private _cfgMap = _cfg call _fnc_convertClass;
Line 61:		Line 66:
	// The following expression is similar to getNumber(_cfg >> "EditorData" >> "moveGridStep")		// The following expression is similar to getNumber(_cfg >> "EditorData" >> "moveGridStep")
	// Notice that all strings are lowercase (which is how they were stored in hashmap)		// Notice that all strings are lowercase (which is how they were stored in hashmap)
	_cfgMap get "editordata" get "movegridstep"; </sqf>		_cfgMap get "editordata" get "movegridstep";
			</sqf>

	\|seealso= [[config greater greater name\|>>]] [[configFile]] [[configClasses]] [[isText]] [[isNumber]] [[isArray]] [[isClass]] [[configName]] [[getText]] [[getNumber]] [[getArray]]		\|seealso= [[config greater greater name\|>>]] [[configFile]] [[configClasses]] [[isText]] [[isNumber]] [[isArray]] [[isClass]] [[configName]] [[getText]] [[getNumber]] [[getArray]]
Line 70:		Line 76:
	\|timestamp= 20220322091437		\|timestamp= 20220322091437
	\|text= When trying to load a terrain surface name, like you get from Ammo Eventhandlers when you hit the terrain, you can simply use		\|text= When trying to load a terrain surface name, like you get from Ammo Eventhandlers when you hit the terrain, you can simply use
	<sqf>		<sqf>private _config = configFile >> "CfgSurfaces" >> _surfaceName;</sqf>
	_config = configFile >> "CfgSurfaces" >> _surfaceName;
	</sqf>
	You can recognize surface names by them not having any \ path seperators in them, they usually start with gdt, for example "gdtvrsurface01".		You can recognize surface names by them not having any \ path seperators in them, they usually start with gdt, for example "gdtvrsurface01".
	}}		}}

Dedmen at 09:14, 22 March 2022

2022-03-22T09:14:37Z

← Older revision		Revision as of 11:14, 22 March 2022
Line 64:		Line 64:

	\|seealso= [[config greater greater name\|>>]] [[configFile]] [[configClasses]] [[isText]] [[isNumber]] [[isArray]] [[isClass]] [[configName]] [[getText]] [[getNumber]] [[getArray]]		\|seealso= [[config greater greater name\|>>]] [[configFile]] [[configClasses]] [[isText]] [[isNumber]] [[isArray]] [[isClass]] [[configName]] [[getText]] [[getNumber]] [[getArray]]
			}}

			{{Note
			\|user= Dedmen
			\|timestamp= 20220322091437
			\|text= When trying to load a terrain surface name, like you get from Ammo Eventhandlers when you hit the terrain, you can simply use
			<sqf>
			_config = configFile >> "CfgSurfaces" >> _surfaceName;
			</sqf>
			You can recognize surface names by them not having any \ path seperators in them, they usually start with gdt, for example "gdtvrsurface01".
	}}		}}

Leopard20 at 15:06, 18 March 2022

2022-03-18T15:06:54Z

← Older revision		Revision as of 17:06, 18 March 2022
Line 7:		Line 7:
	\|gr1= Config		\|gr1= Config

	\|descr= 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).		\|descr= Loads the given file as a [[Config]], allowing easy processing of the config file contents using commands such as [[configClasses]], [[configProperties]], [[config greater greater name\|>>]], etc. It can load .rvmat, .bisurf, .cpp, .bin, .sqm, and description.ext files (both binarized and unbinarized configs are supported).
	{{Feature \| Important \| 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 {{ic\|File Path - Config}} pairs. (See Example 2)}}		{{Feature \| Important \| 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 {{ic\|File Path - Config}} pairs. (See Example 2)}}

Leopard20: reworded comment in example

2022-03-17T13:49:33Z

reworded comment in example

← Older revision		Revision as of 15:49, 17 March 2022
Line 19:		Line 19:
	getText (_cfg >> "Stage2" >> "uvSource");</sqf>		getText (_cfg >> "Stage2" >> "uvSource");</sqf>

	\|x2= <sqf>// Using a cache ~~to store~~ loaded configs, since loading configs is very slow and should be done once.		\|x2= <sqf>// Using a hashmap to cache loaded configs, since loading configs is very slow and should be done once.
	_fnc_loadConfig = {		_fnc_loadConfig = {
	params ["_path"];		params ["_path"];