userconfig: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(added to arma 3 editing category; cleaned up formatting; rephrased;)
m (Some wiki formatting)
 
(4 intermediate revisions by 2 users not shown)
Line 8: Line 8:


'''Description.ext'''
'''Description.ext'''
class X {
<syntaxhighlight lang="cpp">
  #include "\userconfig\MY_addon\Somefile.hpp"
class X
};
{
 
#include "\userconfig\MY_addon\Somefile.hpp"
};
</syntaxhighlight>


'''\userconfig\MY_addon\Somefile.hpp'''
'''\userconfig\MY_addon\Somefile.hpp'''
class Y {
<syntaxhighlight lang="cpp">
  key = value;
class Y
}
{
key = value;
};
</syntaxhighlight>




'''Use:'''
'''Use:'''
ucval = [[getNumber]] ([[missionConfigFile]] >> "X" >> "Y" >> "key")
<sqf>_userConfigValue = getNumber (missionConfigFile >> "X" >> "Y" >> "key");</sqf>




Line 30: Line 35:
[[configFile]] is about the "global config" of unit types, vehicle types, and so on - this is the area added to by addons.
[[configFile]] is about the "global config" of unit types, vehicle types, and so on - this is the area added to by addons.


[[Category:ArmA_2:_Editing]]
 
[[Category:Arma_3:_Editing]]
{{GameCategory|arma2|Editing}}
{{GameCategory|arma3|Editing}}

Latest revision as of 17:45, 22 July 2022

How to make a Userconfig:

Some quick notes from what I learned while trying to use it for a mission. (a.k.a. What I wish somebody had written already) --MaHuJa


The \userconfig folder should be located in the root Arma 3 game directory, typically in your main Steam folder, \Steam\steamapps\common\Arma 3\


Description.ext

class X
{
	#include "\userconfig\MY_addon\Somefile.hpp"
};

\userconfig\MY_addon\Somefile.hpp

class Y
{
	key = value;
};


Use:

_userConfigValue = getNumber (missionConfigFile >> "X" >> "Y" >> "key");


Skipping class X means the user could introduce anything into the description.ext Note that #include WILL fail with a CTD if the somefile.hpp doesn't exist.

missionConfigFile is used when the mission does the include from description.ext campaignConfigFile is similar but for a campaign configFile is about the "global config" of unit types, vehicle types, and so on - this is the area added to by addons.