View source for Mission.sqm

{{unsupported-doc}}
{{SideTOC}}


[[Mission.sqm]] is the file generated by the [[Mission Editor]];
it contains mission information (date, time, weather),
object placement information (position, direction and other parameters) as well as every other setting that can be set from the editor (respawn type and duration, etc).


== Versions ==

SQM version can be found by opening the file with a basic text editor: it is the very first line of the file, to format {{Inline code|version{{=}}''version'';}} - correspondence below:
{| class="wikitable"
! Version
! Game
! Format
|-
| 11 ||
* {{ofp}}
* {{ofpr}}
* {{arma}}
* {{arma2}}
* {{arma2oa}}
* {{tkoh}}
| rowspan="2" | 2D
|-
| 12 ||
* {{arma3}} ([[2D Editor]])
|-
| 53 ||
* {{arma3}} ([[Eden Editor]])
| 3D
|}


== [[Eden Editor]] format ==

As seen above, the first line is <tt>version</tt>, then come:
* <tt>class EditorData</tt> - [[Eden Editor]] settings, like camera position, entity id
* <tt>binarizationWanted</tt> - 0 to output the mission in plain (non-binary) text
* <tt>addons</tt> - list of required addons
* <tt>AddonsMetaData</tt> - user-friendly required addons' information
* <tt>randomSeed</tt> - seed for randomisation, most likely used by [[random]]
* <tt>class ScenarioData</tt> - scenario's meta data (author name) as well as respawn settings (respawn type, etc)
* <tt>class CustomAttributes</tt> - advanced scenario attributes (such as respawn templates, [[Arma 3 Revive|revive]], etc. Also contains'''modded''' attributes)
* <tt>class Intro</tt> - if it exists: intro
* <tt>class Mission</tt> - if it exists: mission
* <tt>class {{sic|OutroLoose}}</tt> - if it exists: failure outro
* <tt>class OutroWin</tt> - if it exists: success outro


* Intro, Mission, OutroLoose and OutroWin contain the following sub-classes:
** <tt>class Intel</tt> - date/time and weather settings
** <tt>class Entities</tt> - the various entities present in the <tt>Mission</tt>
** <tt>class Connections</tt> - connections like synchronized triggers present in the <tt>Mission</tt>
=== class EditorData ===

<spoiler text="Show Example">
<syntaxhighlight lang="cpp">
class EditorData
{
	moveGridStep=1;
	angleGridStep=0.2617994;
	scaleGridStep=1;
	autoGroupingDist=10;
	toggles=1;
	class ItemIDProvider
	{
		nextID=13;
	};
	class MarkerIDProvider
	{
		nextID=1;
	};
	class Camera
	{
		// simplified example for the sake of readability
		// ...
	};
};
</syntaxhighlight>
</spoiler>

==== moveGridStep ====
Translation Widget's step size in meters.

==== angleGridStep ====
Angle Widget's step size in radians.

==== scaleGridStep ====
Area Scaling Widget's step size in meters.

==== autoGroupingDist ====
Defines the distance in meter to auto-group units. 
This value can only be changed in the mission.sqm file and not from within [[Eden Editor]].<br>The change is not overwritten if the mission is saved and is persistent across different mission.sqm files.

==== toggles ====
Is a number created out of different flags. 

{| class="wikitable"
|+ Flag Details
! Value !! Description !! Icon
|-
| 0 || Nothing selected || {{n/a}}
|-
| 1 || Terrain Mode ATL || style="background-color:#333; text-align:center" | [[File:3den toolbar vert ATL.png|32px]]
|-
| 2 || Terrain Mode ASL / Don't adjust up vector (implies Terrain Mode ASL) || style="background-color:#333; text-align:center" | [[File:3den toolbar vert ASL.png|32px]]
|-        
| 4 || Move in grid || style="background-color:#333; text-align:center" | [[File:3den toolbar grid translation.png|32px]]
|-
| 8 || Don't snap to surface || style="background-color:#333; text-align:center" | [[File:3den toolbar snap.png|32px]][[File:3den toolbar snap on.png|32px]]
|-
| 16 || ''Not implemented on purpose'' || {{n/a}}
|-
| 32 || Rotate in grid || style="background-color:#333; text-align:center" | [[File:3den toolbar grid rotation.png|32px]]
|-
| 64 || Scale in grid || style="background-color:#333; text-align:center" | [[File:3den toolbar grid scaling.png|32px]]
|-
| 128 || Force show bounding boxes<br>''Can not be toggled from the editor'' || {{n/a}}
|-
| 256 || Disable mouseOver model highlight<br>''Can not be toggled from the editor'' || {{n/a}}
|-
| 512 || Insert empty vehicle as default || {{n/a}}
|-
| 1024 || Allow resize/rotate widget || style="background-color:#333; text-align:center" | [[File:3den toolbar widget area.png|32px]]
|}

==== class ItemIDProvider ====
contains a single entry: <tt>nextID</tt> that is the next item id value (auto incremented on every item addition);

==== class MarkerIDProvider ====
contains a single entry: <tt>nextID</tt> that is the next marker id value (auto incremented on every marker addition);

==== class Camera ====
Defines the editor's camera position/orientation.
<syntaxhighlight lang="cpp">
class Camera
{
	// positions are to format X, Z, Y
	pos[]={2325.9604,24.771292,5133.4385};				// camera position
	dir[]={0.361072,-0.27934057,0.88971913};			// camera vectorDir
	up[]={0.10504395,0.96019292,0.25883871};			// camera vectorUp
	aside[]={0.92660606,2.7686474e-007,-0.37604135};	//
};
</syntaxhighlight>

=== binarizationWanted ===

A number (0 or 1) representing a [[Boolean]], to tell the editor to save the mission.sqm to binary format or not.

<syntaxhighlight lang="cpp">
binarizationWanted=0;
</syntaxhighlight>

=== addons ===

A config array of '''CfgPatches''' entries, determining which addons are needed.

<syntaxhighlight lang="cpp">
addons[]=
{
	"A3_Characters_F",
	"A3_Modules_F_Sites",
	"A3_Ui_F"
};
</syntaxhighlight>

=== AddonsMetaData ===

A "list" of [[#addons|required addons]]' user-friendly details, with author's name, friendly name, URL.

<spoiler text="Show Example">
<syntaxhighlight lang="cpp">
class AddonsMetaData
{
	class List
	{
		items=3;
		class Item0
		{
			className="A3_Characters_F";
			name="Arma 3 Alpha - Characters and Clothing";
			author="Bohemia Interactive";
			url="https://www.arma3.com";
		};
		class Item1
		{
			className="A3_Modules_F";
			name="Arma 3 Alpha - Scripted Modules";
			author="Bohemia Interactive";
			url="https://www.arma3.com";
		};
		class Item2
		{
			className="A3_Ui_F";
			name="Arma 3 - User Interface";
			author="Bohemia Interactive";
			url="https://www.arma3.com";
		};
	};
};
</syntaxhighlight>
</spoiler>

=== randomSeed ===

A [[random]] seed most likely used by weather settings and/or other random values.

<syntaxhighlight lang="cpp">
randomSeed=4125053;
</syntaxhighlight>

=== ScenarioData ===

==== author ====

The mission's author name.

<syntaxhighlight lang="cpp">
author="Bohemia Interactive";
</syntaxhighlight>

=== class Mission ===
=== class Intro ===
=== class OutroWin ===
=== class OutroLoose ===

Constituted of two sub-entries [[#class Intel|class Intel]] and [[#class Entities|class Entities]],
This structure applies to [[#class Intro|class Intro]], [[#class OutroWin|class OutroWin]] and [[#class OutroLoose|class OutroLoose]] as well.

==== class Intel ====
Mission setup information.

<syntaxhighlight lang="cpp">
class Intel
{
	timeOfChanges=1800.0002;
	startWeather=0;
	startWind=0.1;
	startWaves=0.1;
	forecastWeather=0;
	forecastWind=0.1;
	forecastWaves=0.1;
	forecastLightnings=0.1;
	year=2035;
	day=28;
	hour=13;
	minute=37;
	startFogDecay=0.014;
	forecastFogDecay=0.014;
};
</syntaxhighlight>

==== class Entities ====
<tt>class Entities</tt> is a data bag that can contain items, and items can contain instances of <tt>class Entities</tt>.
In the example below, the "main" <tt>class Entities</tt> contains an item (the group), item which contains another <tt>class Entities</tt> with items (group units).

<syntaxhighlight lang="cpp">
class Entities
{
	items=1;
	class Item0
	{
		dataType="Group";
		side="West";
		class Entities
		{
			items=1;
			class Item0
			{
				// simplified example for the sake of readability
				// ...
			};
		};
	};
};
</syntaxhighlight>

==== class ItemX ====
Where X is from 0 to items number -1.

A <tt>class ItemX</tt> can be of the following ''dataType''s:
* "Comment"
* "Group"
* "Logic"
* "Marker"
* "Object"
* "Trigger"
* "Waypoint"

<spoiler text="Show Example">
<syntaxhighlight lang="cpp">
class Item0
{
	dataType="Object";
	class PositionInfo
	{
		position[]={256,1029.0015,512.0498}; // X, Z, Y in world position
	};
	side="West";
	flags=3;
	class Attributes
	{
		health=0.89999998;
		skill=0.60000002;
		ammo=0.89999998;
		rank="CORPORAL";
		presence=0.68964958;
		isPlayable=1;
		disableSimulation=1;
		ignoreByDynSimulGrid=1;
		reportRemoteTargets=1;
		receiveRemoteTargets=1;
		reportOwnPosition=1;
		stance="Down";
	};
	id=1;
	type="B_Soldier_F";	// CfgVehicles class
	atlOffset=1024;		// altitude offset
	class CustomAttributes
	{
		class Attribute0
		{
			// simplified example for the sake of readability
			// ...
		};
		nAttributes=1; // attributes count; similar to "items=x" in class Entities
	};
};
</syntaxhighlight>
</spoiler>

===== Flags =====
Flag value is a combination of the following values:
* 1 = KeepHorizontal
* 2 = IsGroupLeader
* 4 = IsSnappedToSurface
* 8 = ContainsArea

For example, a flag of 7 means 1 + 2 + 4: KeepHorizontal, IsGroupLeader, IsSnappedToSurface and not ContainsArea.

===== class AttributeX =====
Attributes are children classes of items and are listed in the <tt>class CustomAttributes</tt> sub-class.

<syntaxhighlight lang="cpp">
class Attribute0
{
	property="allowDamage";
	expression="_this allowdamage _value;";	// SQF code to be executed (_this = the object, _value = 'value' field below)
	class Value
	{
		class data
		{
			class type
			{
				type[]=
				{
					"BOOL"
				};
			};
			value=0; // for a boolean, 1 = true, 0 = false
		};
	};
};
</syntaxhighlight>

== [[2D Editor]] format ==

First line is <tt>version</tt>, then four classes of data, all of the same structure - they are:

* class Mission
* class Intro
* class OutroWin
* class {{sic|OutroLoose}}

=== class Mission ===

It is filled as such:
<syntaxhighlight lang="cpp">
// addons required to run the mission
// Once you are done creating/updating your mission, it is always good practice
// to check the mission.sqm for presence of unwanted addons in "addOns" and "addOnsAuto"" arrays.
// They contain "CfgPatches" classes of used addons.
// Apart from "class Mission", list of addons is also present in "Intro", "OutroWin" and "OutroLoose" classes.
addOns[]=
{
	"cacharacters",
	"desert"
};
addOnsAuto[]=
{
	"cacharacters",
	"desert"
};
randomSeed=9361411; // the random seed, most probably used to generate random numbers
class Intel // pretty self-explanatory
{
	startWeather=0.100000;
	forecastWeather=0.300000;
	year=2007;
	month=6;
	day=7;
	hour=8;
};
</syntaxhighlight>

==== class Groups ====
<syntaxhighlight lang="cpp">
class Groups
{
	items=1;
	class Item0
	{
		side="WEST";
		class Vehicles
		{
			items=1;
			class Item0
			{
				position[]={2606.808838,14.685581,2408.266602}; // X, Z, Y
				id=0;
				side="WEST";
				vehicle="SoldierWB";			// CfgVehicles class
				player="PLAYER COMMANDER";
				leader=1;						// group leader
				skill=0.600000;
			};
		};
	};
};
</syntaxhighlight>


[[Category: Operation Flashpoint: Editing]]
[[Category: ArmA: Mission Editing]]
[[Category: Arma 2: Editing]]
[[Category: Arma 3: Editing]]
[[Category: Take On Helicopters: Editing]]
[[Category: Mission Editor]]