Difference between revisions of "Description.ext"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Arma[ _]3[ _]Tasks[ _]Overhaul\]\]" to "{{HashLinkArma 3: Task Framework#Task Overhaul}}")
(Fixed "RscTitles" section title, updated file extension warning)
(28 intermediate revisions by 4 users not shown)
Line 6: Line 6:
 
-->
 
-->
 
{{TOC|side|0.85}}
 
{{TOC|side|0.85}}
The [[Description.ext]] is used to set the overall mission attributes or to define global entites that will be available for other scripts.
+
The [[Description.ext]] is a [[missionConfigFile]] and is used to set the overall mission attributes or to define global properties that will be available for other scripts.
 
It is placed in the [[Mission Editor: External#Mission Folder|mission root folder]] and uses the same syntax as the config.cpp file, but supports only a limited number of config classes.
 
It is placed in the [[Mission Editor: External#Mission Folder|mission root folder]] and uses the same syntax as the config.cpp file, but supports only a limited number of config classes.
  
Additionally, many attributes can also be set ''via'' the [[Eden Editor]], where changes are automatically refreshed upon scenario preview.
+
Additionally, many attributes can also be set via the [[Eden Editor]], where changes are automatically refreshed upon scenario preview.
 
In the [[2D Editor]] the mission has to be reloaded for changes to be applied.
 
In the [[2D Editor]] the mission has to be reloaded for changes to be applied.
  
This file is required in [[:Category:Operation Flashpoint: Elite|OFP: Elite]] for MP missions to work, otherwise a '''-1 error''' is shown.
+
This file is required in [[:Category:Operation Flashpoint: Elite|Operation Flashpoint: Elite]] for MP missions to work, otherwise a '''-1 error''' is shown.
  
{{Informative|This page is about '''Mission Description.ext'''. For the campaign version, please go to [[Campaign Description.ext]].}}
+
{{Feature|Informative|This page is about the '''Mission Description.ext'''. For the campaign version, please go to [[Campaign Description.ext]].}}
{{Warning | The keyword <tt>class</tt> for class definitions '''must''' be lower case, otherwise a parsing error will happen. }}
+
{{Feature|Warning|The keyword <tt>class</tt> for class definitions '''must''' be lowercase, otherwise a parsing error will occur.}}
 +
{{Feature|Important|Accidentally creating this file with a wrong file extension is a frequent cause of issues. If you are unfamiliar with script file creation, read {{HashLink|Introduction to Arma Scripting#File Creation}} for a step-by-step tutorial.}}
  
  
Line 111: Line 112:
 
Defines a sound (defined in [[#CfgSounds|CfgSounds]]) that will play when accessing the gear part of the briefing. See [[Briefing.html#Advanced Briefings|Briefing.html]].
 
Defines a sound (defined in [[#CfgSounds|CfgSounds]]) that will play when accessing the gear part of the briefing. See [[Briefing.html#Advanced Briefings|Briefing.html]].
 
<syntaxhighlight lang="cpp">onBriefingGear = "SoundName";</syntaxhighlight>
 
<syntaxhighlight lang="cpp">onBriefingGear = "SoundName";</syntaxhighlight>
{{Informative|has no effect in '''Arma 3'''}}
+
{{Feature|Informative|has no effect in '''Arma 3'''}}
  
  
Line 117: Line 118:
 
Defines a sound (defined in [[#CfgSounds|CfgSounds]]) that will play when accessing the group part of the briefing. See [[Briefing.html#Advanced Briefings|Briefing.html]].
 
Defines a sound (defined in [[#CfgSounds|CfgSounds]]) that will play when accessing the group part of the briefing. See [[Briefing.html#Advanced Briefings|Briefing.html]].
 
<syntaxhighlight lang="cpp">onBriefingGroup = "SoundName";</syntaxhighlight>
 
<syntaxhighlight lang="cpp">onBriefingGroup = "SoundName";</syntaxhighlight>
{{Informative|has no effect in '''Arma 3'''}}
+
{{Feature|Informative|has no effect in '''Arma 3'''}}
  
  
Line 123: Line 124:
 
Defines a sound (defined in [[#CfgSounds|CfgSounds]]) that will play when accessing the plan part of the briefing. See [[Briefing.html#Advanced Briefings|Briefing.html]].
 
Defines a sound (defined in [[#CfgSounds|CfgSounds]]) that will play when accessing the plan part of the briefing. See [[Briefing.html#Advanced Briefings|Briefing.html]].
 
<syntaxhighlight lang="cpp">onBriefingPlan = "SoundName";</syntaxhighlight>
 
<syntaxhighlight lang="cpp">onBriefingPlan = "SoundName";</syntaxhighlight>
{{Informative|has no effect in '''Arma 3'''}}
+
{{Feature|Informative|has no effect in '''Arma 3'''}}
 
 
 
 
  
  
 +
{{ArgTitle|CfgWorlds|4|{{GVI|arma3|2.02}}}}
 +
Could be used to override the following properties used on mission loading: author, description, pictureMap, pictureShot, loadingTexts[]. If a specific world name given as a subclass, override will happen only when this world is loading. If subclass with name Any is used, then aforementioned properties would be overridden for any world that is loading.
 +
<syntaxhighlight lang=cpp>class CfgWorlds
 +
{
 +
class Any // or specific world name
 +
{
 +
author = "author";
 +
description = "description";
 +
pictureMap = "picturepath";
 +
pictureShot = "picturepath";
 +
loadingTexts[] = {"text1", "text2", "text3"};
 +
};
 +
};
 +
</syntaxhighlight>
  
 
== Respawn/Revive ==
 
== Respawn/Revive ==
 
This section talks about respawn and revive actions.
 
This section talks about respawn and revive actions.
 
* for Arma 2, see [[First Aid]].
 
* for Arma 2, see [[First Aid]].
* for Arma 3, see [[Arma 3 Respawn]] and [[Arma 3 Revive]].
+
* for Arma 3, see [[Arma 3: Respawn]] and [[Arma 3: Revive]].
  
  
Line 199: Line 212:
 
==== respawnOnStart ====
 
==== respawnOnStart ====
 
Respawn player when he joins the game. Available only for INSTANT and BASE [[#respawn|respawn types]].
 
Respawn player when he joins the game. Available only for INSTANT and BASE [[#respawn|respawn types]].
<syntaxhighlight lang="cpp">respawnOnStart = -1; // Default: 0</syntaxhighlight>
+
<syntaxhighlight lang="cpp">respawnOnStart = 0; // Default: 1</syntaxhighlight>
 
* -1 - Dont respawn on start. Don't run respawn script on start.
 
* -1 - Dont respawn on start. Don't run respawn script on start.
 
* &nbsp;0 - Dont respawn on start. Run respawn script on start.
 
* &nbsp;0 - Dont respawn on start. Run respawn script on start.
Line 207: Line 220:
 
==== respawnTemplates ====
 
==== respawnTemplates ====
 
Respawn templates from [[Arma 3 Respawn#Respawn Templates|CfgRespawnTemplates]]. You can combine any number of them together.
 
Respawn templates from [[Arma 3 Respawn#Respawn Templates|CfgRespawnTemplates]]. You can combine any number of them together.
<syntaxhighlight lang="cpp">respawnTemplates[] = { "Counter", "Wave" };</syntaxhighlight>
+
<syntaxhighlight lang="cpp">respawnTemplates[] = { "Counter", "Wave" };
{{Important|Side specific respawn templates can be specified with ''respawnTemplates'''''SIDE'''''[]'' where '''SIDE''' can be any playable side (West, East, Guer, Civ).<br>
+
</syntaxhighlight>
 +
{{Feature|important|Side specific respawn templates can be specified with ''respawnTemplates'''''SIDE'''''[]'' where '''SIDE''' can be any playable side (West, East, Guer, Civ).<br>
 
When such is undefined, general respawnTemplates are used instead.}}
 
When such is undefined, general respawnTemplates are used instead.}}
  
Line 214: Line 228:
 
{{ArgTitle|respawnWeapons|4|{{GVI|arma1|1.00}}}}
 
{{ArgTitle|respawnWeapons|4|{{GVI|arma1|1.00}}}}
 
Set weapons players will receive upon respawn. [[#respawnMagazines|respawnMagazines]] has to be defined as well.
 
Set weapons players will receive upon respawn. [[#respawnMagazines|respawnMagazines]] has to be defined as well.
<syntaxhighlight lang="cpp">respawnWeapons[] = { "arifle_Katiba_GL_F" };</syntaxhighlight>
+
<syntaxhighlight lang="cpp">respawnWeapons[] = { "arifle_Katiba_GL_F" };
{{Important|Side specific respawn weapons can be specified with ''respawnWeapons'''''SIDE'''''[]'' where '''SIDE''' can be any playable side (West, East, Guer, Civ).<br>
+
</syntaxhighlight>
 +
{{Feature|important|Side specific respawn weapons can be specified with ''respawnWeapons'''''SIDE'''''[]'' where '''SIDE''' can be any playable side (West, East, Guer, Civ).<br>
 
Corresponding ''respawnMagazines'''''SIDE'''''[]'' has to be defined as well.}}
 
Corresponding ''respawnMagazines'''''SIDE'''''[]'' has to be defined as well.}}
  
Line 221: Line 236:
 
{{ArgTitle|respawnMagazines|4|{{GVI|arma1|1.00}}}}
 
{{ArgTitle|respawnMagazines|4|{{GVI|arma1|1.00}}}}
 
Set magazines players will receive upon respawn. [[#respawnWeapons|respawnWeapons]] has to be defined as well.
 
Set magazines players will receive upon respawn. [[#respawnWeapons|respawnWeapons]] has to be defined as well.
<syntaxhighlight lang="cpp">respawnMagazines[] = { "30Rnd_65x39_caseless_green", "30Rnd_65x39_caseless_green" };</syntaxhighlight>
+
<syntaxhighlight lang="cpp">respawnMagazines[] = { "30Rnd_65x39_caseless_green", "30Rnd_65x39_caseless_green" };
{{Important|Side specific respawn weapons can be specified with ''respawnMagazines'''''SIDE'''''[]'' where '''SIDE''' can be any playable side (West, East, Guer, Civ).<br>
+
</syntaxhighlight>
 +
{{Feature|important|Side specific respawn weapons can be specified with ''respawnMagazines'''''SIDE'''''[]'' where '''SIDE''' can be any playable side (West, East, Guer, Civ).<br>
 
Corresponding ''respawnWeapons'''''SIDE'''''[]'' has to be defined as well.}}
 
Corresponding ''respawnWeapons'''''SIDE'''''[]'' has to be defined as well.}}
  
Line 400: Line 416:
 
Activated keys can be found in user profile (e.g documents\''username.Arma3profile'') under ''activeKeys'' section.<br>
 
Activated keys can be found in user profile (e.g documents\''username.Arma3profile'') under ''activeKeys'' section.<br>
 
See also commands [[activateKey]], [[isKeyActive]] and [[deActivateKey]] for more detailed information.
 
See also commands [[activateKey]], [[isKeyActive]] and [[deActivateKey]] for more detailed information.
{{Important|Please note that unlike other text items, [[Stringtable.xml|stringtable]] translations ($STR_*) cannot be used.}}
+
{{Feature|important|Please note that unlike other text items, [[Stringtable.xml|stringtable]] translations ($STR_*) cannot be used.}}
  
  
 
{{ArgTitle|keys|4|{{GVI|arma1|1.00}}}}
 
{{ArgTitle|keys|4|{{GVI|arma1|1.00}}}}
 
List of keys from which [[#keysLimit|keysLimit]] counts the ''done'' ones.
 
List of keys from which [[#keysLimit|keysLimit]] counts the ''done'' ones.
<syntaxhighlight lang="cpp">keys[] = { "key1", "key2", "key3" };</syntaxhighlight>
+
<syntaxhighlight lang="cpp">keys[] = { "key1", "key2", "key3" };
 +
</syntaxhighlight>
  
  
Line 415: Line 432:
 
{{ArgTitle|doneKeys|4|{{GVI|arma1|1.00}}}}
 
{{ArgTitle|doneKeys|4|{{GVI|arma1|1.00}}}}
 
Name of keys marked ''done'' on mission completion.
 
Name of keys marked ''done'' on mission completion.
<syntaxhighlight lang="cpp">doneKeys[] = { "key4" };</syntaxhighlight>
+
<syntaxhighlight lang="cpp">doneKeys[] = { "key4" };
 +
</syntaxhighlight>
  
  
Line 447: Line 465:
 
* HUD weapon cursors
 
* HUD weapon cursors
 
* Vehicle display panels
 
* Vehicle display panels
 +
* Kill messages
 +
* 3D Icons visibility
 
<syntaxhighlight lang="cpp">showHUD = 0; // 0: disabled - 1: enabled. Default: 1</syntaxhighlight>
 
<syntaxhighlight lang="cpp">showHUD = 0; // 0: disabled - 1: enabled. Default: 1</syntaxhighlight>
  
 
The effect of using the above '''showHUD''' param is different from the effects of [[showHUD]] scripting command, both methods are rather complementary to each other.<br>
 
The effect of using the above '''showHUD''' param is different from the effects of [[showHUD]] scripting command, both methods are rather complementary to each other.<br>
Since Arma 3 v1.49.131879 '''showHUD''' param can be an array to allow control over separate HUD elements, for example:
+
Since Arma 3 v1.50 '''showHUD''' param can be an array to allow control over separate HUD elements, for example:
 
<syntaxhighlight lang="cpp">
 
<syntaxhighlight lang="cpp">
 
showHUD[] = {
 
showHUD[] = {
Line 462: Line 482:
 
1, // HUD weapon cursors
 
1, // HUD weapon cursors
 
1, // Vehicle display panels
 
1, // Vehicle display panels
1 // "x killed by y" systemChat messages
+
1, // "x killed by y" systemChat messages
 +
1 // force show drawIcon3D icons
 
};
 
};
 
</syntaxhighlight>
 
</syntaxhighlight>
{{Important | using the '''showHUD[]''' array parameter will disable the [[showHUD]] command entirely.}}
+
{{Feature | important | using the '''showHUD[]''' array parameter will disable the [[showHUD]] command entirely.}}
  
  
Line 476: Line 497:
 
Enables/Disables the GPS.
 
Enables/Disables the GPS.
 
<syntaxhighlight lang="cpp">showGPS = 0; // 0: disabled - 1: enabled. Default: 1</syntaxhighlight>
 
<syntaxhighlight lang="cpp">showGPS = 0; // 0: disabled - 1: enabled. Default: 1</syntaxhighlight>
In [[ArmA]] ''1.04'' toggle this option to disable the mini map attached to the GPS.
+
In [[{{arma1}}]] ''1.04'' toggle this option to disable the mini map attached to the GPS.
  
  
Line 483: Line 504:
 
''See also [[BIS_fnc_groupIndicator]]''
 
''See also [[BIS_fnc_groupIndicator]]''
 
<syntaxhighlight lang="cpp">showGroupIndicator = 1; // 0: disabled - 1: enabled. Default: 0</syntaxhighlight>
 
<syntaxhighlight lang="cpp">showGroupIndicator = 1; // 0: disabled - 1: enabled. Default: 0</syntaxhighlight>
{{Important|Has no effect since custom panels were introduced in Arma 3}}
+
{{Feature|important|Has no effect since custom panels were introduced in Arma 3}}
  
  
Line 514: Line 535:
 
Defines if the Squad Radar is visible.
 
Defines if the Squad Radar is visible.
 
<syntaxhighlight lang="cpp">showSquadRadar = 0; // 0: disabled - 1: enabled. Default: 0</syntaxhighlight>
 
<syntaxhighlight lang="cpp">showSquadRadar = 0; // 0: disabled - 1: enabled. Default: 0</syntaxhighlight>
{{Important|Has no effect since custom panels were introduced in Arma 3}}
+
{{Feature|important|Has no effect since custom panels were introduced in Arma 3}}
  
  
Line 567: Line 588:
 
{{ArgTitle|arsenalRestrictedItems|4|{{GVI|arma3|1.98}}}}
 
{{ArgTitle|arsenalRestrictedItems|4|{{GVI|arma3|1.98}}}}
 
Used to blacklist undesired [[Arma 3 Arsenal|Arsenal]] equipment, which prevents user saved loadout from being loaded if it contains restricted items.
 
Used to blacklist undesired [[Arma 3 Arsenal|Arsenal]] equipment, which prevents user saved loadout from being loaded if it contains restricted items.
<syntaxhighlight lang="cpp">arsenalRestrictedItems[] = { "U_B_Soldier_VR" };</syntaxhighlight>
+
<syntaxhighlight lang="cpp">arsenalRestrictedItems[] = { "U_B_Soldier_VR" };
 
+
</syntaxhighlight>
  
  
 +
{{ArgTitle|allowProfileGlasses|4|{{GVI|arma3|2.04}}}}
 +
When set to 0 will stop glasses set in player profile from being added to player's gear:
 +
<syntaxhighlight lang="cpp">
 +
allowProfileGlasses = 0;
 +
</syntaxhighlight>
  
  
Line 646: Line 672:
 
Other popular uses include accelerate time, setting the mission difficulty or switching the intro on/off.
 
Other popular uses include accelerate time, setting the mission difficulty or switching the intro on/off.
  
{{Important|While '''param1'''/'''param2''' were introduced in '''OFP:CWC''' and can still be used in later titles, it is '''highly recommended''' to use config class [[#params|params]].}}
+
{{Feature|important|While '''param1'''/'''param2''' were introduced in '''OFP:CWC''' and can still be used in later titles, it is '''highly recommended''' to use config class [[#params|params]].}}
  
 
In the mission, variables '''param1''' and '''param2''' have the corresponding values of the chosen options.
 
In the mission, variables '''param1''' and '''param2''' have the corresponding values of the chosen options.
Line 657: Line 683:
 
valuesParam2[] = { 10000, 5, 7, 10, 15, 20, 25, 30 };
 
valuesParam2[] = { 10000, 5, 7, 10, 15, 20, 25, 30 };
 
defValueParam2 = 5;
 
defValueParam2 = 5;
textsParam2[] = { "Unlimited", 5, 7, 10, 15, 20, 25, 30 };</syntaxhighlight>
+
textsParam2[] = { "Unlimited", 5, 7, 10, 15, 20, 25, 30 };
 +
</syntaxhighlight>
  
 
Example:
 
Example:
Line 731: Line 758:
 
};
 
};
 
</syntaxhighlight>
 
</syntaxhighlight>
'''For a detailed description, see [[Arma 3 Debriefing]].'''
+
'''For a detailed description, see [[Arma 3: Debriefing]].'''
  
  
Line 754: Line 781:
  
 
{| class="wikitable" style="float: right; margin: 0 0 0 1em; text-align: center; max-width: 50%;"
 
{| class="wikitable" style="float: right; margin: 0 0 0 1em; text-align: center; max-width: 50%;"
!colspan="7"|channel ID number correspondence
+
! colspan="7" | [[Channel IDs|Channel ID]] number command correspondence
 
|-
 
|-
|Global
+
| Global
|Side
+
| Side
|Command
+
| Command
|Group
+
| Group
|Vehicle
+
| Vehicle
|Direct
+
| Direct
|System
+
| System
 
|-
 
|-
|0
+
| 0
|1
+
| 1
|2
+
| 2
|3
+
| 3
|4
+
| 4
|5
+
| 5
|6
+
| {{n/a}}
 +
|-
 +
| [[globalRadio]]
 +
| [[sideRadio]]
 +
| [[commandRadio]]
 +
| [[groupRadio]]
 +
| [[vehicleRadio]]
 +
| [[directSay]]
 +
| {{n/a}}
 +
|-
 +
| [[globalChat]]
 +
| [[sideChat]]
 +
| [[commandChat]]
 +
| [[groupChat]]
 +
| [[vehicleChat]]
 +
| {{n/a}}
 +
| [[systemChat]]
 
|}
 
|}
 
{{ArgTitle|disableChannels|4|{{GVI|arma2oa|1.62}}}}
 
{{ArgTitle|disableChannels|4|{{GVI|arma2oa|1.62}}}}
 
Disable global, side, command or system chat. MOTD and admin say have exception and will show in global.
 
Disable global, side, command or system chat. MOTD and admin say have exception and will show in global.
  
'''basic syntax''': {{since|arma2oa|1.60.93398|y}}
+
{{GVI|arma2oa|1.62}} '''basic syntax''':  
 
<syntaxhighlight lang="cpp">disableChannels[] = { 0, 3 }; // simple channel ID list</syntaxhighlight>
 
<syntaxhighlight lang="cpp">disableChannels[] = { 0, 3 }; // simple channel ID list</syntaxhighlight>
  
'''advanced syntax''': {{since|arma3|1.60|y}}
+
{{GVI|arma3|1.60}} '''advanced syntax''':
 
<syntaxhighlight lang="cpp">
 
<syntaxhighlight lang="cpp">
 
disableChannels[] = {
 
disableChannels[] = {
Line 789: Line 832:
 
};
 
};
 
</syntaxhighlight>
 
</syntaxhighlight>
{{Warning | There is a [https://feedback.bistudio.com/T67948 known] [https://feedback.bistudio.com/T117205 issue] where this restriction is not applied to [[Multiplayer Scripting#Join In Progress|JIP]] players. In the meantime, use the [[enableChannel]] scripting command in e.g [[Event Scripts|init.sqf]] or [[Event Scripts|initPlayerLocal.sqf]].<br>
 
The issue '''has been fixed''' in [https://forums.bohemia.net/forums/topic/140837-development-branch-changelog/?do{{=}}findComment&comment{{=}}3414352 {{arma3}} v1.99.146550].}}
 
  
  
Line 796: Line 837:
 
Multiplayer setting that removes all playable units which do not have a human player.<br>
 
Multiplayer setting that removes all playable units which do not have a human player.<br>
 
When AI is disabled, a player logging out will '''not''' have AI take control of his character.
 
When AI is disabled, a player logging out will '''not''' have AI take control of his character.
{{Important|Disabling AI units will prevent [[Multiplayer Scripting#Join In Progress|JIP]] into playable units if '''respawn''' is disabled.}}
+
{{Feature|important|Disabling AI units will prevent [[Multiplayer Scripting#Join In Progress|JIP]] into playable units if '''respawn''' is disabled.}}
 
<syntaxhighlight lang="cpp">disabledAI = 1; // 0: disabled - 1: enabled. Default: 0</syntaxhighlight>
 
<syntaxhighlight lang="cpp">disabledAI = 1; // 0: disabled - 1: enabled. Default: 0</syntaxhighlight>
  
Line 802: Line 843:
 
{{ArgTitle|disableRandomization|4|{{GVI|arma3|1.42}}}}
 
{{ArgTitle|disableRandomization|4|{{GVI|arma3|1.42}}}}
 
Disables randomization on certain objects, object types or object kinds in the mission. For more information visit: [[Vehicle Customization (VhC)]]
 
Disables randomization on certain objects, object types or object kinds in the mission. For more information visit: [[Vehicle Customization (VhC)]]
<syntaxhighlight lang="cpp">disableRandomization[] = { "All", "AllVehicles", "B_G_Offroad_01_F", "myCar", "MyUnitName", "B_Soldier_F" };</syntaxhighlight>
+
<syntaxhighlight lang="cpp">disableRandomization[] = { "All", "AllVehicles", "B_G_Offroad_01_F", "myCar", "MyUnitName", "B_Soldier_F" };
 +
</syntaxhighlight>
 
Note: This takes higher priority and will override the following:
 
Note: This takes higher priority and will override the following:
 
  _vehicle [[setVariable]] ["BIS_enableRandomization", [[true]]]; {{cc|Cannot enable for all or specific vehicles once disabled in description.ext}}
 
  _vehicle [[setVariable]] ["BIS_enableRandomization", [[true]]]; {{cc|Cannot enable for all or specific vehicles once disabled in description.ext}}
Line 849: Line 891:
 
avgScore = 1800;
 
avgScore = 1800;
 
maxScore = 75000;</syntaxhighlight>
 
maxScore = 75000;</syntaxhighlight>
{{Important|Values have to follow this formula: '''minScore < avgScore < maxScore'''. Any other combinations can lead to game freeze upon mission end.
+
{{Feature|important|Values have to follow this formula: '''minScore < avgScore < maxScore'''. Any other combinations can lead to game freeze upon mission end.
 
}}
 
}}
  
Line 864: Line 906:
 
onPauseScript[] = { myOnPauseFunction1, myOnPauseFunction2 }; // function name - since Arma 3</syntaxhighlight>
 
onPauseScript[] = { myOnPauseFunction1, myOnPauseFunction2 }; // function name - since Arma 3</syntaxhighlight>
  
{{Important|The script or function executes '''in its own [[Namespace|namespace]]'''. In order to get/set external global variable you need to explicitly use mission namespace:
+
{{Feature|important|The script or function executes '''in its own [[Namespace|namespace]]'''. In order to get/set external global variable you need to explicitly use mission namespace:
 
<code>'''Set:'''
 
<code>'''Set:'''
 
// myVar2 {{=}} "345"; {{cc|will set the variable only in onPauseScript namespace}}
 
// myVar2 {{=}} "345"; {{cc|will set the variable only in onPauseScript namespace}}
Line 919: Line 961:
 
== Tasks ==
 
== Tasks ==
 
Tasks are part of the mission. This section deals with the settings for them.<br>
 
Tasks are part of the mission. This section deals with the settings for them.<br>
See also {{HashLinkArma 3: Task Framework#Task Overhaul}}
+
See also {{HashLink|Arma 3: Task Framework#Task Overhaul}}
  
  
Line 1,054: Line 1,096:
 
Example:
 
Example:
 
  [[showCinemaBorder]] false;
 
  [[showCinemaBorder]] false;
  _dur = [[getNumber]] ([[missionConfigFile]] >> "CfgCameraEffects" >> "Array" >> [[_this]] >> "duration");
+
  _dur = [[getNumber]] ([[missionConfigFile]] >> "CfgCameraEffects" >> "Array" >> [[Magic Variables#this|_this]] >> "duration");
 
  _cam = "camera" [[camCreate]] ([[player]] [[modelToWorld]] [0, -100, 50]);
 
  _cam = "camera" [[camCreate]] ([[player]] [[modelToWorld]] [0, -100, 50]);
 
  _cam [[camSetTarget]] [[player]];
 
  _cam [[camSetTarget]] [[player]];
Line 1,083: Line 1,125:
 
};
 
};
 
</syntaxhighlight>
 
</syntaxhighlight>
{{Informative | Some domains are automatically whitelisted, such as "arma3.com" or "bistudio.com".}}
+
{{Feature | Informative | Some domains are automatically whitelisted, such as "arma3.com" or "bistudio.com".}}
  
  
Line 1,146: Line 1,188:
 
Example:
 
Example:
 
  [[playMusic]] "MyIntro";
 
  [[playMusic]] "MyIntro";
{{Important|Setting volume (db) of music far from zero will disable [[fadeMusic]] command. Optimal values are from -10 to 10.}}
+
{{Feature|important|Setting volume (db) of music far from zero will disable [[fadeMusic]] command. Optimal values are from -10 to 10.}}
  
  
Line 1,257: Line 1,299:
 
See [http://ofp.toadlife.net/downloads/tutorials/tutorial_sound/tutorial_sound.html| OFP ToadLife's tutorial] for more detailed information.
 
See [http://ofp.toadlife.net/downloads/tutorials/tutorial_sound/tutorial_sound.html| OFP ToadLife's tutorial] for more detailed information.
  
{{Informative | You may at some point find volume defined with '''db''' (e.g {{Inline code|db-40}}). The formula for db-based volume is: {{Inline code|10^(''number''*(1/20))}}.}}
+
{{Feature | Informative | You may at some point find volume defined with '''db''' (e.g {{ic|db-40}}). The formula for db-based volume is: {{ic|10^(''number''*(1/20))}}.}}
  
{{Feature|arma3 | Since Arma 3 v1.49.131710 it is possible to define AddOn sounds in mission config. In order to make engine look for the sound in AddOn, the sound path must start with '''@''' (instead of '''\''') for example:
+
{{Feature | arma3 | Since Arma 3 v1.50 it is possible to define AddOn sounds in mission config. In order to make engine look for the sound in AddOn, the sound path must start with '''@''' (instead of '''\''') for example:
 
<syntaxhighlight lang="cpp">
 
<syntaxhighlight lang="cpp">
 
class CfgSounds
 
class CfgSounds
Line 1,276: Line 1,318:
  
 
{{ArgTitle|CfgUnitInsignia|4|{{GVI|arma3|1.24}}}}
 
{{ArgTitle|CfgUnitInsignia|4|{{GVI|arma3|1.24}}}}
Define custom unit insignia (shoulder patches). See [[Arma 3 Unit Insignia]] for more detailed information.
+
Define custom unit insignia (shoulder patches). See [[Arma 3: Unit Insignia]] for more detailed information.
 
<syntaxhighlight lang="cpp">
 
<syntaxhighlight lang="cpp">
 
class CfgUnitInsignia
 
class CfgUnitInsignia
Line 1,338: Line 1,380:
  
 
{{ArgTitle|CfgVehicles|4|{{GVI|arma3|1.70}}}}
 
{{ArgTitle|CfgVehicles|4|{{GVI|arma3|1.70}}}}
This class can only be used to [[createSoundSource|create sound sources]] (since Arma 3 v1.69.141183).<br>
+
This class can only be used to [[createSoundSource|create sound sources]] (since Arma 3 v1.70).<br>
 
See also [[#CfgSFX|CfgSFX]] for more detailed information.
 
See also [[#CfgSFX|CfgSFX]] for more detailed information.
 
<syntaxhighlight lang="cpp">
 
<syntaxhighlight lang="cpp">
Line 1,375: Line 1,417:
  
  
==== rscTitles ====
+
==== RscTitles ====
Defines custom UI [[Arma: GUI Configuration|displays]]. To show such displays, use [[cutRsc]] or [[titleRsc]].
+
This class is used to define custom HUDs. See [[Arma: GUI Configuration]] for more information.
 
 
  
[[Category:Operation Flashpoint: Editing]]
+
[[Category:Mission Editing]]
[[Category:ArmA: Mission Editing]]
 
{{GameCategory|arma2|Editing}}
 
[[Category:Take On Helicopters: Editing]]
 
{{GameCategory|arma3|Editing}}
 
[[Category:Mission Editor]]
 

Revision as of 20:23, 15 June 2021

Contents

The Description.ext is a missionConfigFile and is used to set the overall mission attributes or to define global properties that will be available for other scripts. It is placed in the mission root folder and uses the same syntax as the config.cpp file, but supports only a limited number of config classes.

Additionally, many attributes can also be set via the Eden Editor, where changes are automatically refreshed upon scenario preview. In the 2D Editor the mission has to be reloaded for changes to be applied.

This file is required in Operation Flashpoint: Elite for MP missions to work, otherwise a -1 error is shown.

This page is about the Mission Description.ext. For the campaign version, please go to Campaign Description.ext.
The keyword class for class definitions must be lowercase, otherwise a parsing error will occur.
Accidentally creating this file with a wrong file extension is a frequent cause of issues. If you are unfamiliar with script file creation, read Introduction to Arma Scripting - File Creation for a step-by-step tutorial.


Mission information

This section helps you find out how to customise Mission overall external appearance, from Mission Overview to Loading Screens.


Loading screen parameters
Loading screen example
author			= "Varanon";
onLoadName		= "Point Insertion";
onLoadMission	= "A group of NATO soldiers is tasked with sabotaging a coastal defense.";
loadScreen		= "images\loadScreen.paa";

class Header
{
	gameType =  Coop;	// Game type
	minPlayers =  1;	// minimum number of players the mission supports
	maxPlayers = 10;	// maximum number of players the mission supports
};


author

Mission author's name. The default loading screen shows this string below the onLoadName in a smaller font prefixed by "by ".


onLoadName

String (usually mission name) shown during mission loading. The string is shown in a slightly larger font above the loadScreen. The onLoadMission text is placed below the load screen and the header gameType determines the game type on top of the box.


onLoadMission

Displays a message while the mission is loading. Note that a mission that takes very little time to load will only display the message for a short time. In OFP:CWC this is the name you see when selecting a mission in MP and also the name that is presented to the Multiplayer browser.

onLoadMission = "YourMissionName";


loadScreen

The picture to be shown while the mission is loaded. The path is relative to the mission folder. Must be in PAA file format. 2:1 aspect ratio (different aspect are rendered correctly as well, but won't cover the whole area). Ideally 1024x512 pixels.

loadScreen = "pictures\intro.paa";


header

This class defines mission type and other settings displayed in the multiplayer browser.

class Header
{
	gameType =  CTF;	// Game type
	minPlayers =  1;	// minimum number of players the mission supports
	maxPlayers = 10;	// maximum number of players the mission supports
};

See Multiplayer Game Types for more detailed information.


onLoadIntro

Displays a message while the intro is loading.

onLoadIntro = "YourMessage";


onLoadMissionTime

Define whether you will see the time and date displayed while the mission loads. Effect unkown in Arma 3.

onLoadMissionTime = 1; // 0: disabled - 1: enabled. Default: 1


onLoadIntroTime

Define whether you will see the time and date displayed while the intro loads.

onLoadIntroTime = 1; // 0: disabled - 1: enabled. Default: 0


briefingName

Mission name displayed in the mission selection menu.

briefingName = "TAG 1-5 CO My super mission";


CfgLoadingTexts

Define mission specific loading texts.

overviewPicture

Path to image which will be displayed when the mission is highlighted on the mission selection screen. Image should be .paa format and in 2:1 aspect ratio – ideally 1024x512 (Arma 3).


overviewText

Text to be displayed below the overviewPicture on the mission selection screen when the mission is available to play.


overviewTextLocked

Text to be displayed below the overviewPicture on the mission selection screen when the mission is locked from play.


onBriefingGear

Defines a sound (defined in CfgSounds) that will play when accessing the gear part of the briefing. See Briefing.html.

onBriefingGear = "SoundName";
has no effect in Arma 3


onBriefingGroup

Defines a sound (defined in CfgSounds) that will play when accessing the group part of the briefing. See Briefing.html.

onBriefingGroup = "SoundName";
has no effect in Arma 3


onBriefingPlan

Defines a sound (defined in CfgSounds) that will play when accessing the plan part of the briefing. See Briefing.html.

onBriefingPlan = "SoundName";
has no effect in Arma 3


CfgWorlds

Could be used to override the following properties used on mission loading: author, description, pictureMap, pictureShot, loadingTexts[]. If a specific world name given as a subclass, override will happen only when this world is loading. If subclass with name Any is used, then aforementioned properties would be overridden for any world that is loading.

class CfgWorlds
{
	class Any // or specific world name
	{
		author = "author";
		description = "description";
		pictureMap = "picturepath";
		pictureShot = "picturepath";
		loadingTexts[] = {"text1", "text2", "text3"};
	};
};

Respawn/Revive

This section talks about respawn and revive actions.


Respawn types
ID Text version Description
0 "NONE" No respawn
1 "BIRD" Respawn as a seagull
2 "INSTANT" Respawn just where you died.
3 "BASE" Respawn in base.
A respawn marker is needed. If no marker is defined, respawn behaviour will be the same as "INSTANT".
Marker role names:
  • Unit respawn: respawn_SIDE
  • Vehicle respawn: respawn_vehicle_SIDE

Side can be one of west, east, guerrila (sic), civilian, e.g respawn_west.
Any suffix (eg: respawn_westABC, respawn_west_1, etc) will allow multiple random respawn points.

4 "GROUP" Respawn in your group. If there is no remaining AI, you will become a seagull.
5 "SIDE" Logo A1 black.png1.08 Respawn into an AI unit on your side (if there's no AI left, you'll become a seagull).
With this respawn type, team switch is also available to any AI controlled playable units.

respawn

Sets respawn type.

respawn = 0;		// Default: 0 for SP, 1 for MP
respawn = "SIDE";	// text version works too


respawnButton

Enable or disable the respawn button in the menu for INSTANT and BASE respawn types.

respawnButton = 0; // 0: disabled - 1: enabled. Default: 1


respawnDelay

Set respawn delay in seconds.

respawnDelay = 42; // Default: ?


respawnVehicleDelay

Set vehicle respawn delay in seconds.

respawnVehicleDelay = 12; // Default: ?


respawnDialog

Show the scoreboard and respawn countdown timer for a player if he is killed with respawn type 3.

respawnDialog = 0; // 0: disabled - 1: enabled. Default: 1


respawnOnStart

Respawn player when he joins the game. Available only for INSTANT and BASE respawn types.

respawnOnStart = 0; // Default: 1
  • -1 - Dont respawn on start. Don't run respawn script on start.
  •  0 - Dont respawn on start. Run respawn script on start.
  •  1 - Respawn on start. Run respawn script on start.


respawnTemplates

Respawn templates from CfgRespawnTemplates. You can combine any number of them together.

respawnTemplates[] = { "Counter", "Wave" };
Side specific respawn templates can be specified with respawnTemplatesSIDE[] where SIDE can be any playable side (West, East, Guer, Civ).
When such is undefined, general respawnTemplates are used instead.


respawnWeapons

Set weapons players will receive upon respawn. respawnMagazines has to be defined as well.

respawnWeapons[] = { "arifle_Katiba_GL_F" };
Side specific respawn weapons can be specified with respawnWeaponsSIDE[] where SIDE can be any playable side (West, East, Guer, Civ).
Corresponding respawnMagazinesSIDE[] has to be defined as well.


respawnMagazines

Set magazines players will receive upon respawn. respawnWeapons has to be defined as well.

respawnMagazines[] = { "30Rnd_65x39_caseless_green", "30Rnd_65x39_caseless_green" };
Side specific respawn weapons can be specified with respawnMagazinesSIDE[] where SIDE can be any playable side (West, East, Guer, Civ).
Corresponding respawnWeaponsSIDE[] has to be defined as well.


reviveMode

Define if Revive mode is enabled.

reviveMode = 1; // Default: 0
  • 0 - disabled
  • 1 - enabled
  • 2 - controlled by player attributes


reviveUnconsciousStateMode

Define revive mode.

reviveUnconsciousStateMode = 0; // Default: 0
  • 0 - basic mode
  • 1 - advanced mode
  • 2 - realistic

See damage model for more detailed information.


reviveRequiredTrait

Define if only a medic (or unit with medic trait) can perform a revive.

reviveRequiredTrait = 0; // 0: disabled - 1: enabled. Default: 0


reviveRequiredItems

Define if a medical item (first aid kit or medkit) is required to begin a revive process.

reviveRequiredItems = 2; // Default: ?
  • 0 - none
  • 1 - medkit
  • 2 - medkit or first aid kit


reviveRequiredItemsFakConsumed

Define if a first aid kit is consumed on reviving a teammate

reviveRequiredItemsFakConsumed = 1; // 0: disabled - 1: enabled. Default: ?


reviveMedicSpeedMultiplier

Speed multiplier for revive performed by medic

reviveMedicSpeedMultiplier = 2; // medic revive will be two times faster compared to another soldier


reviveDelay

The time in seconds it takes to revive an incapacitated unit. Having a Medikit will halve this time.

reviveDelay = 10; // Default: 6


reviveForceRespawnDelay

The time in seconds it takes for an incapacitated unit to force their respawn.

reviveForceRespawnDelay = 5; // Default: 3


reviveBleedOutDelay

The time in seconds it takes for a unit to bleed out.

reviveBleedOutDelay = 300; // Default: 120


enablePlayerAddRespawn

Usage unsure, may be related to respawn template MenuPosition.

enablePlayerAddRespawn = 0; // Disable framework respawn


CfgRespawnInventory

This class defines a respawn inventory, used with MenuInventory respawn template. Loadouts with no assigned role are automatically assigned to the "Default" role.
See also BIS_fnc_addRespawnInventory, BIS_fnc_removeRespawnInventory

class CfgRespawnInventory
{
	class Blufor1
	{
		displayName = "Light";									// Name visible in the menu
		icon = "\A3\Ui_f\data\GUI\Cfg\Ranks\sergeant_gs.paa";	// Icon displayed next to the name
		role = "Assault";										// Optional, see CfgRoles

		// Loadout definition, uses same entries as CfgVehicles classes
		weapons[] = {
			"arifle_MXC_F",
			"Binocular"
		};
		magazines[] = {
			"30Rnd_65x39_caseless_mag",
			"30Rnd_65x39_caseless_mag",
			"SmokeShell"
		};
		items[] = {
			"FirstAidKit"
		};
		linkedItems[] = {
			"V_Chestrig_khk",
			"H_Watchcap_blk",
			"optic_Aco",
			"acc_flashlight",
			"ItemMap",
			"ItemCompass",
			"ItemWatch",
			"ItemRadio"
		};
		uniformClass = "U_B_CombatUniform_mcam_tshirt";
		backpack = "B_AssaultPack_mcamo";
	};
	class Blufor2
	{
		// Alternative configuration pointing to a CfgVehicles class. Loadout will be copied from it.
		vehicle = "B_soldier_AR_F"
	};
};


CfgRespawnTemplates

This class defines new respawn templates to be used with respawn templates.

class CfgRespawnTemplates
{
	// class used in respawnTemplates entry
	class myTag_beacon
	{
		// function or script executed upon death
		// parameters passed into it are the same as are passed into onPlayerKilled.sqf file
		onPlayerKilled = "\myAddon\scripts\respawnBeacon.sqf";

		// function or script executed upon respawn
		// parameters passed into it are the same as are passed into onPlayerRespawn.sqf file
		onPlayerRespawn = "\myAddon\scripts\respawnBeacon.sqf";

		// default respawn delay
		// can be overwitten by description.ext attribute of the same name
		respawnDelay = 20;

		// see respawnOnStart for description and limitations
		// can be overridden by description.ext attribute of the same name
		respawnOnStart = 1;
	};

	class Spectator
	{
		onPlayerRespawn = "BIS_fnc_respawnSpectator"; // a function can be used instead of a script
	};
};


CfgRoles

This class defines Respawn roles. The main purpose of Roles is to make things clearer and simpler for player when selecting a loadout. All the loadouts available in a mission are now divided into various roles. Mission designer can use roles already created in the game config, or custom roles can be defined in description.ext file. Loadouts with no role assigned are automatically assigned to the Default role.

// all default roles with icons
class CfgRoles
{
	class Assault
	{
		displayName = $STR_A3_Role_Assault;
		icon = "a3\Ui_f\data\GUI\Cfg\RespawnRoles\assault_ca.paa";
	};
	class Support
	{
		displayName = $STR_A3_Role_Support;
		icon = "a3\Ui_f\data\GUI\Cfg\RespawnRoles\support_ca.paa";
	};
	class Recon
	{
		displayName = $STR_A3_Role_Recon;
		icon = "a3\Ui_f\data\GUI\Cfg\RespawnRoles\recon_ca.paa";
	};
};



Mission keys

Mission keys are used to lock/unlock certain missions until you completed other ones. It can also be used in mission to know which missions you finished.
Activated keys can be found in user profile (e.g documents\username.Arma3profile) under activeKeys section.
See also commands activateKey, isKeyActive and deActivateKey for more detailed information.

Please note that unlike other text items, stringtable translations ($STR_*) cannot be used.


keys

List of keys from which keysLimit counts the done ones.

keys[] = { "key1", "key2", "key3" };


keysLimit

Number of keys from the keys list needed done to unlock (and be able to play) this mission.

keysLimit = 2;


doneKeys

Name of keys marked done on mission completion.

doneKeys[] = { "key4" };



Player's UI

This section explains HUD customisation possibilities.
See also commands:


overrideFeedback

Some of the feedback effects in Arma 3 are scripted and executed by functions_f\feedback\fn_feedbackMain.fsm. Those include being hit, pulsation, dirt from explosion, choking etc. Adding overrideFeedback with value > 0 will stop feedback FSM from executing, allowing mission/mod makers to script their own, custom effects. The param is first checked in the mission config and then mod config. If mission config has this param set to 0, it will force default feedback handling without possibility to override it by mods. Do not set this param unless you are planning to enforce feedback one way or another.

overrideFeedback = 1; // 0: force default handling, 1+: allow custom handling. Default: not set


showHUD

Enables/Disables the following IGUI elements:

  • Vehicle and unit info
  • Radar and tactical display
  • Vehicle compass
  • Tank direction indicator
  • Commanding menu
  • Group info bar
  • HUD weapon cursors
  • Vehicle display panels
  • Kill messages
  • 3D Icons visibility
showHUD = 0; // 0: disabled - 1: enabled. Default: 1

The effect of using the above showHUD param is different from the effects of showHUD scripting command, both methods are rather complementary to each other.
Since Arma 3 v1.50 showHUD param can be an array to allow control over separate HUD elements, for example:

showHUD[] = {
	1,	// Scripted HUD (same as showHUD command)
	1,	// Vehicle and unit info
	0,	// Vehicle radar [HIDDEN]
	0,	// Vehicle compass [HIDDEN]
	1,	// Tank direction indicator
	1,	// Commanding menu
	1,	// Group info bar
	1,	// HUD weapon cursors
	1,	// Vehicle display panels
	1,	// "x killed by y" systemChat messages
	1	// force show drawIcon3D icons
};
using the showHUD[] array parameter will disable the showHUD command entirely.


showCompass

Defines if the compass is visible.

showCompass = 0; // 0: disabled - 1: enabled. Default: 1


showGPS

Enables/Disables the GPS.

showGPS = 0; // 0: disabled - 1: enabled. Default: 1

In Armed Assault 1.04 toggle this option to disable the mini map attached to the GPS.


showGroupIndicator

Changes default GPS mini map into a radar like display that indicates group members relative position to the player.
See also BIS_fnc_groupIndicator

showGroupIndicator = 1; // 0: disabled - 1: enabled. Default: 0
Has no effect since custom panels were introduced in Arma 3


showMap

Defines if the map is shown after the mission starts.

showMap = 0; // 0: disabled - 1: enabled. Default: 1


showNotePad

In ArmA, defines if the NotePad is shown after the mission starts.

showNotePad = 0; // 0: disabled - 1: enabled. Default: 1


showPad

Defines if the NotePad is shown after the mission starts. Only in OFP:CWC.

showPad = 0; // 0: disabled - 1: enabled. Default: 1


showWatch

Defines if the watch is visible.

showWatch = 0; // 0: disabled - 1: enabled. Default: 1


showUAVFeed

Enables/Disables the UAV Feed.

showUAVFeed = 0; // 0: disabled - 1: enabled. Default: 1


showSquadRadar

Defines if the Squad Radar is visible.

showSquadRadar = 0; // 0: disabled - 1: enabled. Default: 0
Has no effect since custom panels were introduced in Arma 3



Starting gear

Starting gear points to briefing-available equipment. For respawn equipment, see Respawn/Revive.
See also Weapon Pool Commands for more detailed information about weapon pool system.


weapons

Set weapons available to players during the briefing.

class Weapons
{
	class AK74		{ count = 8; };
	class RPG7V		{ count = 2; };
	class Binocular	{ count = 2; };
};


magazines

Set magazines available to players during the briefing.

class Magazines
{
	class 30Rnd_545x39_AK	{ count = 32; };
	class PG7V				{ count =  6; };
	class HandGrenade		{ count = 16; };
};


backpacks

Set backpacks available to players during the briefing.

class Backpacks
{
	class US_Patrol_Pack_EP1	{ count = 4; };
	class US_Assault_Pack_EP1	{ count = 4; };
};


allowSubordinatesTakeWeapons

Allows subordinates (i.e., not leaders) to equip items defined in weapons, magazines and backpacks.

allowSubordinatesTakeWeapons = 1; // 0: disabled - 1: enabled. Default: ?


arsenalRestrictedItems

Used to blacklist undesired Arsenal equipment, which prevents user saved loadout from being loaded if it contains restricted items.

arsenalRestrictedItems[] = { "U_B_Soldier_VR" };


allowProfileGlasses

When set to 0 will stop glasses set in player profile from being added to player's gear:

allowProfileGlasses = 0;


Corpse & wreck management

This section explains how to use game-included garbage collector (GC) for better performances.
See also addToRemainsCollector, isInRemainsCollector and removeFromRemainsCollector commands.


corpseManagerMode

Sets the mode for corpse removal manager.

corpseManagerMode = 0; // Default: 0 for SP, 2 for MP
  • 0 = None - None of the units are managed by the manager
  • 1 = All - All units are managed by the manager
  • 2 = None_But_Respawned - Only units that can respawn are managed by the manager
  • 3 = All_But_Respawned - All units are managed by the manager with exception of respawned (opposite to mode 2)


corpseLimit

Corpse limit before which ( <= ) corpseRemovalMaxTime applies and after which ( > ) corpseRemovalMinTime applies.

corpseLimit = 1; // Default: 15


corpseRemovalMinTime

Remove all bodies that have been dead longer than corpseRemovalMinTime when corpseLimit is reached.

corpseRemovalMinTime = 60; // seconds. Default: 10


corpseRemovalMaxTime

Maximum time a corpse can remain on the ground if total number of corpses is equal or under corpseLimit.

corpseRemovalMaxTime = 1200; // seconds. Default: 3600


wreckManagerMode

Sets the mode for wreck removal manager.

wreckManagerMode = 0; // Default: 0 for SP, 2 for MP
  • 0 = None - None of the vehicles are managed by the manager
  • 1 = All - All vehicles are managed by the manager
  • 2 = None_But_Respawned - Only vehicles that can respawn are managed by the manager
  • 3 = All_But_Respawned - All vehicles are managed by the manager with exception of respawned (opposite to mode 2)


wreckLimit

Vehicle wreck limit before which ( <= ) wreckRemovalMaxTime applies and after which ( > ) wreckRemovalMinTime applies .

wreckLimit = 1; // seconds. Default: 15


wreckRemovalMinTime

Remove all wrecks that have existed longer than wreckRemovalMinTime when wreckLimit is breached.

wreckRemovalMinTime = 60; // seconds. Default: 10


wreckRemovalMaxTime

Maximum time a wreck can remain on the ground if total number of wrecks is equal or under wreckLimit.

wreckRemovalMaxTime = 1800; // seconds. Default: 36000 (10 hours)


minPlayerDistance

The minimum distance between corpse or wreck and nearest player before the corpse or wreck is allowed to be removed by the garbage collector.

minPlayerDistance = 50; // meters. Default: 0



Mission parameters

Mission parameters allow you to add settings to your creation. These settings are in-game accessible only in Multiplayer mode, but can also be accessed by commands for a scripted use in Singleplayer mode.
for Arma 3, see Arma 3 Mission Parameters.
See also BIS_fnc_getParamValue command (paramsArray usage is not recommended).


titleParam%, valuesParam%, defValueParam%, textParam%

titleParam1 and titleParam2 (% in title is replaced either by 1 or 2) are multiplayer options. These options are seen in the lobby of a multiplayer game. They can be useful for setting time limits and score limits in such games as Capture the Flag and Death Matches. Other popular uses include accelerate time, setting the mission difficulty or switching the intro on/off.

While param1/param2 were introduced in OFP:CWC and can still be used in later titles, it is highly recommended to use config class params.

In the mission, variables param1 and param2 have the corresponding values of the chosen options.

titleParam1 = "Time limit:";
valuesParam1[] = { 0, 300, 600, 900 };
defValueParam1 = 900;
textsParam1[] = { "Unlimited", "5 min", "10 min", "15 min" };

titleParam2 = "Score to win:";
valuesParam2[] = { 10000, 5, 7, 10, 15, 20, 25, 30 };
defValueParam2 = 5;
textsParam2[] = { "Unlimited", 5, 7, 10, 15, 20, 25, 30 };

Example:

hint format ["param1 = %1\nparam2 = %2", param1, param2];


params

These are Multiplayer parameters, available in the lobby by the server administrator. They are intended as a replacement for param1/param2.

class Params
{
	class ViewDistance
	{
		// Visible name in lobby settings list
		title = "View distance";

		// must be integers - commas e.g 1.5 are not allowed
		values[] = { 500, 1000, 2000, 5000 };

		// Description of each selectable item - must have the same number of items as 'values'
		// If texts are missing, the values will be displayed instead
		texts[] = { "500m", "1000m", "2 km", "5 km" };

		// must be listed in 'values' array, otherwise 0 is used. If not integer, fallback value is 1
		default = 1000;

		// (optional) script file called when player joins, selected value is passed as an argument
		file = "setViewDistance.sqf";
	};
};

See Arma 3 Mission Parameters for more detailed information.



Mission settings

These are non-editable, mission maker design settings. They can be used for a smoother experience, briefing/debriefing behaviour, saving options, etc.
See also Debriefing for more detailed information.


aiKills

Enables AI units score to appear in score table.

aiKills = 1; // 0: disabled - 1: enabled. Default: 0


briefing

Skip briefing screen for SP missions. If no briefing.html is present, it is skipped anyway.

briefing = 0; // 0: disabled - 1: enabled. Default: 1

Briefing will still be displayed until all clients are connected and done loading.


debriefing

Defines if the debriefing is shown or not at the end of the mission.

debriefing = 0; // 0: disabled - 1: enabled. Default: 1


CfgDebriefing

Define custom mission endings or override the default endings (found under CfgDebriefing in the game's config file).

class CfgDebriefing
{
	// Used when all players die in MP
	class endDeath
	{
		title = "Both teams have died.";
		description = "Everyone was killed by the bomb.";
		picture = "KIA";
	};
};

For a detailed description, see Arma 3: Debriefing.


CfgDebriefingSections

Define custom sections to be displayed on the debriefing screen. Useful for custom scoring systems or displaying player achievements.

class CfgDebriefingSections
{
	class bPoints
	{
		title = "Blufor Points";
		variable = "BLU_P";
	};
	class oPoints
	{
		title = "Opfor Points";
		variable = "OPF_P";
	};
};


Channel ID number command correspondence
Global Side Command Group Vehicle Direct System
0 1 2 3 4 5 N/A
globalRadio sideRadio commandRadio groupRadio vehicleRadio directSay N/A
globalChat sideChat commandChat groupChat vehicleChat N/A systemChat

disableChannels

Disable global, side, command or system chat. MOTD and admin say have exception and will show in global.

A2 OA Logo.png1.62 basic syntax:

disableChannels[] = { 0, 3 }; // simple channel ID list

Arma 3 logo black.png1.60 advanced syntax:

disableChannels[] = {
	{
		0,		// channel ID
		false,	// disable text chat
		true	// disable voice chat
	},
	{ 3, true, true }
};


disabledAI

Multiplayer setting that removes all playable units which do not have a human player.
When AI is disabled, a player logging out will not have AI take control of his character.

Disabling AI units will prevent JIP into playable units if respawn is disabled.
disabledAI = 1; // 0: disabled - 1: enabled. Default: 0


disableRandomization

Disables randomization on certain objects, object types or object kinds in the mission. For more information visit: Vehicle Customization (VhC)

disableRandomization[] = { "All", "AllVehicles", "B_G_Offroad_01_F", "myCar", "MyUnitName", "B_Soldier_F" };

Note: This takes higher priority and will override the following:

_vehicle setVariable ["BIS_enableRandomization", true]; // Cannot enable for all or specific vehicles once disabled in description.ext


enableDebugConsole

Allows access to the Debug Console outside of the editor during normal gameplay.

enableDebugConsole = 2; // dangerous in MP
  • 0 - Default behavior, available only in editor
  • 1 - Available in SP and for hosts / logged in admins
  • 2 - Available for everyone

Alternative since Arma 3 logo black.png1.72

enableDebugConsole[] = { "76561198XXXXXXXXX", "76561198YYYYYYYYY", }; // admins and players with their UID in this list have access


enableItemsDropping

Disable dropping items while swimming. Introduced in Arma 2 OA BETA 1.60.93965. Doesn't seem to have any effect in Arma 3.

enableItemsDropping = 0; // 0: disabled - 1: enabled. Default: ?


enableTeamSwitch

Enables or disables Team Switch functionality in MP when respawn type is 5 (SIDE).

enableTeamSwitch = 0; // 0: disabled - 1: enabled. Default: 1


forceRotorLibSimulation

Force enable or disable RotorLib flight model.

forceRotorLibSimulation = 1; // Default: 0
  • 0 - based on player's options
  • 1 - enabled (advanced mode)
  • 2 - disabled (default flight mode)


joinUnassigned

By default a new player is not auto assigned a free playable slot in the mission lobby in Multiplayer. Disable this setting to make him auto assigned to the side with least players.

joinUnassigned = 0; // 0: disabled - 1: enabled. Default: 1


minScore, avgScore, maxScore

Set minimum, average and maximum score for your mission. Score is related to the star display in the debriefing screen (OFP:CWC). The score can be influenced during a missions progress by using the addRating command.

minScore = 0;
avgScore = 1800;
maxScore = 75000;
Values have to follow this formula: minScore < avgScore < maxScore. Any other combinations can lead to game freeze upon mission end.


onCheat

Executes custom statement when player enters GETALLGEAR cheat (see: GETALLGEAR).

onCheat = "hint str _this";


onPauseScript

Executes a custom SQF script or function in scheduled environment (execVM) when player brings up Game Pause screen (presses 'Esc' button). Display parameter of the resulting dialog is available via (_this select 0) inside the script.

onPauseScript	= "myOnPauseScript.sqf";						// file path
onPauseScript[]	= { myOnPauseFunction1, myOnPauseFunction2 };	// function name - since Arma 3
The script or function executes in its own namespace. In order to get/set external global variable you need to explicitly use mission namespace:

Set: // myVar2 = "345"; // will set the variable only in onPauseScript namespace missionNamespace setVariable ["myVar2", "345"]; // will be available as a global variable

Get:
// hint str myVar; // will raise an undefined variable myVar error
hint str (missionNamespace getVariable "myVar"); // will access the global variable properly


saving

Toggle saving possibility.

saving = 0; // 0: disabled - 1: enabled. Default: 1


scriptedPlayer

When scripted player is enabled, game no longer shows "No player select" error message upon mission start when no player unit is present.

scriptedPlayer = 1; // 0: disabled - 1: enabled. Default: 0


skipLobby

When enabled, joining player will join the mission bypassing role selection screen. The joinUnassigned param will be set to 1 automatically, so that player receives first available role from mission template. When leaving such mission, player will go straight back to server browser.

skipLobby = 1; // 0: disabled - 1: enabled. Default: 0



Server security

This section underlines mission security settings for server. They can secure or break your mission, so be sure to use them wisely.


allowFunctionsLog

Allows functions to log to the RPT file.

allowFunctionsLog = 1; // 0: disabled - 1: enabled. Default: ?


allowFunctionsRecompile

As a security measure, functions are by default protected against rewriting during mission. This restriction does not apply in missions previewed from the editor.

allowFunctionsRecompile = 1; // 0: disabled - 1: enabled. Default: 0


CfgRemoteExec

Define remoteExec and remoteExecCall restrictions. See CfgRemoteExec for more detailed explanations and examples.


CfgDisabledCommands

Define disabled script commands. See CfgDisabledCommands for more detailed explanations.



Tasks

Tasks are part of the mission. This section deals with the settings for them.
See also Arma 3: Task Framework - Task Overhaul


taskManagement_markers2D

Use new 2D markers.

taskManagement_markers2D = 1; // 0: disabled - 1: enabled. Default: 0


taskManagement_markers3D

Use new 3D markers.

taskManagement_markers3D = 1; // 0: disabled - 1: enabled. Default: 0


taskManagement_propagate

Propagate shared tasks to subordinates.

taskManagement_propagate = 1; // 0: disabled - 1: enabled. Default: 0


taskManagement_drawDist

3D marker maximum draw distance in meters. within this range, unassigned tasks are drawn on screen.

taskManagement_drawDist = 2500; // in meters. Default: 2000


CfgTasks

Agents task config

class CfgTasks
{
	class Default
	{
		name = "";
		fsm = "";		// relative path to fsm file
		condition = "";	// relative path to sqf file (compiled and stored for the duration of run time, executed frequently)
		description = "";
		destination = "";
		resources[] = {};
	};
};


CfgTaskTypes

Define Task types and their icons.

class CfgTaskTypes
{
	class Attack
	{
		icon	= "\A3\UI_F_MP_Mark\Data\Tasks\Types\Attack_ca.paa";
		icon3D	= "\A3\UI_F_MP_Mark\Data\Tasks\Types3D\Attack_ca.paa";
	};
	class Defend
	{
		icon	= "\A3\UI_F_MP_Mark\Data\Tasks\Types\Defend_ca.paa";
		icon3D	= "\A3\UI_F_MP_Mark\Data\Tasks\Types3D\Defend_ca.paa";
	};
};


CfgTaskDescriptions

Define Task titles and descriptions.

class CfgTaskDescriptions
{
	class myTask1
	{
		title		= "myTaskTitle";
		description	= "myTaskDescription";
		marker		= "myTaskDestinationMarker";
	};
	class myTask2
	{
		title		= $STR_myTask2Title;
		description	= $STR_myTask2Description;
		marker		= $STR_myTask2Marker;
	};
};


CfgTaskEnhancements

Defines tasks enhancements directly in a class.

class CfgTaskEnhancements
{
	enable		= 1; // 0: disable new task features (default), 1: enable new task features & add new task markers and task widgets into the map
	3d			= 1; // 0: do not use new 3D markers (default), 1: replace task waypoints with new 3D markers
	3dDrawDist	= 0; // 3d marker draw distance (default: 2000)
	share		= 1; // 0: do not count assigned players (default), 1: count how many players have the task assigned
	propagate	= 1; // 0: do not propagate (default), 1: propagate shared tasks to subordinates
};

Importing main config classes

import

It is possible to import a class from main config and inherit from it in mission config. For example:

import RscText;
class MyText: RscText
{
....
};

For more information see import page

Custom content definition

The following class definitions allow for mission-defined content like sounds, music, or more advanced content like functions

CfgCameraEffects

Configure custom cameraEffect.

class CfgCameraEffects
{
	class Array
	{
		class External
		{
			type = 0;
			duration = 6;	// 3 seconds for some reason
			file = "";		// some kind of custom .p3d file for camera
		};
		class AutoTerminate: External
		{
			type = 3;		// CamChained
			chain[] = { "External", "Terminate" }; // Terminate will trigger after 3 seconds
		};
	};
};

Example:

showCinemaBorder false;
_dur = getNumber (missionConfigFile >> "CfgCameraEffects" >> "Array" >> _this >> "duration");
_cam = "camera" camCreate (player modelToWorld [0, -100, 50]);
_cam camSetTarget player;
_cam camSetRelPos [0, -0.1, 1.8];
_cam camCommit _dur / 2;
_cam cameraEffect ["AutoTerminate", "Back"];
waitUntil { camCommitted _cam };
camDestroy _cam;


CfgCommunicationMenu

This entry allows to add commanding menu option in the communication menu. See Arma 3 Communication Menu for more information.


CfgCommands

This entry contains a list of configurations for certain scripting commands (currently only allowedHTMLLoadURIs for htmlLoad and ctrlSetURL). Can be defined in Config.cpp or in campaign's or mission's Description.ext; the most local variant is used.

class CfgCommands
{
	// a list of URIs supported by HTMLLoad
	// note that in case of clients connected to dedicated server, restrictions defined in its config have priority.
	allowedHTMLLoadURIs[] = {
		"*.mywebsite.com", // strings support wildcards '*' and '?'
		"*.mywebsite2.com/something/*",
		(...)
		"*.mywebsiteN.com",
	};
};
Some domains are automatically whitelisted, such as "arma3.com" or "bistudio.com".


CfgFunctions

Define functions for your mission. See Functions Library for more detailed information.


CfgHints

Define Advanced Hints (similar to the Field Manual ones). See Advanced Hints for more information.


CfgIdentities

Define the identities of individual units, you can specify the face, type of glasses worn, voice, tone of voice and name of an identity. You then give a specific unit this identity by using the command setIdentity in the mission.
NOTE: nameSound is only valid since Arma 3. See setNameSound for possible values.

class CfgIdentities
{
	class MyLittleSoldier
	{
		name		= "Givens";
		nameSound	= "Givens"; // Arma 3 only!
		face		= "whiteHead_06";
		glasses		= "None";
		speaker		= "Male05ENG";
		pitch		= 1.1;
	};
};

Example:

player setIdentity "MyLittleSoldier";

See CfgIdentities for more detailed information and valid options for face, glasses, speaker etc.


CfgLeaflets

Define leaflets for your missions. See Arma 3 Leaflets for more information.


CfgMusic

Defines music you can play with playMusic.

class CfgMusic
{
	tracks[] = {};
	class MyIntro
	{
		// display name
		name	= "My intro music";

		// filename, volume, pitch
		sound[]	= { "\music\filename.ogg", db + 0, 1.0 };
	};
	class Ludwig9
	{
		name	= "Ludwig Van Beethoven's Ninth Symphony";
		sound[]	= { "\music\ludwig9.ogg", db + 10, 1.0 };
	};
};

Example:

playMusic "MyIntro";
Setting volume (db) of music far from zero will disable fadeMusic command. Optimal values are from -10 to 10.


CfgNotifications

Define custom notifications to be shown with BIS_fnc_showNotification. See Notification for more detailed information and examples.


CfgPostprocessTemplates

Define custom post-process effects, to Post process effects format (only "colorCorrection" and "filmGrain" are supported for now).
To be used with BIS_fnc_setPPeffectTemplate.

class CfgPostprocessTemplates
{
	class MyPurplePP
	{
		colorCorrections[] = { 1, 1, 0, {1, 1, 1, 0}, {1, 0.5, 1, 0}, {0.75, 0.25, 0, 1} };
		displayName = "Purple-ish!";
		filmGrain[] = { 0.04, 1, 1, 0, 1 };
	};
};


CfgRadio

Defines radio sentences you can play with these radio commands: customRadio, vehicleRadio, groupRadio, sideRadio, globalRadio.

class CfgRadio
{
	sounds[] = {};
	class RadioMsg1
	{
		// display name
		name	= "";

		// filename, volume, pitch
		sound[]	= { "\sound\filename1.ogg", db - 100, 1.0 };

		// radio caption
		title	= "I am ready for your orders.";
	};
	class RadioMsg2
	{
		name	= "";
		sound[]	= { "\sound\filename2", db - 100, 1.0 }; // .wss implied
		title	= $STR_RADIO_2;
	};
};

Example:

unit sideRadio "RadioMsg2";


CfgSentences

See Conversations for more information.


CfgSFX

See CfgSFX for more information.


CfgSounds

General sounds that can be used for dialog, voiceovers in the briefing etc.
See also commands playSound, say, say2D and say3D.

class CfgSounds
{
	sounds[] = {};
	class wolf1
	{
		// how the sound is referred to in the editor (e.g. trigger effects)
		name = "my_wolf_sound";

		// filename, volume, pitch, distance (optional)
		sound[] = { "fx\wolf1.ogg", 1, 1, 100 };

		// subtitle delay in seconds, subtitle text
		titles[] = { 1, "*wolf growls*" };
	};
	class playerIsHurt
	{
		name = "Man, you are injured?! - by NPC";
		sound[] = { "Sound\playerIsHurt1.ogg", 1, 1 };
		titles[] = {
			0, "Dude! You are covered in blood!",
			6, "Are you sure you are OK?!"
		};
	};
	class AnotherSound
	{
		name = "Sound with advanced subtitle options";
		sound[] = { "somesound.ogg", 1, 1 };

		forceTitles = true;			// will display titles even if global show titles option is off
		titlesFont = "LCD14";		// titles font family
		titlesSize = 0.1;			// titles font size
		titlesStructured = true;	// treat titles as Structured Text (see below)

		titles[] = {
			0, "<t color=""#ff0000"">Red text</t>",
			1, "<t color=""#00ff00"">Green text</t>"
		};
	};
};

Example:

playSound "wolf1"; // class name as string
player say ["wolf1", 100];

See OFP ToadLife's tutorial for more detailed information.

You may at some point find volume defined with db (e.g db-40). The formula for db-based volume is: 10^(number*(1/20)).
Arma 3
Since Arma 3 v1.50 it is possible to define AddOn sounds in mission config. In order to make engine look for the sound in AddOn, the sound path must start with @ (instead of \) for example:
class CfgSounds
{
	sounds[] = {};
	class addonsound1
	{
		name		= "sound from addon";
		// start path to sound file in AddOn with @
		sound[]		= { "@a3\Ui_F_Curator\Data\Sound\CfgSound\visionMode", 0.8, 1, 100 };
		titles[]	= { 0, "" };
	};
};


CfgUnitInsignia

Define custom unit insignia (shoulder patches). See Arma 3: Unit Insignia for more detailed information.

class CfgUnitInsignia
{
	class 111thID
	{
		displayName = "111th Infantry Division";	// Name displayed in Arsenal
		author = "Bohemia Interactive";				// Author displayed in Arsenal
		texture = "\a3\UI_F_Bootcamp\Data\CfgUnitInsignia\B_111thID_texture_ca.paa"; // Image path
		textureVehicle = "";						// Currently does nothing, reserved for future use
	};
};


CfgUnitTemplates

This class is used to create units templates. For now, this is only used with the function BIS_fnc_unitHeadgear.

class CfgUnitTemplates
{
	// Classic selectRandom
	class MyFirstTemplate: Default
	{
		headgearList[] =
		{
			"H_Cap_blk",
			"H_Cap_grn",
			"H_Cap_oli_hs"
		};
		facewearList[] =
		{
			"G_Bandanna_beast",
			"G_Bandanna_blk",
			"G_Bandanna_khk"
		};
	};

	// the probabilities will be considered, weighted random
	class MySecondTemplate: Default
	{
		headgearList[] =
		{
			"H_Cap_blk",	0.9,
			"H_Cap_grn",	0.6,
			"H_Cap_oli_hs",	0.55
		};
		facewearList[] =
		{
			"G_Bandanna_beast",	0.5,
			"G_Bandanna_blk",	0.5,
			"G_Bandanna_khk",	0.5
		};
	};
};

Example:

[myUnit,  "MyFirstTemplate"] call BIS_fnc_unitHeadgear;
[myUnit, "MySecondTemplate"] call BIS_fnc_unitHeadgear;


CfgVehicles

This class can only be used to create sound sources (since Arma 3 v1.70).
See also CfgSFX for more detailed information.

class CfgVehicles
{
	class MyOwlSound		// class name to be used with createSoundSource
	{
		sound = "MyOwl";	// reference to CfgSFX class
	};
};


CfgVehicleTemplates

This class is used to create vehicle templates used by the Vehicle Customization system.

class CfgVehicleTemplates
{
	class BIS_Offroad_01_default
	{
		displayName = "Default";
		author = "Bohemia Interactive";
		textureList[] =
		{
			"guerilla_01", 0.5,
			"guerilla_02", 1
		};
		animationList[] =
		{
			"HideBumper1", 1,
			"HideBumper2", 1
		};
	};
};


RscTitles

This class is used to define custom HUDs. See Arma: GUI Configuration for more information.