Utilities – Arma 3

Latest revision as of 13:54, 15 September 2025

1.68 In order to access the Utilities list, type utils in debug console and click on LOCAL EXEC or execute execVM "A3\Functions_F\Debug\Utilities\lib\index.sqf".

ⓘ

To find out how to access a tool directly, see description of the tools below.

CfgDisabledCommands Template Generator

Auto-generates template to be used with CfgDisabledCommands.

Shortcut:	`utils 1`
Script:	execVM "A3\Functions_F\Debug\Utilities\utility_cfgDisabledCommands.sqf"

Print Config

Prepares formatted config. There is a limit on how much of the config information can be retrieved and is limited by the Array maximum capacity.

Shortcut:	`utils 2`
Script:	execVM "A3\Functions_F\Debug\Utilities\utility_printConfig.sqf"

Moon Phases Tool

Moon Phases

Finds moon phases throughout given year. The longer the bar the brighter the night.

Shortcut:	`utils 3`
Script:	execVM "A3\Functions_F\Debug\Utilities\utility_moonPhases.sqf"

Jukebox

Plays music from CfgMusic. One can navigate through the track by dragging the progress bar left or right and pause/resume by clicking again on the song in the list. The track information for played track in window shows the actual track duration, while the track duration in the list comes from config and could be inaccurate.

Shortcut:	`utils 4`
Script:	execVM "A3\Functions_F\Debug\Utilities\utility_jukebox.sqf"

Script Commands

Lists all available script commands and their arguments.

Shortcut:	`utils 5`
Script:	execVM "A3\Functions_F\Debug\Utilities\utility_scriptCommands.sqf"

Limited modifiers can be used with search:

"<word>"	Searches for exact word, for example:	"addmagazine"
*	Replaces asterisk with anything, for example:	add*global
-	Ignores given word, for example:	addMagazine-cargo

Notepad++ language highlight template export

2.22

Notepad++ Export

All script commands can be exported in Notepad++ syntax highlight template format (light and dark).

Follow the instructions on the export page, here is a short transcript:

Copy this content to clipboard with Ctrl + A/Ctrl + C
Open Notepad++ and open a new file
Paste the copied content into the new file with Ctrl + V
Save the file as arma3sqf.xml
Open Notepad++ template directory via Notepad++ menu: Language → User Defined Language → Open User Defined Language folder...
Move arma3sqf.xml in this directory and restart Notepad++
From the Language menu, select:
- ARMA 3 SQF (Default) - for Default style
- ARMA 3 SQF (DarkModeDefault) - for DarkModeDefault style

The style can be chosen in: Settings → Style Configurator...

Light mode syntax highlight example
Dark mode syntax highlight example

@@ Line 1: / Line 1: @@
-{{GVI|arma 3|1.68}}
+[[File:Utilities.jpg|500px|right]]
-<br>
+{{TOC|side}}
-=Arma 3 Utilities=
+{{GVI|arma3|1.68}}
+In order to access the Utilities list, type {{hl|utils}} in [[Arma 3: Debug Console|debug console]] and click on {{hl|LOCAL EXEC}} or execute <sqf inline>execVM "A3\Functions_F\Debug\Utilities\lib\index.sqf"</sqf>.
+{{Feature|informative|To find out how to access a tool directly, see description of the tools below.}}
-A list of utilities is available in Arma 3 since v1.67. In order to access the list, type <tt>utils</tt> in [[Arma_3_Debug_Console | debug console]] and click on LOCAL EXEC or use with designated utility shortcut.
+{{Clear}}
-<br><br>
-[[Image:Utilities.jpg|500px]]
-<br><br>
-==CfgDisabledCommands Template Generator==
-Auto-generates template to be used with [[CfgDisabledCommands]]
+[[File:CfgDisabledCommands.jpg|thumb|500px|[[CfgDisabledCommands]] Template Generator]]
-<br><br>
+== CfgDisabledCommands Template Generator ==
-[[Image:CfgDisabledCommands.jpg|500px]]
-<br><br>
-'''Shortcut:''' <tt>utils 1</tt>
-==Print Config==
+Auto-generates template to be used with [[CfgDisabledCommands]].
+{|
+! Shortcut:
+| {{hl|utils 1}}
+|-
+! Script:
+| <sqf>execVM "A3\Functions_F\Debug\Utilities\utility_cfgDisabledCommands.sqf"</sqf>
+|}
+{{Clear}}
-Prepares formatted config
-<br><br>
-[[Image:PrintConfig.jpg|500px]]
-<br><br>
-'''Shortcut:''' <tt>utils 2</tt>
-==Moon Phases==
+[[File:PrintConfig.jpg|thumb|500px|Print Config]]
+== Print Config ==
-Finds moon phases throughout given year
+Prepares formatted config. There is a limit on how much of the config information can be retrieved and is limited by the [[Array]] maximum capacity.
-<br><br>
+{|
-[[Image:MoonPhases.jpg|500px]]
+! Shortcut:
-<br><br>
+| {{hl|utils 2}}
-'''Shortcut:''' <tt>utils 3</tt>
+|-
+! Script:
+| <sqf>execVM "A3\Functions_F\Debug\Utilities\utility_printConfig.sqf"</sqf>
+|}
+{{Clear}}
-==Jukebox==
-Plays music from CfgMusic
+[[File:MoonPhases.jpg|thumb|500px|Moon Phases Tool]]
-<br><br>
-[[Image:Jukebox.jpg|500px]]
-<br><br>
-'''Shortcut:''' <tt>utils 4</tt>
-==Script Commands==
+== Moon Phases ==
-Lists all available script commands and their arguments
-<br><br>
-[[Image:ScriptCommands.jpg|500px]]
-<br><br>
-'''Shortcut:''' <tt>utils 5</tt>
-{{GameCategory|arma3}}
+Finds moon phases throughout given year. The longer the bar the brighter the night.
+{|
+! Shortcut:
+| {{hl|utils 3}}
+|-
+! Script:
+| <sqf>execVM "A3\Functions_F\Debug\Utilities\utility_moonPhases.sqf"</sqf>
+|}
+{{Clear}}
+[[File:Jukebox.jpg|thumb|500px|Jukebox]]
+== Jukebox ==
+Plays music from CfgMusic. One can navigate through the track by dragging the progress bar left or right and pause/resume by clicking again on the song in the list. The track information for played track in window shows the actual track duration, while the track duration in the list comes from config and could be inaccurate.
+{|
+! Shortcut:
+| {{hl|utils 4}}
+|-
+! Script:
+| <sqf>execVM "A3\Functions_F\Debug\Utilities\utility_jukebox.sqf"</sqf>
+|}
+{{Clear}}
+[[File:ScriptCommands.jpg|thumb|500px|Script Commands]]
+== Script Commands ==
+Lists all available script commands and their arguments.
+{|
+! Shortcut:
+| {{hl|utils 5}}
+|-
+! Script:
+| <sqf>execVM "A3\Functions_F\Debug\Utilities\utility_scriptCommands.sqf"</sqf>
+|}
+Limited modifiers can be used with search:
+{|
+! <pre>"<word>"</pre>
+| Searches for exact word, for example:
+| <pre>"addmagazine"</pre>
+|-
+! <pre>*</pre>
+| Replaces asterisk with anything, for example:
+| <pre>add*global</pre>
+|-
+! <pre>-</pre>
+| Ignores given word, for example:
+| <pre>addMagazine-cargo</pre>
+|}
+{{Clear}}
+[[File:template.jpg|thumb|500px|Notepad++ language highlight template export]]
+{{ArgTitle|3|Notepad++ Export|{{GVI|arma3|2.22}}}}
+All script commands can be exported in Notepad++ syntax highlight template format (light and dark).
+Follow the instructions on the export page, here is a short transcript:
+# Copy this content to clipboard with {{Controls|Ctrl|A}}/{{Controls|Ctrl|C}}
+# Open Notepad++ and open a new file
+# Paste the copied content into the new file with {{Controls|Ctrl|V}}
+# Save the file as {{hl|arma3sqf.xml}}
+# Open Notepad++ template directory via Notepad++ menu: Language &rarr; User Defined Language &rarr; Open User Defined Language folder...
+# Move arma3sqf.xml in this directory and restart Notepad++
+# From the Language menu, select:
+#* ARMA 3 SQF (Default) - for Default style
+#* ARMA 3 SQF (DarkModeDefault) - for DarkModeDefault style
+The style can be chosen in: Settings  &rarr; Style Configurator...
+{{Clear}}
+<gallery mode="packed">
+File:NPP_light.jpg|thumb|500px|Light mode syntax highlight example
+File:NPP_dark.jpg|thumb|500px|Dark mode syntax highlight example
+</gallery>
+{{GameCategory|arma3|Editing}}
+[[Category:Introduced with Arma 3 version 1.68]]