Arma: GUI Configuration

Dialogs are one way to provide custom graphical user interface in your missions and allow interaction with the player as well as they are able to run code. They are defined as classes in the missionConfigFile (description.ext), campaignConfigFile (Campaign Description.ext) or configFile (config.cpp).

• 

  Custom Briefing Editor

• 

  Teamswitch GUI

• 

  Dynamic Groups GUI

Terminology

GUI

Graphical User Interface - Allows user interaction with the software through graphical controls like buttons, lists and so on.

UI

User Interface - Allows the user to interact with the software through a console application.

IGUI

Integrated Graphical User Interface - A term usually encountered when talking about vanilla menus in Arma 3.

User Interface Types

Dialog

• Can be created upon an existing display. Parent display will be hidden.

• • Player movement is blocked by dialog
  • Commands: createDialog, closeDialog, allControls, dialog

Display

• Can be created upon an existing display. Parent display will be hidden.
• Player movement is not blocked by display, if it has not been blocked by its parent display already.
  • Commands: createDisplay, closeDisplay, allControls, allDisplays

ⓘ

Generally speaking, dialogs and displays are identical. They are only differentiated by the way they are created (createDisplay, createDialog).

HUD

• Is created in a new, or already existing layer. The user can not interact with it. Usually used to show information, like stamina, ammunition and so on.
  • Commands: allCutLayers, titleRsc, cutText, cutObj, cutFadeOut, setTitleEffect, allActiveTitleEffects

ⓘ

Some of the commands have different effects. Please check the command's biki page for detailed information.

Display and Dialog

Displays and dialogs are defined in the config file. They are usually used to simplify user interactions, through controls like buttons, list boxes and so on.

Properties

Name	Type	Remark
idd	Integer	The unique ID number of this dialog. Used with findDisplay to find the display. Can be -1 if no access is required from within a script.
access	Integer	0 - ReadAndWrite - this is the default case where properties can still be added or overridden. 1 - ReadAndCreate - this only allows creating new properties. 2 - ReadOnly - this does not allow to do anything in deriving classes. 3 - ReadOnlyVerified - this does not allow to do anything either in deriving classes, and a CRC check will be performed.
movingEnable	Boolean	Specifies whether the dialog can be moved or not (if enabled one of the dialogs controls should have the moving property set to 1 so it becomes the "handle" the dialog can be moved with). Doesn't seem to matter in Arma 3
enableSimulation	Boolean	Specifies whether the game continues while the dialog is shown or not.
onLoad	String	Expression executed when the dialog is opened. See User Interface Event Handlers
onUnload	String	Expression executed when the dialog is closed. See User Interface Event Handlers
controlsBackground	Array or class	Contains class names of all background controls associated to this dialog. The sequence in which the controls are listed will decide their z-index (i.e. the last ones will on top of the first ones).
controls	Array or class	Contains class names of all foreground controls associated to this dialog.
objects	Array or class	List of all DialogControls-Objects type controls

Example Config

Show Example Config

class DefaultDialog
{
	idd = -1;
	access = 0;
	movingEnable = true;
	onLoad = "hint str _this";
	onUnload  = "hint str _this";
	enableSimulation = false;
	class ControlsBackground
	{
		//Background controls
	};
	class Controls
	{
		//Controls
	};
	class Objects
	{
		//Objects
	};
};

Opening a display or dialog

There are two ways of creating a display or dialog. One can either use createDialog or createDisplay command.

Closing a display or dialog

There are several ways to close a dialog:

• Pressing Esc
• Clicking a button with IDC 0, 1 or 2
• closeDialog
• closeDisplay

Exit Codes

Exit codes are a way to determine in what way a display was closed. The onUnload UIEH has the exit code as one of its parameters. This way you can handle different user decisions, eg. save a value if the user confirms it or discard changes when the user pressed a cancel button. Macros for the different exit codes can be found in \a3\ui_f\hpp\defineResincl.inc:

// Predefined controls
#define IDC_OK				1
#define IDC_CANCEL			2
#define IDC_AUTOCANCEL		3
#define IDC_ABORT			4
#define IDC_RESTART			5
#define IDC_USER_BUTTON		6
#define IDC_EXIT_TO_MAIN	7

Exit Code	Macro	Comment
1	IDC_OK	Dialog was closed with a positive outcome
2	IDC_CANCEL	Dialog was closed with a negative outcome
3	IDC_AUTOCANCEL	?
4	IDC_ABORT	When used on the mission display (Display #46) it simulates "Save and Exit" button from escape menu
5	IDC_RESTART	?
6	IDC_USER_BUTTON	?
7	IDC_EXIT_TO_MAIN	?

HUDs

HUDs are defined in the class RscTitles, unlike displays or dialogs which are root classes in the config file. Additionally, their properties are different.

Properties

Name	Type	Remark
idd	Integer	The unique ID number of this HUD. Used with findDisplay to find the display. Can be -1 if no access is required from within a script.
fadeIn	Integer	Duration of fade in effect when opening in seconds.
fadeOut	Integer	Duration of fade out effect when closing in seconds.
duration	Integer	Duration the HUD is displayed after opening in seconds. Use a very large number to have it always open.
onLoad	String	Expression executed when the dialog is opened. See User Interface Event Handlers
onUnload	String	Expression executed when the dialog is closed. See User Interface Event Handlers
controls	Array	Contains class names of all foreground controls associated to this dialog.

Example Config

Show Example Config

#include "\a3\ui_f\hpp\definecommongrids.inc"

class RscTitles
{
	class RscInfoText
	{
		idd = 3100;
		fadein = 0;
		fadeout = 0;
		duration = 1e+011;
		onLoad = "uinamespace setVariable ['BIS_InfoText',_this select 0]";
		onUnLoad = "uinamespace setVariable ['BIS_InfoText', nil]";
		class Controls
		{
			class InfoText
			{
				idc = 3101;
				style = "0x01 + 0x10 + 0x200 + 0x100";
				font = "RobotoCondensedBold";
				x = "(profileNamespace getVariable [""IGUI_GRID_MISSION_X"", (safezoneX + safezoneW - 21 * (GUI_GRID_WAbs / 40))])";
				y = "(profileNamespace getVariable [""IGUI_GRID_MISSION_Y"", (safezoneY + safezoneH - 10.5 * (GUI_GRID_HAbs / 25))])";
				w = "20 * (GUI_GRID_WAbs / 40)";
				h = "5 * ((GUI_GRID_WAbs / 1.2) / 25)";
				colorText[] = {1,1,1,1};
				colorBackground[] = {0,0,0,0};
				text = "";
				lineSpacing = 1;
				sizeEx = 0.045;
				fixedWidth = 1;
				deletable = 0;
				fade = 0;
				access = 0;
				type = 0;
				shadow = 1;
				colorShadow[] = {0,0,0,0.5};
				tooltipColorText[] = {1,1,1,1};
				tooltipColorBox[] = {1,1,1,1};
				tooltipColorShade[] = {0,0,0,0.65};
			};
		};
	};
};

↑ Back to spoiler's top

Controls

Controls are used to allow the player to interact with the GUI. Controls range from simple rectangles to 3D objects. Like dialogs, displays and HUDs, controls can have a unique ID to access them from within scripts. The classname of controls have to be unique.

What properties a control needs is defined by its type property. However most controls share a set of properties described in the following sections. For control specific properties visit the corresponding pages.

Common Properties

Name	Type	Remark
idc	Integer	The unique ID number of this control. Can be -1 if you don't require access to the control itself from within a script. Special (button) IDCs (according to \a3\ui_f\hpp\defineResincl.inc): 1: OK (closes display when clicked upon, raises exit code 1 in the onUnload UIEH) 2: Cancel (closes display when clicked upon, raises exit code 2 in the onUnload UIEH) 3: Auto cancel 4: Abort 5: Restart 6: User button 7: Exit to main While the purposes of idcs 3 to 7 remain unknown, it is advisable to give all of your controls larger numbers, eg. 100.
moving	Boolean	Whether the dialog will be moved if this control is dragged (may require "movingEnable" to be 1 in the dialog. In Arma 3 works regardless). Another way of allowing moving of the dialog is to have control of style ST_TITLE_BAR
type	Integer	See Control Types
style	Integer	See Control Styles. style = "0x400+0x02+0x10";
x/y/w/h	Number	The position and size of the control in fractions of screen size.
sizeEx	Number	The font size of text in fractions of screen size. Behaves similar to h property. For some controls it is named size.
font	String	The font to use. See the list of available fonts for possible values.
colorText	Array	Text color
colorBackground	Array	Background color
text	String	The text or picture to display.
shadow	Integer	Can be applied to most controls (0 = no shadow, 1 = drop shadow with soft edges, 2 = stroke).
tooltip	String	Text to display in a tooltip when control is moused over. A tooltip can be added to any control type except CT_STATIC and CT_STRUCTURED_TEXT. Note: As of 1.48, most controls now support tooltips. A linebreak can be created by adding \n.
tooltipColorShade	Array	Tooltip background color
tooltipColorText	Array	Tooltip text color
tooltipColorBox	Array	Tooltip border color
autocomplete	String	(where applicable) Option for entry fields (e.g. RscEdit) to activate autocompletion. For known script commands and functions use autocomplete = "scripting".
url	String	(where applicable) URL which will be opened when clicking on the control. Used on e.g. a button control. Does not utilize the Steam Overlay browser if enabled by default, opens the link in the default browser set by the OS.
overlayMode	Number	2.10 (where applicable) 0 - opens URL in default browser; 1 - opens URL in Steam overlay id enabled, otherwise in default browser; 2 - opens URL in Steam overlay, shows error message box (with button to use default browser) if Steam overlay is disabled.

A property to enable or disable a control does not exist (because of implementation issues). However, there is a simple workaround based on the onLoad UI Event Handler that can be used to disable a control in the config:

onLoad = "(_this # 0) ctrlEnable false;";

Attributes Class

Name	Type	Remark
font	String	Available Fonts
color	HTML color	HTML Color Codes
align	String	"center", "left", "right"
shadow	Integer	0 = no shadow, 1 = drop shadow with soft edges, 2 = stroke

AttributesImage Class

Name	Type	Remark
font	String	Available Fonts (Optional)
color	HTML color	HTML Color Codes
align	String	"center", "left", "Right" (optional)

Example Config

Show Example Config

#include "\a3\ui_f\hpp\definecommongrids.inc"

class RscButton
{
	deletable = 0;
	fade = 0;
	access = 0;
	type = 1;
	text = "";
	colorText[] = {1,1,1,1};
	colorDisabled[] = {1,1,1,0.25};
	colorBackground[] = {0,0,0,0.5};
	colorBackgroundDisabled[] = {0,0,0,0.5};
	colorBackgroundActive[] = {0,0,0,1};
	colorFocused[] = {0,0,0,1};
	colorShadow[] = {0,0,0,0};
	colorBorder[] = {0,0,0,1};
	soundEnter[] = {"\A3\ui_f\data\sound\RscButton\soundEnter",0.09,1};
	soundPush[] = {"\A3\ui_f\data\sound\RscButton\soundPush",0.09,1};
	soundClick[] = {"\A3\ui_f\data\sound\RscButton\soundClick",0.09,1};
	soundEscape[] = {"\A3\ui_f\data\sound\RscButton\soundEscape",0.09,1};
	idc = -1;
	style = 2;
	x = 0;
	y = 0;
	w = 0.095589;
	h = 0.039216;
	shadow = 2;
	font = "RobotoCondensed";
	sizeEx = "GUI_GRID_HAbs / 25";
	url = "";
	offsetX = 0;
	offsetY = 0;
	offsetPressedX = 0;
	offsetPressedY = 0;
	borderSize = 0;
};

↑ Back to spoiler's top

Control Types

The type property of controls defines what type of control they are. For example an edit box has the type 2. There is an ingame dialog with examples of how the control types look and act like:

createDialog "RscTestControlTypes";

Control Type Definitions

All definitions can be retrieved with "Default" call BIS_fnc_exportGUIBaseClasses;.
Show Control Type Definitions

#define CT_STATIC				  0
#define CT_BUTTON				  1
#define CT_EDIT					  2
#define CT_SLIDER				  3
#define CT_COMBO				  4
#define CT_LISTBOX				  5
#define CT_TOOLBOX				  6
#define CT_CHECKBOXES			  7
#define CT_PROGRESS				  8
#define CT_HTML					  9
#define CT_STATIC_SKEW			 10
#define CT_ACTIVETEXT			 11
#define CT_TREE					 12
#define CT_STRUCTURED_TEXT		 13
#define CT_CONTEXT_MENU			 14
#define CT_CONTROLS_GROUP		 15
#define CT_SHORTCUTBUTTON		 16
#define CT_HITZONES				 17
#define CT_VEHICLETOGGLES		 18
#define CT_CONTROLS_TABLE		 19
#define CT_XKEYDESC				 40
#define CT_XBUTTON				 41
#define CT_XLISTBOX				 42
#define CT_XSLIDER				 43
#define CT_XCOMBO				 44
#define CT_ANIMATED_TEXTURE		 45
#define CT_MENU					 46
#define CT_MENU_STRIP			 47
#define CT_CHECKBOX				 77
#define CT_OBJECT				 80
#define CT_OBJECT_ZOOM			 81
#define CT_OBJECT_CONTAINER		 82
#define CT_OBJECT_CONT_ANIM		 83
#define CT_LINEBREAK			 98
#define CT_USER					 99
#define CT_MAP					100
#define CT_MAP_MAIN				101
#define CT_LISTNBOX				102
#define CT_ITEMSLOT				103
#define CT_LISTNBOX_CHECKABLE	104
#define CT_VEHICLE_DIRECTION	105

↑ Back to spoiler's top

Control Styles

To further customize controls there are several different styles for each control type available.

To get an idea of how the styles look like you can create the following dialog:

createDialog "RscTestControlStyles";

⚠

Note that drawing of vertical text is not supported and any attempt to use ST_UP, ST_DOWN, ST_VCENTER is likely to result in the following .rpt spam:
Obsolete, sizeH and sizeW calculation missing
In addition, ST_UP, ST_DOWN, ST_VCENTER are stand alone styles and should not be mixed with any other styles

Define	Decimal	Hexadecimal	Remark
ST_LEFT	0	0x00	Default, text left aligned
ST_RIGHT	1	0x01	Modifier, adding this to another style will force text to be aligned to the right
ST_CENTER	2	0x02	Modifier, adding this to another style will force text to be centered
ST_DOWN	4	0x04	Vertical text alignment (See the note above)
ST_UP	8	0x08	Vertical text alignment (See the note above)
ST_VCENTER	12	0x0C	Vertical text alignment, same as ST_DOWN + ST_UP (See the note above)
ST_SINGLE	0	0x00	Plain single line box without a border
ST_MULTI	16	0x10	Plain multiple line box with a slight border. To remove border add 512 (+ ST_NO_RECT) to the style (style 528, 529 and 530 are therefore border-less). Additional parameter lineSpacing is required for this style. lineSpacing = 1; is normal line spacing. Any \n character in the text string will be interpreted as new line.
ST_TITLE_BAR	32	0x20	Plain single line box with semi-transparent background and somewhat embossed border. When this style is used, the dialog containing control becomes draggable by this control
ST_PICTURE	48	0x30	Border-less picture box. Text string is treated as a path to a texture. Alignment has no effect. The texture is stretched to fit the box by default. To force original aspect ratio add 2048 (+ ST_KEEP_ASPECT_RATIO) to the style. Background is ignored, colorText controls texture colour and opacity
ST_FRAME	64	0x40	Legend like frame without background with text showing over the frame edge. Alignment has no effect. colorText defines both text and frame colour
ST_BACKGROUND	80	0x50	Single line box with always black opaque background and thick raised beveled border
ST_GROUP_BOX	96	0x60	Single line box with delicate semi-transparent background and slight border. Only text colour can be controlled
ST_GROUP_BOX2	112	0x70	Plain single line box, same as ST_SINGLE, only with a slight border similar to ST_MULTI box border
ST_HUD_BACKGROUND	128	0x80	Sets special texture for corners. It was used for rounded corners in OFP, ArmA and Arma 2. In Arma 3, square corners are used everywhere, so the texture is adapted to the unified style, but the technology is not removed. In Arma 3 it looks the same as normal ST_SINGLE. Corner textures are defined in configFile >> "CfgInGameUI" >> "imageCornerElement" (can be set only globally for the whole game, not per control)
ST_TILE_PICTURE	144	0x90	The picture is tiled according to tileH and tileW values. To force tiled picture to keep aspect ratio of original image, add 2048 (+ ST_KEEP_ASPECT_RATIO) to the style.
ST_WITH_RECT	160	0xA0	Single line box frame, similar to ST_FRAME box. The text however is displayed inside the frame. Frame and text colour are set with colorText
ST_LINE	176	0xB0	Diagonal line going from left top corner to bottom right corner. To control line direction, width w and height h parameters of the box could be negative. Line and text colour are set with colorText
ST_UPPERCASE	192	0xC0	Forces control text to upper case
ST_LOWERCASE	208	0xD0	Forces control text to lower case
ST_ADDITIONAL_INFO	3840	0x0F00	ST_SHADOW + ST_NO_RECT + SL_HORZ + ST_KEEP_ASPECT_RATIO
ST_SHADOW	256	0x0100
ST_NO_RECT	512	0x0200	This style works for CT_STATIC in conjunction with ST_MULTI
ST_KEEP_ASPECT_RATIO	2048	0x0800	When used with image or texture, stops it from stretching to fit the control
ST_TITLE	34	0x22	ST_TITLE_BAR + ST_CENTER

Control Specific Styles

CT_LISTBOX Specific Styles

Define	Decimal	Hexadecimal	Remark
LB_TEXTURES	16	0x10
LB_MULTI	32	0x20	Makes CT_LISTBOX multi-selectable

CT_PROGRESS Specific Styles

Define	Decimal	Hexadecimal
ST_VERTICAL	1	0x01
ST_HORIZONTAL	0	0x00

CT_SLIDER Specific Styles

Define	Decimal	Hexadecimal
SL_VERT	0	0x00
SL_HORZ	1024	0x0400
SL_TEXTURES	16	0x10

CT_TREE Specific Styles

Define	Decimal	Hexadecimal	Remark
TR_SHOWROOT	1	0x01	When this style is applied, all entries even with path [] can be collapsed. Use unkown.
TR_AUTOCOLLAPSE	2	0x02	Use unknown

Control Style Definitions

All definitions can be retrieved with "Default" call BIS_fnc_exportGUIBaseClasses;.
Show Control Style Definitions

#define ST_LEFT					0x00
#define ST_RIGHT				0x01
#define ST_CENTER				0x02
#define ST_DOWN					0x04
#define ST_UP					0x08
#define ST_VCENTER				0x0C
#define ST_SINGLE				0x00
#define ST_MULTI				0x10
#define ST_TITLE_BAR			0x20
#define ST_PICTURE				0x30
#define ST_FRAME				0x40
#define ST_BACKGROUND			0x50
#define ST_GROUP_BOX			0x60
#define ST_GROUP_BOX2			0x70
#define ST_HUD_BACKGROUND		0x80
#define ST_TILE_PICTURE			0x90
#define ST_WITH_RECT			0xA0
#define ST_LINE					0xB0
#define ST_UPPERCASE			0xC0
#define ST_LOWERCASE			0xD0
#define ST_ADDITIONAL_INFO		0x0F00
#define ST_SHADOW				0x0100
#define ST_NO_RECT				0x0200
#define ST_KEEP_ASPECT_RATIO	0x0800
#define ST_TITLE				ST_TITLE_BAR + ST_CENTER
#define SL_VERT					0
#define SL_HORZ					0x400
#define SL_TEXTURES				0x10
#define ST_VERTICAL				0x01
#define ST_HORIZONTAL			0
#define LB_TEXTURES				0x10
#define LB_MULTI				0x20
#define TR_SHOWROOT				1
#define TR_AUTOCOLLAPSE			2

↑ Back to spoiler's top

Positioning

A detailed description of how you can achieve proper GUI placement can be found on the Arma 3: GUI Coordinates page.

Inheritance

Using inheritance can reduce your dialog class definitions significantly by standardising common attributes in base classes and just changing unique attributes in derived classes. There is no need to re-declare all attributes for every class definition.

ⓘ

Using inheritance can make your GUI config hard to read for others.

View the dedicated inheritance page for more information.

Preprocessor instructions

Note that you can also add your own preprocessor instructions for commonly used data, eg. for colors, to save yourself the hassle of writing it in several different places and then adapt each of them if you want to change them afterwards (especially if class inheritance is not applicable). It can also make your code more readable sometimes.

Example Config

Show Example Config

#define COLOR_HALF_BLACK { 0, 0, 0, 0.5 }

class MyDialog
{
	idd = -1;
	movingEnable = 1;
	objects[] = {};
	controlsBackground[] = { MyDialogBackground };

	class MyDialogBackground : RscText
	{
		colorBackground[] = COLOR_HALF_BLACK;
		x = 0.7;  y = 0.1;
		w = 0.25; h = 0.15;
	};
};

Useful includes

Arma 3 offers a wide range of useful files which can be included to get access to some helpful macros.

Include Code	Description / Content
#include "\a3\3DEN\UI\macros.inc"	Defines for Eden Editor like colors, text sizes custom pixel grid macros.
#include "\a3\3DEN\UI\macroexecs.inc"	Defines for Eden Editor to calculate text sizes etc.
#include "\a3\ui_f\hpp\definedikcodes.inc"	Useful when working with custom shortcuts. Contains defines for key codes.
#include "\a3\ui_f\hpp\definecommoncolors.inc"	Colors used in Arma 3, like background color set by the user.
#include "\a3\ui_f\hpp\definecommongrids.inc"	UI grids such as GUI_GRID and all its variants.
#include "\a3\ui_f\hpp\defineresincl.inc"	IDCs and IDDs of many Arma 3 UIs.

User Interface Event Handlers

User Interface Event Handlers are a key component of any Arma 3 GUI. See User Interface Event Handlers.

Scripting

There are several functions and commands to edit your dialog after its creation. These functions and commands can be found here:

• GUI Functions
• GUI Commands

Native Arma 3 GUIs

Arma 3 comes with a wide varity of various displays and dialogs. They can be found in:

• configFile usually with names like RscSomeDisplayName or DisplaySomeDisplayName

Additonally, Arma 3 offers some customizeable GUIs which can be accessed by scripts.

• BIS_fnc_3DENShowMessage
• BIS_fnc_guiMessage
• BIS_fnc_GUIhint
• hint, hintSilent, hintC

GUI References

It is sometimes a good idea so see how others created their GUIs. Here is a list of a few resources:

• Terra's Editing Extensions
• A3ExtendedFunctionViewer
• A3UserInputMenus
• A3ColorPicker
• 3den Enhanced

Tips for creating GUIs

• Functionality
• Layout
• Style
• Behaviour
• Customizability

Tutorials

• GUI Tutorial

See Also

• Arma 3: IDD List
• Arma 3: User Interface Editor
• Arma 3: GUI Coordinates
• GUI Functions
• GUI Commands
• User Interface Event Handlers
• Class Inheritance
• PreProcessor Commands