Description.ext

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, see 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.

Since Arma 3 v2.02, it is possible to import a class from main config and inherit from it in mission config:

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

For more information, see the import (Config) page.

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
};

ⓘ

The playerCountMultipleOf entry is available in earlier titles (Operation Flashpoint: Elite to Arma 3 1.30) to setup the auto-assign team balancing factor: 1 for Coop, 2 for Versus.

0.50

author

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

0.50

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 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";

1.50

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";

1.00

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

1.56

briefingName

Mission name displayed in the mission selection menu.

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

⚠

Please note that the same parameter can be defined in 3DEN in Attributes->General->Presentation->Title, but 'briefingName' from 'description.ext' has a priority. To use localized string either in 3DEN field or in 'description.ext', prefix stringtable ID with @.

1.00

CfgLoadingTexts

Define mission specific loading texts.

0.50

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 1024×512 (Arma 3).

0.50

overviewText

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

⚠

Please note that the same parameter can be defined in 3DEN in Attributes->General->Overview->Text, but 'overviewText' from 'description.ext' has a priority. To use localized string either in 3DEN field or in 'description.ext', prefix stringtable ID with @.

⚠

The text that appears at the top of an MP mission is defined in mod mission definition and not through Description.ext:

class Mission
{
	// ...
	class Intel
	{
		overviewText = "This text here";
		// ...
	};
// ...
};

0.50

overviewTextLocked

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

⚠

Please note that to use localized string prefix stringtable ID with @.

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.

2.02

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.

• for Arma 2, see First Aid.
• for Arma 3, see Arma 3: Respawn and Arma 3: Revive.

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"	1.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 soldiers and vehicles respawn type.

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

2.18

respawnVehicle

Sets vehicles only respawn type. Vehicles can only have 2 (or "INSTANT") and 3 (or "BASE") respawn mode. All other modes are equal to disabled respawn. If 'respawnVehicle' is not defined, the 'respawn' value is used.

respawnVehicle = 3;		    // number version
respawnVehicle = "BASE";	// 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 = 1; // Default: 0

• -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.

1.00

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.

1.00

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.

1.62

reviveMode

Define if Revive mode is enabled.

reviveMode = 1; // Default: 0

• 0 - disabled
• 1 - enabled
• 2 - controlled by player attributes

1.62

reviveUnconsciousStateMode

Define revive mode.

reviveUnconsciousStateMode = 0; // Default: 0

• 0 - basic mode
• 1 - advanced mode
• 2 - realistic

See damage model for more detailed information.

1.62

reviveRequiredTrait

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

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

1.62

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

1.62

reviveRequiredItemsFakConsumed

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

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

1.62

reviveMedicSpeedMultiplier

Speed multiplier for revive performed by medic

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

1.62

reviveDelay

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

reviveDelay = 10; // Default: 6

1.62

reviveForceRespawnDelay

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

reviveForceRespawnDelay = 5; // Default: 3

1.62

reviveBleedOutDelay

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

reviveBleedOutDelay = 300; // Default: 120

1.62

enablePlayerAddRespawn

Usage unsure, may be related to respawn template MenuPosition.

enablePlayerAddRespawn = 0; // Disable framework respawn

1.62

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"
	};
};

1.62

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
	};
};

1.62

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.

1.00

keys

List of keys from which keysLimit counts the done ones.

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

1.00

keysLimit

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

keysLimit = 2;

1.00

doneKeys

Name of keys marked done on mission completion.

doneKeys[] = { "key4" };

Player's UI

This section explains HUD customisation possibilities.
See also commands:

• showCompass, shownCompass, visibleCompass
• showGPS, shownGPS, visibleGPS
• showHUD, shownHUD
• showWatch, shownWatch, visibleWatch
• showUAVFeed, shownUAVFeed 1.16
• showPad, shownPad 1.00

1.98

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.

1.00

showGroupIndicator

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

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

⚠

Has no effect since custom panels were introduced in Arma 3. See BIS_fnc_groupIndicator.

showMap

Defines if the map is shown after the mission starts.

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

1.00

showNotePad

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

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

1.00

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

1.16

showUAVFeed

Enables/Disables the UAV Feed.

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

1.60

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.

2.16

overrideHazeQuality

0/1/2 - VeryLow/Low/Standard - Forces haze quality and in MP has priority over the server 'overrideHazeQuality' option. Standard(2) - mod config driven. Default(-1) - do not force.

overrideHazeQuality = 1; // Low

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; };
};

1.50

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; };
};

1.56

allowSubordinatesTakeWeapons

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

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

1.98

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" };

2.04

allowProfileGlasses

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

allowProfileGlasses = 0;

Corpse and Wreck Management

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

The Remains Collector, if enabled, runs at background on every client and clears mission of corpses and wrecks depending on set params and mode. Individual objects can be added or removed from collector monitoring. Items in remains collector are sorted depending on how valuable they are. The most valuable items are pushed to the end of remains array and will be deleted last if possible; for example, the flag carrier is never deleted while it has the flag.

1.32

corpseManagerMode

Sets the mode for automatic corpse removal.

corpseManagerMode = 0; // Default SP: 0; Default MP: 2

• 0 (Default in SP) = None - None of the units are automatically managed by the manager
• 1 = All - All units are automatically managed by the manager
• 2 (Default in MP) = None_But_Respawned - Only units that can respawn are automatically managed by the manager
• 3 = All_But_Respawned - All units are automatically managed by the manager with the exception of respawned ones (opposite to mode 2)

0.50

corpseLimit

If the total number of monitored corpses is higher than corpseLimit, the corpses that have been dead for longer than corpseRemovalMinTime will be considered for removal.

corpseLimit = 1; // Default: 15

0.50

corpseRemovalMinTime

See corpseLimit above.

corpseRemovalMinTime = 60; // seconds. Default: 10

0.50

corpseRemovalMaxTime

Monitored corpses that are dead for longer than corpseRemovalMaxTime will be considered for removal regardless of the corpseLimit.

corpseRemovalMaxTime = 1200; // seconds. Default: 3600

2.18

disposalCheckPeriod

How often the remains collector checks monitored remains for removal. The value can be between 1 and 60.

disposalCheckPeriod = 10; // seconds. Default: 5

1.66

minPlayerDistance

This value applies for monitored corpses, wrecks and weaponholders. The minimum distance between remains and the nearest player before the remains are allowed to be removed by the remains collector. The remains closer than minimum distance to nearest player will not be removed until distance increases. If 'minPlayerDistance' is set to 0, the distance check is not performed.

minPlayerDistance = 50; // meters. Default: 0

2.18

minPlayerDistance[]

Array variant of the above that allows setting individual minPlayerDistance for {corpses, wrecks, weaponholders}

minPlayerDistance[] = {50, 60, 70}; // meters. Default: {0, 0, 0}

2.18

weaponholderManagerMode

Sets the mode for automatic weapon holder removal.

weaponholderManagerMode = 0; // Default SP: 0; Default MP: 2

• 0 (Default in SP) = None - None of the weapon holders are automatically managed by the manager
• 1 = All - All weapon holders are automatically managed by the manager
• 2 (Default in MP) = None_But_Respawned - Only weapon holders from units that can respawn are automatically managed by the manager
• 3 = All_But_Respawned - All weapon holders are automatically managed by the manager with the exception of the ones from respawned units (opposite to mode 2)

2.18

weaponholderLimit

If the total number of monitored weapon holders is higher than weaponholderLimit, the weapon holders that exist for longer than weaponholderRemovalMinTime will be considered for removal.

weaponholderLimit = 1; // Default: 50

2.18

weaponholderRemovalMinTime

See weaponholderLimit above.

weaponholderRemovalMinTime = 60; // seconds. Default: 3600

2.18

weaponholderRemovalMaxTime

Monitored weapon holders that exist for longer than weaponholderRemovalMaxTime will be considered for removal regardless of the weaponholderLimit.

weaponholderRemovalMaxTime = 1200; // seconds. Default: 36000

1.32

wreckManagerMode

Sets the mode for automatic wreck removal.

wreckManagerMode = 0; // Default SP: 0; Default MP: 2

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

0.50

wreckLimit

If the total number of monitored wrecks is higher than wreckLimit, the wrecks that existed for longer than wreckRemovalMinTime will be considered for removal.

wreckLimit = 1; // seconds. Default: 15

0.50

wreckRemovalMinTime

See wreckLimit above.

wreckRemovalMinTime = 60; // seconds. Default: 10

0.50

wreckRemovalMaxTime

Monitored wrecks that existed for longer than wreckRemovalMaxTime will be considered for removal regardless of the wreckLimit.

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

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.
See Mission Parameters, along with BIS_fnc_getParamValue function (paramsArray usage is not recommended).

1.00

param1/param2

param1 and param2 are multiplayer options that can be seen in the multiplayer lobby. 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 time acceleration, setting the mission difficulty or switching the intro on/off.

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

⚠

• While param1/param2 were introduced in OFP and can still be used in later titles, it is highly recommended to use config class Params, available since Arma 2 v1.03.
• param1/param2 variables can be overridden during the mission as they are not read-only.

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];

1.03

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 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

0.50

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.

0.50

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";
	};
};

2.16

DifficultyOverride

Allow to override a difficulty setting for the mission only.

At the moment, only tacticalPing is supported.

class DifficultyOverride
{
	tacticalPing = 0; // disables tactical ping in this mission, even if selected difficulty preset has it enabled
}

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

1.62

disableChannels

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

ⓘ

• This setting is not considered when hosting from Eden Editor.
• A mission using disableChannels will override any disableChannels[] value in server config.

1.62 basic syntax:

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

1.60 advanced syntax:

disableChannels[] =
{
	{
		0,		// channel ID
		false,	// text chat remains enabled
		true	// voice chat is disabled
	},
	{ 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: AIs fill empty slots - 1: AIs are disabled, only players can spawn. Default: 0

1.42

disableRandomization

Disables randomization on certain objects, object types or object kinds in the mission. For more information visit: Arma 3: Vehicle Customisation

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

0.50

enableDebugConsole

Allows access to the Debug Console in multiplayer scenarios outside of the editor. This has no effect for singleplayer scenarios.

Since 2.18 also makes the console available in singleplayer scenarios.

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 1.72

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

1.62

enableItemsDropping

Disable dropping items while swimming. Introduced in Arma 2: Operation Arrowhead 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

1.34

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)

2.06

hostDoesNotSkipLobby

Stops hosting player from skipping the lobby if skipLobby = 1; is used

hostDoesNotSkipLobby = 1;

0.50

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.

2.10

missionGroup

Shared mission group name to override default missionName used with missionProfileNamespace, saveMissionProfileNamespace

missionGroup = "SomeNameDescribingCommonMissions";

1.00

onCheat

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

onCheat = "hint str _this";

1.62

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

1.00

saving

Toggle saving possibility.

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

1.00

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

1.60

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.

0.50

allowFunctionsLog

Allows functions to log to the RPT file.

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

1.00

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

2.06

zeusCompositionScriptLevel

zeusCompositionScriptLevel = 0;	// 0: all scripts are forbidden
								// 1: only attributes are allowed (including custom attributes added by mods)
								// 2: all scripts are allowed including init scripts
								// Default: 1

1.66

CfgDisabledCommands

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

1.50

CfgRemoteExec

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

Tasks

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

1.42

taskManagement_markers2D

Use new 2D markers.

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

1.42

taskManagement_markers3D

Use new 3D markers.

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

1.42

taskManagement_propagate

Propagate shared tasks to subordinates.

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

1.42

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

1.00

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[] = {};
	};
};

1.54

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";
	};
};

1.12

CfgTaskDescriptions

Define Task titles and descriptions.

class CfgTaskDescriptions
{
	class myTask1
	{
		title		= "my task title";
		description	= "my task description";
		marker		= "my task destination marker";
	};

	class myTask2
	{
		title		= "STR_myTask2Title";			// note the lack of $ sign here!
		description	= "STR_myTask2Description";		// without $, it translates for each client
		marker		= "STR_myTask2Marker";			// with $ everyone sees the server's language
	};
};

1.42

CfgTaskEnhancements

Defines tasks enhancements directly in a class.

class CfgTaskEnhancements
{
	enable		= 1; // 0: disable new task features (default), 1: enable new task features and 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
};

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; private _dur = getNumber (missionConfigFile >> "CfgCameraEffects" >> "Array" >> _this >> "duration"); private _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;

1.00

CfgCommunicationMenu

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

1.50

CfgCommands

This entry contains a list of configurations for certain scripting commands (currently only allowedHTMLLoadURIs for htmlLoad, ctrlSetURL and menuSetURL). 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".

1.00

CfgFunctions

Define functions for your mission. For a detailed explanation, see:

1.00	Arma 3: Functions Library
1.00 1.00	Arma 2: Functions Library
1.00	Take On Helicopters: Functions Library

1.00

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.

ⓘ

the nameSound entry 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.

1.76

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.

1.12

CfgNotifications

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

1.00

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[] = {}; // OFP required it filled, now it can be empty or absent depending on the game's version

	class wolf1
	{
		name = "My wolf sound";						// display name
		sound[] = { "fx\wolf1.ogg", 1, 1, 100 };	// file, volume, pitch, maxDistance
		titles[] = { 0, "*wolf growls*" };			// subtitles

		titlesFont = "LCD14";		// OFP:R - titles font family
		titlesSize = 0.1;			// OFP:R - titles font size

		forceTitles = 1;			// Arma 3 - display titles even if global show titles option is off (1) or not (0)
		titlesStructured = 1;		// Arma 3 - treat titles as Structured Text (1) or not (0)
	};
};

Property	Description
sounds[]	Was required in previous titles, and needed to be filled with CfgSounds defined sounds at the beginning of Operation Flashpoint. At least in Arma 3 the engine finds them without this value which can now be ignored entirely.
name	(Optional) how the sound is referred to in the editor (e.g. name in trigger effects) this can be a translation (e.g "$STR_My_Translation")
sound[]	An array containing: file path: the relative path to the file Since 1.50 the path can be prefixed with @ in order to look directly into addon files, e.g "@a3\Ui_F_Curator\Data\Sound\CfgSound\visionMode" volume: between 0 and 5, 1 being normal volume ⓘ Volume may at some point be found defined with db (e.g db-40). The formula for db-based volume is: 10^(number * (1/20)). pitch: 1 is normal pitch, 2 = chipmunk, 0.5 = Darth Vader, etc max distance: (Optional, default volume × 1000) maximum distance at which the sound is heard, in metres
titles[]	An array format { time1, text1, time2, text2 } etc: time#: can be a number or an array: number: sound time at which the text is displayed (2 = 2s after sound start) array: format { displayTime, displayDurationFactor }: displayTime: sound time at which the text is displayed (2 = 2s after sound start) displayDurationFactor: default value is 1 (for 10s subtitle display), 0.5 means half the time (5s), 2 means twice the time (20s) etc text#: the text to be displayed ⚠ If a subtitle is timed for after the sound is done, the sound will repeat until the subtitle is played (then played until its end).
1.75 titlesFont	(Optional) titles font family
1.75 titlesSize	(Optional) titles font size
0.50 forceTitles	(Optional) if set to 1, will display titles even if global show titles option is off
0.50 titlesStructured	(Optional) if set to 1, treat titles as Structured Text (e.g 0, "<t color=""#ff0000"">Red text</t>")

Example:

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

ⓘ

See OFP ToadLife's tutorial for a sound advice.

1.24

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 = "";						// does nothing, was reserved for future use
	};
};

1.50

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;

1.70

CfgVehicles

This class can only be used to create sound sources.
See also CfgSFX for more detailed information.

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

1.42

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.

Full TOC

Mini TOC