Mission Parameters – Arma 3

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[[Cc]ategory:[ _]?Arma[ _]3:[ _]([^|]*)[ _]?\|.*\]\]" to "{{GameCategory|arma3|$1}}")
m (Fix category)
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
Server admin / host can customize multiplayer missions in ROLE ASSIGNMENT menu using parameters prepared by the mission designer.
#REDIRECT [[Mission Parameters]]
 
Important limitation. In an MP environment, the Paramsarray is not available on the client until some time after preinit. but before postinit so any code called upon the client should take this into consideration
 
 
== Manual Params ==
 
=== Config ===
 
[[File:Arma3 Mission Parameters.png|thumb|Mission Parameters selection]]
Params are defined in [[Description.ext]].
<syntaxhighlight lang="cpp">
class Params
{
class AISkill
{
title = "AI Skill"; // Param name visible in the list
values[] = {0,1,2}; // Values; must be integers; has to have the same number of elements as 'texts'
texts[] = {"Recruit","Regular","Veteran"}; // Description of each selectable item
default = 1; // Default value; must be listed in 'values' array, otherwise 0 is used
// Default values that are not whole numbers do not work. Param will default to 0 (or 1 if defined)
};
class Daytime
{
title = "Time";
texts[] = {"Morning","Day","Evening","Night"};
values[] = {6,12,18,0};
default = 12;
function = "BIS_fnc_paramDaytime"; // (Optional) Function called when player joins, selected value is passed as an argument
isGlobal = 1; // (Optional) 1 to execute script / function locally for every player who joins, 0 to do it only on server
};
class ViewDistance
{
title = "View distance (in metres)";
values[] = {500,1000,2000,5000};
// When 'texts' are missing, values will be displayed directly instead
default = 1000;
file = "setViewDistance.sqf"; // (Optional) Script called when player joins, selected value is passed as an argument
};
};
</syntaxhighlight>
 
=== Mission ===
Selected values are stored in '''paramsArray''' array, accessible anytime during the mission on any connected computer. Their order is the same as is in description.ext (for example, params above would result in [12,1] if default values were kept).
 
'''Example (can be used in [[init.sqf]]):'''
<code>if ([[isServer]]) then
{
_skill = [0.1, 0.5, 1] [[select]] (paramsArray [[select]] 0);
{
_x [[setSkill]] _skill;
}
[[forEach]] [[allUnits]];
};</code>
 
'''setViewDistance.sqf:'''
[[setViewDistance]] ([[_this]] select 0);
 
=== Functions ===
 
<u>It is highly recommended</u> that you use [[BIS_fnc_getParamValue]] instead of paramsArray to get value of a param with given class name. It is fast and secure and globally available on any connected PC as well as JIP.
 
<code>_viewDistance = "ViewDistance" [[call]] [[BIS_fnc_getParamValue]];
_viewDistance = ["ViewDistance", 500] [[call]] [[BIS_fnc_getParamValue]];</code>
 
 
== Predefined Params ==
 
Arma 3 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 to description.ext, they will initialize automatically. Some of them can be further customized using specific [[PreProcessor_Commands|macros]].
{{Warning | Make sure that include path to a3 mod has leading backslash:
<code>#include "a3\functions_f\Params\paramCountdown.hpp" // bad</code>
<code>#include "\a3\functions_f\Params\paramCountdown.hpp" // good</code>
}}
<syntaxhighlight lang="cpp">
 
class Params
{
#define COUNTDOWN_MIN 600
#define COUNTDOWN_MAX 3600
#define COUNTDOWN_DEFAULT -1
#include "\a3\functions_f\Params\paramCountdown.hpp"
 
#define DAYTIMEHOUR_DEFAULT 19
#include "\a3\functions_f\Params\paramDaytimeHour.hpp"
 
//#define DAYTIMEPERIOD_DEFAULT 12
//#include "\a3\functions_f\Params\paramDaytimePeriod.hpp"
 
#define DEBUGCONSOLE_DEFAULT 1
#include "\a3\functions_f\Params\paramDebugConsole.hpp"
 
#define GUERFRIENDLY_DEFAULT -1
#include "\a3\functions_f\Params\paramGuerFriendly.hpp"
 
#define TICKETS_MIN 100
#define TICKETS_MAX 1100
#define TICKETS_DEFAULT -1
#include "\a3\functions_f\Params\paramRespawnTickets.hpp"
 
#define WEATHER_DEFAULT 40
#include "\a3\functions_f\Params\paramWeather.hpp"
 
#define TIMEACCELERATION_DEFAULT 10
#include "\a3\Functions_F_MP_Mark\Params\paramTimeAcceleration.hpp"
 
#define VIEW_DISTANCE_MIN 1500
#define VIEW_DISTANCE_MAX 4000
#define VIEW_DISTANCE_DEFAULT 2000
#include "\a3\Functions_F_Heli\Params\paramViewDistance.hpp"
 
    #include "\a3\Functions_F\Params\paramRevive.hpp"
 
};
</syntaxhighlight>
 
{{Important|Param templates currently don't 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.}}
 
=== Available Templates ===
{| class="wikitable sortable"
 
! File
! Description
! Optional variables
 
|-
| <code>\a3\functions_f\Params\paramCountdown.hpp</code><code>\a3\functions_f\Params\paramCountdownNoDisabled.hpp</code>
| Set mission countdown (in seconds)<br>The "NoDisabled" version has no "disabled" option, and will pick the middle option by default.
|
#define COUNTDOWN_MIN 600
#define COUNTDOWN_MAX 3600
#define COUNTDOWN_DEFAULT -1
 
|-
| <code>\a3\functions_f\Params\paramDaytimeHour.hpp</code>
| Set starting hour, options are represented by whole hours
|
{{cc|Can be any integer between 0 and 23}}
#define DAYTIMEHOUR_DEFAULT 19
 
|-
| <code>\a3\functions_f\Params\paramDaytimePeriod.hpp</code>
| Set starting hour, options are described by words
|
{{cc|Can be 0, 6, 12 or 18}}
#define DAYTIMEPERIOD_DEFAULT 12
 
|-
| <code>\a3\functions_f\Params\paramDebugConsole.hpp</code>
| Allow [[Mission_Editor:_Debug_Console_(Arma_3)|debug console]] for server host or logged in admin
|
{{cc|0 (disabled) or 1 (enabled)}}
#define DEBUGCONSOLE_DEFAULT 1
 
|-
| <code>\a3\functions_f\Params\paramGuerFriendly.hpp</code>
| Set to whom will [[independent]] side be friendly
|
{{cc|Can be any -1 (Nobody}, 0 (OPFOR), 1 (BLUFOR) or 2 (Everybody)}}
#define GUERFRIENDLY_DEFAULT -1
 
|-
| <code>\a3\functions_f\Params\paramRespawnTickets.hpp</code><code>\a3\functions_f\Params\paramRespawnTicketsNoDisabled.hpp</code>
| Set respawn tickets for all sides<br>The "NoDisabled" version has no "disabled" option, and will pick the middle option by default.
|
#define TICKETS_MIN 100
#define TICKETS_MAX 1100
#define TICKETS_DEFAULT -1
 
|-
| <code>\a3\functions_f\Params\paramWeather.hpp</code>
| Set default weather
|
{{cc|Can be 0 (sunny), 25, 50, 75 or 100 (storm))}}
#define WEATHER_DEFAULT 75
 
|-
| <code>\a3\Functions_F_MP_Mark\Params\paramTimeAcceleration.hpp</code>
| Sets a time multiplier for in-game time. See [[setTimeMultiplier|setTimeMultiplier]]
|
{{cc|Can be x1, x2, x5, x10 or x20}}
#define TIMEACCELERATION_DEFAULT 10
 
|-
| <code>\a3\Functions_F_Heli\Params\paramViewDistance.hpp</code>
| Set rendering distance, in meters. See [[setViewDistance|setViewDistance]]
|
#define VIEW_DISTANCE_MIN 1500
#define VIEW_DISTANCE_MAX 4000
#define VIEW_DISTANCE_DEFAULT 2000
|-
| <code>"\a3\Functions_F\Params\paramRevive.hpp"</code>
| Set various revive related options [[Arma 3 Revive]]
|
|}
 
 
== See Also ==
 
* [[Mission Parameters]]
* [[Description.ext#Mission_parameters|Description.ext]]
 
 
{{GameCategory|arma3|Editing}}

Latest revision as of 22:21, 24 June 2022

Redirect to:

Retrieved from "https://community.bistudio.com/wiki?title=Arma_3:_Mission_Parameters&oldid=322784"