Mission Parameters - Revision history

Lou Montana: Text replacement - "server.cfg" to "server config"

2024-05-17T12:36:05Z

Text replacement - "server.cfg" to "server config"

← Older revision		Revision as of 14:36, 17 May 2024
Line 2:		Line 2:
	Mission parameters are integer values that are passed to the mission at the beginning and which are used by the mission designer to customise user experience accordingly.		Mission parameters are integer values that are passed to the mission at the beginning and which are used by the mission designer to customise user experience accordingly.
	The parameters are set in [[Description.ext\|description.ext]].		The parameters are set in [[Description.ext\|description.ext]].
	They can also be either manually altered by a dedicated server admin or host during ROLE ASSIGNMENT in MP lobby from available parameters menu or by including override values in dedicated server config [[server~~.cfg~~]].		They can also be either manually altered by a dedicated server admin or host during ROLE ASSIGNMENT in MP lobby from available parameters menu or by including override values in dedicated server config [[Arma 3: Server Config File\|server config]].
	In short:		In short:

Line 46:		Line 46:
	* ''defValueParam'' - This is default option which would be passed to the mission if no selection was made. It '''must''' match one of the ''valuesParam'' values		* ''defValueParam'' - This is default option which would be passed to the mission if no selection was made. It '''must''' match one of the ''valuesParam'' values

	The chosen option value will be stored in '''param1''' or '''param2''' variable (respectfully) and then broadcast to everyone as [[publicVariable]]. As mentioned before, ''defValueParam'' value can be overridden from the server config. Here is an example of such override for both params in [[server~~.cfg~~]]:		The chosen option value will be stored in '''param1''' or '''param2''' variable (respectfully) and then broadcast to everyone as [[publicVariable]]. As mentioned before, ''defValueParam'' value can be overridden from the server config. Here is an example of such override for both params in [[Arma 3: Server Config File\|server config]]:
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
	class Missions		class Missions
Line 104:		Line 104:

	The chosen options values will be stored in '''paramsArray''' variable, in the order of appearance in the ''Params'' class and then broadcast to everyone as [[publicVariable]].		The chosen options values will be stored in '''paramsArray''' variable, in the order of appearance in the ''Params'' class and then broadcast to everyone as [[publicVariable]].
	As with primary params, the ''default'' value can be overridden from the server config using class names of the defined params. Here is an example of such override in [[server~~.cfg~~]]:		As with primary params, the ''default'' value can be overridden from the server config using class names of the defined params. Here is an example of such override in [[Arma 3: Server Config File\|server config]]:

	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">

Lou Montana: Add int-only info

2024-02-12T22:42:17Z

Add int-only info

← Older revision		Revision as of 00:42, 13 February 2024
Line 61:		Line 61:

	As with ''defValueParam'' provided override values '''must''' match one of the ''valuesParam'' values. The logged admin during ROLE ASSIGNMENT phase can still override even server override by selecting an option from parameters UI.		As with ''defValueParam'' provided override values '''must''' match one of the ''valuesParam'' values. The logged admin during ROLE ASSIGNMENT phase can still override even server override by selecting an option from parameters UI.
	{{Feature\|important\|Try to '''avoid using Primary Params''' in '''{{arma2}} v1.03''' and above and use '''Secondary Params''' instead!}}		{{Feature\|important\|Try to '''avoid using Primary Params''' in '''{{arma2}} v1.03''' and above and use '''{{Link\|#Secondary Params}}''' instead!}}

	~~===~~ Secondary Params ~~===~~		{{ArgTitle\|3\|Secondary Params\|{{GVI\|arma2\|1.03}}}}

	Secondary params were introduced with '''{{arma2}} v1.03'''. You can think of the secondary params as primary params extended and wrapped in a class called ''Params'':		Secondary params were introduced with '''{{arma2}} v1.03'''. You can think of the secondary params as primary params extended and wrapped in a class called ''Params'':
	<syntaxhighlight lang="~~javascript~~">		<syntaxhighlight lang="cpp">
	class Params		class Params
	{		{
Line 76:		Line 76:
	default = 1;		default = 1;
	};		};

	class name2		class name2
	{		{
Line 83:		Line 84:
	default = 20;		default = 20;
	};		};

	class name3		class name3
	{		{
Line 97:		Line 99:
	* ''title'' - (same as ''titleParam'') - This is the title that will be displayed in parameters menu available to server admin or host at ROLE ASSIGNMENT		* ''title'' - (same as ''titleParam'') - This is the title that will be displayed in parameters menu available to server admin or host at ROLE ASSIGNMENT
	* ''texts'' - (same as ''textsParam'') - These are options presented to the server admin or host when they double click on the title in the parameters menu		* ''texts'' - (same as ''textsParam'') - These are options presented to the server admin or host when they double click on the title in the parameters menu
	* ''values'' - (same as ''valuesParam'') - These are the actual param values for each of the text options, that will be passed to the mission accordingly to chosen option		* ''values'' - (same as ''valuesParam'') - These are the actual (numerical) param values for each of the text options, that will be passed to the mission accordingly to chosen option<!--
			-->{{Feature\|arma3\|Since {{arma3}}, ''values'' can only be integers (0, 1, 42, -33). Before it, floats were accepted (1.25, 17.2, etc).}}
	* ''default'' - (same as ''defValueParam'') - This is default option which would be passed to the mission if no selection was made. It '''must''' match one of the ''values'' values		* ''default'' - (same as ''defValueParam'') - This is default option which would be passed to the mission if no selection was made. It '''must''' match one of the ''values'' values

	The chosen options values will be stored in '''paramsArray''' variable, in the order of appearance in the ''Params'' class and then broadcast to everyone as [[publicVariable]]. As with primary params, ''default'' value can be overridden from the server config using class names of the defined params. Here is an example of such override in [[server.cfg]]:		The chosen options values will be stored in '''paramsArray''' variable, in the order of appearance in the ''Params'' class and then broadcast to everyone as [[publicVariable]].
			As with primary params, the ''default'' value can be overridden from the server config using class names of the defined params. Here is an example of such override in [[server.cfg]]:

	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
Line 121:		Line 125:
	As override values provided '''must''' match one of the ''values'' values. The logged admin during ROLE ASSIGNMENT phase can still override the server override by selecting options from parameters UI manually.		As override values provided '''must''' match one of the ''values'' values. The logged admin during ROLE ASSIGNMENT phase can still override the server override by selecting options from parameters UI manually.

	{{Feature\|warning\|You should be careful when using both primary and secondary params in the same mission as '''paramsArray''' in this case will contain both types of parameters. For example, if just secondary params used from the example above, '''paramsArray''' would look something like this: [1,20,300]. However if both types are used at the same time, '''paramsArray''' will look something like this: [900,50,1,20,30]. The primary params are added in front of the secondary params in '''paramsArray'''.}}		{{Feature\|warning\|
			You should be careful when using both primary and secondary params in the same mission as '''paramsArray''' in this case will contain both types of parameters.
			For example, if just secondary params used from the example above, '''paramsArray''' would look something like this: [1,20,300].
			However if both types are used at the same time, '''paramsArray''' will look something like this: [900,50,1,20,30]. The primary params are added in front of the secondary params in '''paramsArray'''.
			}}


Line 130:		Line 138:
	<sqf>_param = ["name2", -1] call BIS_fnc_getParamValue;</sqf>		<sqf>_param = ["name2", -1] call BIS_fnc_getParamValue;</sqf>

	This should return 20 (in default example above) or -1 if no param with this name is found. This method is good to be used in other scripts, but there is even better way of setting mission params at the start of the mission. You can instruct the game to run a function or a script of your choice automatically by including it in the secondary ''Params'' config. Note that it is not possible to do with primary params. For example:		This should return 20 (in default example above) or -1 if no param with this name is found. This method is good to be used in other scripts, but there is even better way of setting mission params at the start of the mission.
			You can instruct the game to run a function or a script of your choice automatically by including it in the secondary ''Params'' config. Note that it is not possible to do with primary params.
			For example:

	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
Line 174:		Line 184:

	{\| class="wikitable sortable"		{\| class="wikitable sortable"

	! File		! File
	! Description		! Description
Line 191:		Line 200:
	\| <syntaxhighlight lang="cpp">"\a3\functions_f\Params\paramDaytimeHour.hpp"</syntaxhighlight>		\| <syntaxhighlight lang="cpp">"\a3\functions_f\Params\paramDaytimeHour.hpp"</syntaxhighlight>
	\| Set starting hour, options are represented by whole hours		\| Set starting hour, options are represented by whole hours
	\| <syntaxhighlight lang="cpp>		\| <syntaxhighlight lang="cpp">
	// can be any integer between 0 and 23		// can be any integer between 0 and 23
	#define DAYTIMEHOUR_DEFAULT 19		#define DAYTIMEHOUR_DEFAULT 19
Line 301:		Line 310:
	</syntaxhighlight>		</syntaxhighlight>
	</spoiler>		</spoiler>


	== Extraction ==		== Extraction ==

Dedmen: 2.16 -> 2.18

2024-02-08T14:10:49Z

2.16 -> 2.18

← Older revision		Revision as of 16:10, 8 February 2024
Line 17:		Line 17:
	</gallery>		</gallery>

	Since {{GVI\|arma3\|2.16}} it is possible to deactivate automatic parameter initialization in '''singleplayer''' by setting {{hl\|BIS_fnc_initParams_skip}} to [[true]] in [[Arma 3: Functions Library\|preInit]].		Since {{GVI\|arma3\|2.18}} it is possible to deactivate automatic parameter initialization in '''singleplayer''' by setting {{hl\|BIS_fnc_initParams_skip}} to [[true]] in [[Arma 3: Functions Library\|preInit]].

	== Param Types ==		== Param Types ==

Lou Montana: Text replacement - "{{Feature|Warning|" to "{{Feature|warning|"

2024-02-01T23:24:58Z

Text replacement - "{{Feature|Warning|" to "{{Feature|warning|"

← Older revision		Revision as of 01:24, 2 February 2024
Line 121:		Line 121:
	As override values provided '''must''' match one of the ''values'' values. The logged admin during ROLE ASSIGNMENT phase can still override the server override by selecting options from parameters UI manually.		As override values provided '''must''' match one of the ''values'' values. The logged admin during ROLE ASSIGNMENT phase can still override the server override by selecting options from parameters UI manually.

	{{Feature\|~~Warning~~\|You should be careful when using both primary and secondary params in the same mission as '''paramsArray''' in this case will contain both types of parameters. For example, if just secondary params used from the example above, '''paramsArray''' would look something like this: [1,20,300]. However if both types are used at the same time, '''paramsArray''' will look something like this: [900,50,1,20,30]. The primary params are added in front of the secondary params in '''paramsArray'''.}}		{{Feature\|warning\|You should be careful when using both primary and secondary params in the same mission as '''paramsArray''' in this case will contain both types of parameters. For example, if just secondary params used from the example above, '''paramsArray''' would look something like this: [1,20,300]. However if both types are used at the same time, '''paramsArray''' will look something like this: [900,50,1,20,30]. The primary params are added in front of the secondary params in '''paramsArray'''.}}

R3vo: Added note about BIS_fnc_initParams_skip

2024-01-17T16:34:45Z

Added note about BIS_fnc_initParams_skip

← Older revision		Revision as of 18:34, 17 January 2024
Line 17:		Line 17:
	</gallery>		</gallery>

			Since {{GVI\|arma3\|2.16}} it is possible to deactivate automatic parameter initialization in '''singleplayer''' by setting {{hl\|BIS_fnc_initParams_skip}} to [[true]] in [[Arma 3: Functions Library\|preInit]].

	== Param Types ==		== Param Types ==

Lou Montana: Some wiki formatting

2024-01-15T15:00:29Z

Some wiki formatting

← Older revision		Revision as of 17:00, 15 January 2024
Line 162:		Line 162:
	</syntaxhighlight>		</syntaxhighlight>

	The ''setViewDistance.sqf'' script will be [[compile~~\|compiled~~]] and [[call~~\|called~~]] globally (''isGlobal'' = 1;) on '''every client including server''' and param value is passed to it in <sqf inline>_this select 0</sqf>.		The ''setViewDistance.sqf'' script will be [[compile]]d and [[call]]ed globally (<syntaxhighlight lang="cpp" inline>isGlobal = 1;</syntaxhighlight>) on '''every client including server''' and param value is passed to it in <sqf inline>_this select 0</sqf>.
	If for some weird reason you have both ''function'' and ''file'' entries, the priority is given to ''function''.		If for some weird reason you have both ''function'' and ''file'' entries, the priority is given to ''function''.

Line 169:		Line 169:
	'''{{arma3}}''' introduces a framework for defining commonly used params (e.g., time of the day or mission duration), which can be shared across multiple missions.		'''{{arma3}}''' introduces a framework for defining commonly used params (e.g., time of the day or mission duration), which can be shared across multiple missions.
	Once included in description.ext, they will initialize automatically. Some of them can be further customized using specific [[PreProcessor_Commands\|macros]].		Once included in description.ext, they will initialize automatically. Some of them can be further customized using specific [[PreProcessor_Commands\|macros]].
	{{Feature\|warning\|Make sure that include path to a3 mod has leading backslash (\) <syntaxhighlight lang="cpp" inline">#include "\a3\functions_f\Params\paramCountdown.hpp"</syntaxhighlight>.}}		{{Feature\|warning\|Make sure that include path to a3 mod has leading backslash (\) <syntaxhighlight lang="cpp" inline>#include "\a3\functions_f\Params\paramCountdown.hpp"</syntaxhighlight>.}}
	{{Feature\|important\|Param templates '''do not''' work with PBO missions manually copied to MPMissions folder. Unpacked missions, Steam missions and [[Mission_Export#Addon_Format\|missions which are part of an addon]] works correctly.}}		{{Feature\|important\|Param templates '''do not''' work with PBO missions manually copied to MPMissions folder. Unpacked missions, Steam missions and [[Mission_Export#Addon_Format\|missions which are part of an addon]] works correctly.}}

R3vo: /* Mission Implementation */ script is not execVMed but called

2024-01-14T20:18:12Z

Mission Implementation: script is not execVMed but called

← Older revision		Revision as of 22:18, 14 January 2024
Line 162:		Line 162:
	</syntaxhighlight>		</syntaxhighlight>

	The ''setViewDistance.sqf'' script will be [[~~execVM~~]]ed globally (''isGlobal'' = 1;) on every client and param value is passed to it in <sqf inline>_this select 0</sqf>.		The ''setViewDistance.sqf'' script will be [[compile\|compiled]] and [[call\|called]] globally (''isGlobal'' = 1;) on '''every client including server''' and param value is passed to it in <sqf inline>_this select 0</sqf>.
	If for some weird reason you have both ''function'' and ''file'' entries, the priority is given to ''function''.		If for some weird reason you have both ''function'' and ''file'' entries, the priority is given to ''function''.

Line 300:		Line 300:
	</syntaxhighlight>		</syntaxhighlight>
	</spoiler>		</spoiler>


	== Extraction ==		== Extraction ==

R3vo: /* See Also */

2023-12-20T17:17:25Z

Lou Montana: Add extraction link

2023-09-18T12:56:23Z

Add extraction link

← Older revision		Revision as of 14:56, 18 September 2023
Line 300:		Line 300:
	</syntaxhighlight>		</syntaxhighlight>
	</spoiler>		</spoiler>


			== Extraction ==

			The link below offers a script allowing to extract mission parameters in [[Description.ext]] format.
			{{Wiki\|extractionScript}}

.kju: updated SeeAlso

2023-06-18T12:17:48Z

updated SeeAlso

← Older revision		Revision as of 14:17, 18 June 2023
Line 305:		Line 305:

	* {{Link\|Description.ext#Mission Parameters}}		* {{Link\|Description.ext#Mission Parameters}}
			* [[BIS_fnc_getParamValue]]
			* [[getMissionConfigValue]]
			* [[getMissionConfig]]


	[[Category:Mission Editing]]		[[Category:Mission Editing]]

← Older revision		Revision as of 19:17, 20 December 2023
Line 312:		Line 312:
	* {{Link\|Description.ext#Mission Parameters}}		* {{Link\|Description.ext#Mission Parameters}}
	* [[BIS_fnc_getParamValue]]		* [[BIS_fnc_getParamValue]]
			* [[BIS_fnc_storeParamsValues]]
	* [[getMissionConfigValue]]		* [[getMissionConfigValue]]
	* [[getMissionConfig]]		* [[getMissionConfig]]