Introduction to Arma Scripting - Revision history

Lou Montana: Fix link

2025-02-28T17:08:27Z

Fix link

← Older revision		Revision as of 19:08, 28 February 2025
Line 3:		Line 3:

	All {{arma}} games from {{arma0}} to {{arma3}} use a scripting language called [[SQF Syntax\|SQF]]. Its predecessor [[SQS Syntax\|SQS]] has been considered deprecated since {{arma1}} (2006) and is no longer used.		All {{arma}} games from {{arma0}} to {{arma3}} use a scripting language called [[SQF Syntax\|SQF]]. Its predecessor [[SQS Syntax\|SQS]] has been considered deprecated since {{arma1}} (2006) and is no longer used.
	As of {{armaR}} (2022), SQF has been succeeded by {{GameCategory\|armaR\|Modding\|Guidelines~~\|Scripting~~\|text= Enforce Script}}. This document only considers SQF.		As of {{armaR}} (2022), SQF has been succeeded by {{GameCategory\|armaR\|Modding\|Scripting\|Guidelines\|text= Enforce Script}}. This document only considers SQF.

Lou Montana: Text replacement - "{{Link|:Category:" to "{{Link|Category:"

2024-10-16T13:51:59Z

Text replacement - "{{Link|:Category:" to "{{Link|Category:"

← Older revision		Revision as of 15:51, 16 October 2024
Line 239:		Line 239:
	* [[:Category:Functions\|Functions]]		* [[:Category:Functions\|Functions]]
	* [[Namespace]]s, {{Link\|Variables#Scopes\|Scopes}}		* [[Namespace]]s, {{Link\|Variables#Scopes\|Scopes}}
	* {{Link\|:Category:Event Handlers\|Event Handlers}}		* {{Link\|Category:Event Handlers\|Event Handlers}}
	* [[HashMap]]s		* [[HashMap]]s
	}}		}}

Lou Montana: Some wiki formatting

2024-02-20T15:00:08Z

Some wiki formatting

← Older revision		Revision as of 17:00, 20 February 2024
Line 2:		Line 2:
	Scripting is one of the most powerful and most versatile tools available in the Arma sandbox. Unfortunately, it is also one of the most complex and unforgiving aspects of addon (i.e. mod) and mission creation.		Scripting is one of the most powerful and most versatile tools available in the Arma sandbox. Unfortunately, it is also one of the most complex and unforgiving aspects of addon (i.e. mod) and mission creation.

	{{~~arma3~~}}, {{~~arma2~~}}, {{~~arma1}} and {{arma0~~}} ~~all~~ use a scripting language called [[SQF Syntax\|SQF]]. Its predecessor [[SQS Syntax\|SQS]] has been considered deprecated since {{arma1}} (2006) and is no longer used. As of {{armaR}} (2022), SQF has been succeeded by Enforce Script. This ~~introduction~~ only considers SQF.		All {{arma}} games from {{arma0}} to {{arma3}} use a scripting language called [[SQF Syntax\|SQF]]. Its predecessor [[SQS Syntax\|SQS]] has been considered deprecated since {{arma1}} (2006) and is no longer used.
			As of {{armaR}} (2022), SQF has been succeeded by {{GameCategory\|armaR\|Modding\|Guidelines\|Scripting\|text= Enforce Script}}. This document only considers SQF.


	== Scripting Topics ==		== Scripting Topics ==

	There is a plethora of topics to learn about in the context of ~~Arma~~ scripting (see the table below). Fortunately, there is no need to acquire detailed knowledge about all of these things in order to get started with scripting. To aid with ~~prioritization~~, this page provides three selections of topics, each relevant to beginner, intermediate and advanced scripters respectively.		There is a plethora of topics to learn about in the context of {{arma}} scripting (see the table below).
			Fortunately, there is no need to acquire detailed knowledge about all of these things in order to get started with scripting.
			To aid with prioritisation, this page provides three selections of topics, each relevant to beginner, intermediate and advanced scripters respectively.
	{{Table/RVScripting}}		{{Table/RVScripting}}

Lou Montana: Text replacement - ":Category:Eden Editor" to "Eden Editor"

2023-07-09T12:27:16Z

Text replacement - "Category:Eden Editor" to "Eden Editor"

← Older revision		Revision as of 14:27, 9 July 2023
Line 209:		Line 209:

	{{Feature\|informative\|		{{Feature\|informative\|
	The [[:Category:Eden Editor]] provides a useful shortcut to quickly open a mission's scenario folder in the Windows File Explorer:		The [[:Category:Eden Editor\|Eden Editor]] provides a useful shortcut to quickly open a mission's scenario folder in the Windows File Explorer:
	With the mission open in the Editor, go to ''Scenario'' in the top left and then click on ''Open Scenario Folder''.		With the mission open in the Editor, go to ''Scenario'' in the top left and then click on ''Open Scenario Folder''.
	}}		}}
Line 262:		Line 262:

	; Is it possible to do this in the editor?		; Is it possible to do this in the editor?
	: The [[:Category:Eden Editor]] is a powerful tool and with it alone one can achieve a lot of things without writing a single line of code.		: The [[:Category:Eden Editor\|Eden Editor]] is a powerful tool and with it alone one can achieve a lot of things without writing a single line of code.
	: Poorly written scripts are a frequent cause of poor performance, both in singleplayer and multiplayer scenarios.		: Poorly written scripts are a frequent cause of poor performance, both in singleplayer and multiplayer scenarios.

Lou Montana: Text replacement - "\[\[Eden( |_)Editor(\||\])" to "[[:Category:Eden Editor$2"

2023-07-09T12:20:51Z

Text replacement - "\[\[Eden( |_)Editor(\||\])" to "[[:Category:Eden Editor$2"

← Older revision		Revision as of 14:20, 9 July 2023
Line 209:		Line 209:

	{{Feature\|informative\|		{{Feature\|informative\|
	The [[Eden Editor]] provides a useful shortcut to quickly open a mission's scenario folder in the Windows File Explorer:		The [[:Category:Eden Editor]] provides a useful shortcut to quickly open a mission's scenario folder in the Windows File Explorer:
	With the mission open in the Editor, go to ''Scenario'' in the top left and then click on ''Open Scenario Folder''.		With the mission open in the Editor, go to ''Scenario'' in the top left and then click on ''Open Scenario Folder''.
	}}		}}
Line 262:		Line 262:

	; Is it possible to do this in the editor?		; Is it possible to do this in the editor?
	: The [[Eden Editor]] is a powerful tool and with it alone one can achieve a lot of things without writing a single line of code.		: The [[:Category:Eden Editor]] is a powerful tool and with it alone one can achieve a lot of things without writing a single line of code.
	: Poorly written scripts are a frequent cause of poor performance, both in singleplayer and multiplayer scenarios.		: Poorly written scripts are a frequent cause of poor performance, both in singleplayer and multiplayer scenarios.

Lou Montana: Text replacement - "\[ (https?:\/\/[^ = ]+) +([^= ]+) \]" to "{{Link|$1|$2}}"

2023-04-28T14:08:37Z

Text replacement - "\[ *(https?:\/\/[^ = ]+) +([^= ]+) *\]" to "{{Link|$1|$2}}"

← Older revision		Revision as of 16:08, 28 April 2023
Line 219:		Line 219:

	==== Editing Script Files ====		==== Editing Script Files ====
	Because script files are essentially plain text files, they can be edited with just about any text editor. For instance, the native Windows Notepad can be used, but working with it is not very comfortable. As such, regular scripters typically use more versatile applications such as [https://notepad-plus-plus.org Notepad++] or [https://code.visualstudio.com Visual Studio Code], usually in combination with plugins that add additional support for SQF. One feature commonly provided by these plugins is ''syntax highlighting'', and for good reason: Syntax highlighting makes code significantly more readable and helps recognizing and avoiding basic syntax errors. Consequently, it is highly recommended to use syntax highlighting.		Because script files are essentially plain text files, they can be edited with just about any text editor. For instance, the native Windows Notepad can be used, but working with it is not very comfortable. As such, regular scripters typically use more versatile applications such as {{Link\|https://notepad-plus-plus.org\|Notepad++}} or {{Link\|https://code.visualstudio.com\|Visual Studio Code}}, usually in combination with plugins that add additional support for SQF. One feature commonly provided by these plugins is ''syntax highlighting'', and for good reason: Syntax highlighting makes code significantly more readable and helps recognizing and avoiding basic syntax errors. Consequently, it is highly recommended to use syntax highlighting.

	See [[:Category:Community Tools#Code Edition\|Community Tools - Code Edition]] for a selection of community-made applications and plugins for Arma Scripting.		See [[:Category:Community Tools#Code Edition\|Community Tools - Code Edition]] for a selection of community-made applications and plugins for Arma Scripting.
Line 328:		Line 328:
	* {{Link\|link= https://www.armaholic.com/page.php?id=20465\|text= Fockers Arma 3 Scripting Guide}}		* {{Link\|link= https://www.armaholic.com/page.php?id=20465\|text= Fockers Arma 3 Scripting Guide}}
	* {{Link\|link= https://www.armaholic.com/page.php?id=4847\|text= Mr-Murray's Armed Assault Editing Guide - Deluxe Edition}}		* {{Link\|link= https://www.armaholic.com/page.php?id=4847\|text= Mr-Murray's Armed Assault Editing Guide - Deluxe Edition}}
	* [https://youtu.be/WmEBN-RbK44 Excellent German SQF tutorial (YouTube)]		* {{Link\|https://youtu.be/WmEBN-RbK44\|Excellent German SQF tutorial (YouTube)}}


	[[Category:Arma Scripting Tutorials]]		[[Category:Arma Scripting Tutorials]]

Lou Montana: Add some links

2023-04-13T14:57:50Z

Add some links

← Older revision		Revision as of 16:57, 13 April 2023
Line 36:		Line 36:

	While operators are usually fairly intuitive to use, commands are often more complicated. As such, every single command (and every single operator) has a dedicated [[Main Page\|Community Wiki]] page documenting it. This makes the Community Wiki an essential resource for scripting as it can be consulted whenever an unfamiliar command is encountered or needs to be used. The documentation commonly includes information about the behaviour and effect of the command, its return value and the purpose and data types of its parameters.		While operators are usually fairly intuitive to use, commands are often more complicated. As such, every single command (and every single operator) has a dedicated [[Main Page\|Community Wiki]] page documenting it. This makes the Community Wiki an essential resource for scripting as it can be consulted whenever an unfamiliar command is encountered or needs to be used. The documentation commonly includes information about the behaviour and effect of the command, its return value and the purpose and data types of its parameters.

			{{Feature\|informative\|Commands List can be found here: [[:Category:Scripting Commands\|Scripting Commands]].}}

	=== Control Structures, Conditions and Booleans ===		=== Control Structures, Conditions and Booleans ===

	[[Control Structures]] allow scripts to accomplish complex tasks. ~~For instance, this code ...~~		[[Control Structures]] allow scripts to accomplish complex tasks. See the following:
	<sqf>		<sqf>
	if (damage player > 0.5) then {		if (damage player > 0.5) then
			{
	player setDamage 0;		player setDamage 0;
	systemChat "The player has been healed.";		systemChat "The player has been healed.";
	} else {		}
			else
			{
	systemChat "The player is fine.";		systemChat "The player is fine.";
	};		};
	</sqf>		</sqf>
	~~...~~ behaves differently depending on the damage status of the player. The [[systemChat]] output and whether or not the player is healed changes dynamically based on how much health the player has when the code is executed.		This code behaves differently depending on the damage status of the player. The [[systemChat]] output and whether or not the player is healed changes dynamically based on how much health the player has when the code is executed.

	==== Conditions ====		==== Conditions ====
Line 126:		Line 131:
	Boolean operations can be used to create complex conditions by combining multiple conditions into one.		Boolean operations can be used to create complex conditions by combining multiple conditions into one.
	<sqf>		<sqf>
	if ((alive VIP_1 && triggerActivated VIP_1_Task_Complete) \|\| (alive VIP_2 && triggerActivated VIP_2_Task_Complete)) then {		if ((alive VIP_1 && triggerActivated VIP_1_Task_Complete) \|\| (alive VIP_2 && triggerActivated VIP_2_Task_Complete)) then
			{
	systemChat "At least one VIP has been rescued.";		systemChat "At least one VIP has been rescued.";
	};		};
Line 140:		Line 146:
	An [[Array]] is a [[:Category:Data Types\|Data Type]] that can be seen as a list of items. This list can hold none to multiple elements of different types:		An [[Array]] is a [[:Category:Data Types\|Data Type]] that can be seen as a list of items. This list can hold none to multiple elements of different types:
	<sqf>		<sqf>
	[] // empty array		[] // an empty array
	[true] // array of 1 element (Boolean)		[true] // an array of 1 element (Boolean)
	[0, 10, 20, 30, 40, 50] // an array of 6 elements of Number type		[0, 10, 20, 30, 40, 50] // an array of 6 elements of Number type
	["John Doe", 32, true] // an array of 3 elements of different types (String, Number, Boolean)		["John Doe", 32, true] // an array of 3 elements of different types (String, Number, Boolean)
Line 161:		Line 167:
	Unfortunately, Windows does not make the creation of blank files with a desired file extension easily accessible.		Unfortunately, Windows does not make the creation of blank files with a desired file extension easily accessible.

	For instance, a common pitfall when trying to use [[Description.ext]] (a file that is used to configure certain mission features such as the respawn settings) for the first time is (unknowingly) creating {{hl\|Description.ext.txt}} instead of {{hl\|Description.ext}} because the Windows File Explorer hides file extensions by default. Obviously, {{hl\|Description.ext.txt}} will not work and will not have any of the desired effects on the mission because the game does not recognize it as {{hl\|Description.ext}}, but identifying a wrong file extension as the root cause of an issue when troubleshooting is notoriously difficult as one is usually looking for errors in the code and not in the filename.		For instance, a common pitfall when trying to use [[Description.ext]] (a file that is used to configure certain mission features such as the respawn settings) for the first time is (unknowingly) creating {{hl\|Description.ext.txt}} instead of {{hl\|Description.ext}} because the Windows File Explorer hides file extensions by default.
			Obviously, {{hl\|Description.ext.txt}} will not work and will not have any of the desired effects on the mission because the game does not recognize it as {{hl\|Description.ext}}, but identifying a wrong file extension as the root cause of an issue when troubleshooting is notoriously difficult as one is usually looking for errors in the code and not in the filename.

	While there are many different ways to create a blank text file with a specific file extension, the easiest method using native Windows tools is probably this:		While there are many different ways to create a blank text file with a specific file extension, the easiest method using native Windows tools is probably this:
Line 174:		Line 181:
	# Click on ''Text Document''		# Click on ''Text Document''
	# Rename {{hl\|New Text Document.txt}} to what you need		# Rename {{hl\|New Text Document.txt}} to what you need

			{{Feature\|informative\|It is also possible to bypass Notepad's automatic addition of the {{hl\|.txt}} extension by wrapping the file name in quote, e.g {{hl\|"description.ext"}}.}}

	==== File Locations ====		==== File Locations ====
	In the context of mission creation, script files generally need to be placed in the corresponding ''scenario folder'' (often also called the ''mission root folder''). Every mission has its own scenario folder, it is created by the Editor when saving the scenario for the first time. By default it only contains a single file called [[Mission.sqm\|{{hl\|mission.sqm}}]]; this file mostly stores data regarding Editor-placed entities and does not need to be touched when scripting.		In the context of mission creation, script files generally need to be placed in the corresponding ''scenario folder'' (often also called the ''mission root folder''). Every mission has its own scenario folder, it is created by the Editor when saving the scenario for the first time.
			By default it only contains a single file called [[Mission.sqm\|{{hl\|mission.sqm}}]]; this file mostly stores data regarding Editor-placed entities and does not need to be touched when scripting.

			[[Description.ext]] and [[Event Scripts]] have to be placed directly in the root of the scenario folder (i.e. next to {{hl\|mission.sqm}}), but all other files can be placed in subfolders of the scenario folder.
			A well-structured scenario folder could look like this:

	[[Description.ext]] and [[Event Scripts]] have to be placed directly in the root of the scenario folder (i.e. next to {{hl\|mission.sqm}}), but all other files can be placed in subfolders of the scenario folder. A well-structured scenario folder could look like this:
	{{Color\|green\|Apex%20Protocol.Tanoa}}/		{{Color\|green\|Apex%20Protocol.Tanoa}}/
	{{Color\|lightgrey\|├──}} functions/		{{Color\|lightgrey\|├──}} functions/
Line 191:		Line 203:
	{{Color\|lightgrey\|└──}} mission.sqm		{{Color\|lightgrey\|└──}} mission.sqm

	Each scenario folder is stored in either the {{hl\|missions}} or the {{hl\|mpmissions}} subfolder of the folder containing the [[Profile\|Arma Profile]] that was used to create the scenario. For instance, the path to the scenario folder from the example above could be:		Each scenario folder is stored in either the {{hl\|missions}} or the {{hl\|mpmissions}} subfolder of the folder containing the [[Profile\|Arma Profile]] that was used to create the scenario.
			For instance, the path to the scenario folder from the example above could be:
	C:\Users\Scott Miller\Documents\Arma 3 - Other Profiles\Keystone\missions\{{Color\|green\|Apex%20Protocol.Tanoa}}		C:\Users\Scott Miller\Documents\Arma 3 - Other Profiles\Keystone\missions\{{Color\|green\|Apex%20Protocol.Tanoa}}
	The Editor uses {{Link\|https://en.wikipedia.org/wiki/Percent-encoding\|percent-encoding}} for scenario folder names, that is why whitespaces in the scenario name are replaced with {{hl\|%20}}.		The Editor uses {{Link\|https://en.wikipedia.org/wiki/Percent-encoding\|percent-encoding}} for scenario folder names, that is why whitespaces in the scenario name are replaced with {{hl\|%20}}.
Line 221:		Line 234:

	{{Wiki\|TODO\|		{{Wiki\|TODO\|
	* Functions		* [[:Category:Functions\|Functions]]
	* ~~Namespaces~~, Scopes		* [[Namespace]]s, {{Link\|Variables#Scopes\|Scopes}}
	* Event Handlers		* {{Link\|:Category:Event Handlers\|Event Handlers}}
	* ~~HashMaps~~		* [[HashMap]]s
	}}		}}

Line 231:		Line 244:

	{{Wiki\|TODO\|		{{Wiki\|TODO\|
	* Multiplayer Scripting		* [[Multiplayer Scripting]]
	* GUIs		* [[GUI Tutorial\|GUIs]]
	* ~~Optimization~~		* [[Code Optimisation]]
	* Debugging		* [[Debugging Techniques]]
	}}		}}

Lou Montana: /* Positions */ Fix bold markup

2023-03-09T13:09:09Z

Positions: Fix bold markup

← Older revision		Revision as of 15:09, 9 March 2023
Line 149:		Line 149:
	==== Positions ====		==== Positions ====
	[[Position]]s are represented as 2D or 3D [[Array]]s of [[Number]]s (usually in the format <sqf inline>[X, Y]</sqf> or <sqf inline>[X, Y, Z]</sqf>) where X represents West-East, Y represents South-North and Z represents altitude.		[[Position]]s are represented as 2D or 3D [[Array]]s of [[Number]]s (usually in the format <sqf inline>[X, Y]</sqf> or <sqf inline>[X, Y, Z]</sqf>) where X represents West-East, Y represents South-North and Z represents altitude.
	However, there are some important caveats and distinctions one should be aware of - for instance, the positions <sqf inline>[0, 0, 0]</sqf> ASL ('''A'''bove '''S'''ea '''L''evel) and <sqf inline>[0, 0, 0]</sqf> AGL ('''A'''bove '''G'''round '''L'''evel) are not necessarily equivalent.		However, there are some important caveats and distinctions one should be aware of - for instance, the positions <sqf inline>[0, 0, 0]</sqf> ASL ('''A'''bove '''S'''ea '''L'''evel) and <sqf inline>[0, 0, 0]</sqf> AGL ('''A'''bove '''G'''round '''L'''evel) are not necessarily equivalent.
	It is therefore highly recommended to read the [[Position]]s page before working with positions.		It is therefore highly recommended to read the [[Position]]s page before working with positions.

Lou Montana: Text replacement - "\{\{ Wikipedia \| ([-a-zA-Z0-9_#':%\/\\]+) \| ([-a-zA-Z0-9_#':%\/\\ ]+) \}\}" to "{{Link|https://en.wikipedia.org/wiki/$1|$2}}"

2023-02-23T23:47:47Z

Text replacement - "\{\{ *Wikipedia *\| *([-a-zA-Z0-9_#':%\/\\]+) *\| *([-a-zA-Z0-9_#':%\/\\ ]+) *\}\}" to "{{Link|https://en.wikipedia.org/wiki/$1|$2}}"

← Older revision		Revision as of 01:47, 24 February 2023
Line 193:		Line 193:
	Each scenario folder is stored in either the {{hl\|missions}} or the {{hl\|mpmissions}} subfolder of the folder containing the [[Profile\|Arma Profile]] that was used to create the scenario. For instance, the path to the scenario folder from the example above could be:		Each scenario folder is stored in either the {{hl\|missions}} or the {{hl\|mpmissions}} subfolder of the folder containing the [[Profile\|Arma Profile]] that was used to create the scenario. For instance, the path to the scenario folder from the example above could be:
	C:\Users\Scott Miller\Documents\Arma 3 - Other Profiles\Keystone\missions\{{Color\|green\|Apex%20Protocol.Tanoa}}		C:\Users\Scott Miller\Documents\Arma 3 - Other Profiles\Keystone\missions\{{Color\|green\|Apex%20Protocol.Tanoa}}
	The Editor uses {{~~Wikipedia~~\|Percent-encoding\|percent-encoding}} for scenario folder names, that is why whitespaces in the scenario name are replaced with {{hl\|%20}}.		The Editor uses {{Link\|https://en.wikipedia.org/wiki/Percent-encoding\|percent-encoding}} for scenario folder names, that is why whitespaces in the scenario name are replaced with {{hl\|%20}}.

	{{Feature\|informative\|		{{Feature\|informative\|

Lou Montana: Add Array description + some formatting

2023-02-10T16:23:20Z

Add Array description + some formatting

Show changes

← Older revision		Revision as of 01:47, 24 February 2023
Line 193:		Line 193:
	Each scenario folder is stored in either the {{hl\|missions}} or the {{hl\|mpmissions}} subfolder of the folder containing the [[Profile\|Arma Profile]] that was used to create the scenario. For instance, the path to the scenario folder from the example above could be:		Each scenario folder is stored in either the {{hl\|missions}} or the {{hl\|mpmissions}} subfolder of the folder containing the [[Profile\|Arma Profile]] that was used to create the scenario. For instance, the path to the scenario folder from the example above could be:
	C:\Users\Scott Miller\Documents\Arma 3 - Other Profiles\Keystone\missions\{{Color\|green\|Apex%20Protocol.Tanoa}}		C:\Users\Scott Miller\Documents\Arma 3 - Other Profiles\Keystone\missions\{{Color\|green\|Apex%20Protocol.Tanoa}}
	The Editor uses {{~~Wikipedia~~\|Percent-encoding\|percent-encoding}} for scenario folder names, that is why whitespaces in the scenario name are replaced with {{hl\|%20}}.		The Editor uses {{Link\|https://en.wikipedia.org/wiki/Percent-encoding\|percent-encoding}} for scenario folder names, that is why whitespaces in the scenario name are replaced with {{hl\|%20}}.

	{{Feature\|informative\|		{{Feature\|informative\|