Arma: GUI Configuration: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(→‎Controls: Active Text Control)
m (Some wiki formatting)
 
(350 intermediate revisions by 37 users not shown)
Line 1: Line 1:
{{Stub}}
{{TOC|side}}
<div style="border: 1px dashed #990000; text-align: justify; background-color: #ffcccc; margin: 0 2em 1em 2em; padding: 1ex">This article is classified as ''work in progress'' and is likely to change very often before it will be moved or merged to [[Dialogs]] once it has reached a certain degree of maturity.
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|code]]. They are defined as classes in the [[Description.ext|missionConfigFile]] ([[Description.ext|description.ext]]), [[campaignConfigFile]] ([[Campaign Description.ext]]) or [[configFile]] ([[config.cpp]]).
<gallery mode="nolines" class="center" widths=150px>
A3_GUI_Example_1.jpg|Custom Briefing Editor
A3_GUI_Example_2.jpg|Teamswitch GUI
A3_GUI_Example_3.jpg|Dynamic Groups GUI
</gallery>


Feel free to make changes though, even if it currently resides in [[User:Manny|Manny's]] personal namespace.
-- [[User:Manny|Manny]] 15:49, 6 May 2007 (CEST)</div>


== Introduction ==
=== Terminology ===


Dialogs are one way to provide custom graphical user interface in your missions and allow interaction with the player aswell as they are able to run [[Code|code]]. They are defined as classes in the [[Description.ext|description.ext]] file.
; GUI
: Graphical User Interface - Allows user interaction with the software through graphical controls like buttons, lists and so on.


'''Notice:''' If you change your description.ext file while the mission is still open in the editor, you will have to restart the editor and load the mission again so the changes actually take effect.
; UI
: User Interface - Allows the user to interact with the software through a console application.


'''Warning:''' If there are syntactic errors in your description.ext file (e.g. incorrect spelling of keywords), then the game will simply crash while processing the file, stating the nature and location of the error that caused it.
; IGUI
: Integrated Graphical User Interface - A term usually encountered when talking about vanilla menus in {{arma3}}.


Most of these definitions work with numeric constants, which are presented in [[#Constants|the following section]]. For readability purposes you should consider favoring them instead of the actual integers.


* Positions and dimensions (x, y, w, h) aswell as font sizes are '''relative''' to the screen (and '''not''' pixel values), ranging from 0.0 to 1.0; 0.0 means 0% of the screen width (e.g. the left side of the screen in the context of x or y, or 0% length in the context of width and height). This makes font sizes usually a very small number (~0.02). Keep this in mind.
== User Interface Types ==
* Colors are usually defined in the following convention: <tt>{ Red, Green, Blue, Alpha }</tt>, each ranging from 0.0 to 1.0 aswell.
* Sounds are usually defined in the following convention: <tt>{ "file.ogg", volume, <span style="color: #ff0000; font-weight: bold">???</span> }</tt>, whereas volume ranges from 0.0 to 1.0.


<!-- I have no idea. Someone please correct the sound convention. -->
=== Dialog ===


You can find a complete list of scripting related GUI functions in [[:Category:Command Group: GUI Control]].
* Can be created upon an existing display. Parent display will be hidden.


== Constants ==
** Player movement is blocked by dialog
** '''Commands:''' [[createDialog]], [[closeDialog]], [[allControls]], [[dialog]]


These are constants generally used to maintain a certain degree of readability. They represent integer values for use with ''type'' and ''style'' properties of controls. You can also define other constants, e.g. the font name.
=== Display ===


<code><nowiki>// Control types
* Can be created upon an existing display. Parent display will be hidden.
#define CT_STATIC          0
* Player movement is not blocked by display, if it has not been blocked by its parent display already.
#define CT_BUTTON          1
** '''Commands:''' [[createDisplay]], [[closeDisplay]], [[allControls]], [[allDisplays]]
#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_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_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


{{Feature|informative|Generally speaking, dialogs and displays are identical. They are only differentiated by the way they are created ([[createDisplay]], [[createDialog]]).}}


// Static styles
=== HUD ===
#define ST_POS            0x0F
#define ST_HPOS          0x03
#define ST_VPOS          0x0C
#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_TYPE          0xF0
* 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.
#define ST_SINGLE        0
** '''Commands:''' [[allCutLayers]], [[titleRsc]], [[cutText]], [[cutObj]], [[cutFadeOut]], [[setTitleEffect]], [[allActiveTitleEffects]]
#define ST_MULTI          16
#define ST_TITLE_BAR      32
#define ST_PICTURE        48
#define ST_FRAME          64
#define ST_BACKGROUND    80
#define ST_GROUP_BOX      96
#define ST_GROUP_BOX2    112
#define ST_HUD_BACKGROUND 128
#define ST_TILE_PICTURE  144
#define ST_WITH_RECT      160
#define ST_LINE          176


#define FontM            "Zeppelin32"</nowiki></code>
{{Feature|informative|Some of the commands have different effects. Please check the command's biki page for detailed information.}}


'''Notice:''' All examples within this article use these constants. If you do not include them, or name them differently, these examples won't work as-is.


== Dialogs ==
== Display and Dialog ==


Dialogs are parent containers for the actual controls it contains. Their definition contains several properties on the controls it contains, how the dialog can be addressed, and whether or not the player is able to continue regular movement while the dialog is shown.
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.


They can be defined in the [[Description.ext|description.ext]] file or externalized to seperate hpp-files, which are included in the description.ext file using the [[PreProcessor_Commands#.23include|#include]] preprocessor directive. The latter method is generally a good idea to split a large description.ext file into several small chunks in order to keep track of what's where.
=== Properties ===


Most often, controls of a dialog are defined within the definition of the dialog itself, though it's a good practice to generalize common controls in a base definition in the global scope. See [[#Best Practice|best practice]] for details. For simplicity we won't apply this practice in the following code examples.
{| class="wikitable sortable" Style = "Width: 100%"
 
 
{| border="1" align="center" cellpadding="3" cellspacing="0" |
! colspan="3" bgcolor="#bbbbff" | Properties
|-
|-
! bgcolor="#ddddff" | Name
! Name !! Type!! Remark
! bgcolor="#ddddff" | Type
! bgcolor="#ddddff" | Remark
|-
|-
| '''idd'''
| '''idd'''
| integer
| Integer
| the unique ID number of this dialog. can be -1 if you don't require access to the dialog itself from within a script.
| 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'''
| '''movingEnable'''
| boolean
| [[Boolean]]
| sets whether or not the player is hindered from aiming or moving while the dialog is open.
| 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 {{arma3}}
|-
| '''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#onLoad|User Interface Event Handlers]]
|-
| '''onUnload'''
| [[String]]
| Expression executed when the dialog is closed. See [[User_Interface_Event_Handlers#onUnload|User Interface Event Handlers]]
|-
|-
| '''controlsBackground'''
| '''controlsBackground'''
| array
| [[Array]] or class
| contains class names of all background controls associated to this dialog.
| Contains class names of all background controls associated to this dialog.<br>
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'''
| '''controls'''
| array
| [[Array]] or class
| contains class names of all foreground controls associated to this dialog.
| Contains class names of all foreground controls associated to this dialog.
|-
|-
| '''objects'''
| '''objects'''
| array
| [[Array]] or class
|
| List of all [[DialogControls-Objects]] type controls
|}
 
=== Example Config ===
 
<spoiler text="Show Example Config">
<syntaxhighlight lang="cpp">
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
};
};
</syntaxhighlight>
</spoiler>
 
=== 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 {{Controls|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 [[User_Interface_Event_Handlers#onUnload|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 {{hl|\a3\ui_f\hpp\defineResincl.inc}}:
<syntaxhighlight lang="cpp">
// 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
</syntaxhighlight>
{| class="wikitable"
|-
! 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 ==


Setting the ''idd'' property to a non-negative (i.e. "useful") number is only required if you want to access the dialog itself via the [[findDisplay]] function. Accessing the dialog itself via the ''idd'' property though does not mean that you can implicitely access the controls within the dialog. For that you will have to rely on the control's ''idc'' properties. Hence, in most basic cases you won't need it and -1 should be sufficient.
HUDs are defined in the class RscTitles, unlike displays or dialogs which are root classes in the config file. Additionally, their properties are different.


Here's an example of a dialog that will only display ''Hello world'' in the top right corner of the screen. If you get confused by the ''MyHelloText'' class, just ignore it for the moment until you have read details on the definition of controls  in the following chapter, [[#Controls|Controls]].
=== Properties ===
 
{| class="wikitable sortable" Style="Width: 100%"
|-
! 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#onLoad|User Interface Event Handlers]]
|-
| '''onUnload'''
| [[String]]
| Expression executed when the dialog is closed. See [[User_Interface_Event_Handlers#onUnload|User Interface Event Handlers]]
|-
| '''controls'''
| [[Array]]
| Contains class names of all foreground controls associated to this dialog.
|}


* '''Example:'''
=== Example Config ===
<code><nowiki>class MyHelloWorldDialog {
idd = -1;  // set to -1, because we don't require a unique ID
movingEnable = false;  // no movement while the dialog is shown
controlsBackground[] = { };  // no background controls needed
objects[] = { };  // no objects needed
controls[] = { MyHelloText };  // our Hello World text as seen below:
class MyHelloText {
idc = -1;  // set to -1, unneeded
type = CT_STATIC;  // constant
style = ST_LEFT;  // constant
text = "Hello world";
font = FontM;
sizeEx = 0.023;


colorBackground[] = { 1, 1, 1, 0.3 };
<spoiler text="Show Example Config">
colorText[] = { 0, 0, 0, 1 };
<syntaxhighlight lang="cpp">
#include "\a3\ui_f\hpp\definecommongrids.inc"


x = 0.8;
class RscTitles
y = 0.1;
{
w = 0.2;
class RscInfoText
h = 0.05;
{
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};
};
};
};
};
};</nowiki></code>
};
</syntaxhighlight>
</spoiler>


Once you have defined (or prototyped) dialogs you want to use, be sure to reload the mission in the editor if it is already running.


Dialogs can then be created and shown using the [[createDialog]] function. If you do so by script and await a responsive action from the user, you might also want to wait until the user has closed the dialog by using the [[dialog]] function, if you intend to handle the dialog result in the same script.
== Controls ==


* '''Example:'''
Controls are used to allow the player to interact with the GUI. Controls range from simple rectangles to 3D objects.
<code><nowiki>_ok = createDialog "MyHelloWorldDialog";
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.
waitUntil { !dialog };
hint "Dialog closed.";</nowiki></code>
 
== Controls ==


Controls are the actual content of dialogs and can be anything, ranging from simple solid rectangles to a complex 3d object within a dialog. Like dialogs, controls can have a unique ID saved in the ''idc'' property to access them from within scripts using [[:Category:Command_Group:_GUI_Control|GUI functions]].
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.


The type of the control is usually set in the ''type'' property. Different types allow or require a different set of properties. However most controls share a set of properties in addition to the properties described in the following sections:
=== Common Properties ===


{| border="1" align="center" cellpadding="3" cellspacing="0" |
{| class="wikitable" width="100%"
! colspan="3" bgcolor="#bbbbff" | Common properties
|-
|-
! bgcolor="#ddddff" | Name
! Name
! bgcolor="#ddddff" | Type
! Type
! bgcolor="#ddddff" | Remark
! Remark
|-
|-
| '''idc'''
| '''idc'''
| integer
| 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.
| The unique ID number of this control. Can be -1 if you don't require access to the control itself from within a script.<br>
Special (button) IDCs (according to \a3\ui_f\hpp\defineResincl.inc):
* 1: OK (closes display when clicked upon, raises exit code 1 in the [[User_Interface_Event_Handlers#onUnload|onUnload UIEH]])
* 2: Cancel (closes display when clicked upon, raises exit code 2 in the [[User_Interface_Event_Handlers#onUnload|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 {{arma3}} works regardless). Another way of allowing moving of the dialog is to have control of style ST_TITLE_BAR
|-
|-
| '''type'''
| '''type'''
| integer (constant)
| Integer
| control type [[#Constants|constant]].
| See [[#Control Types|Control Types]]
|-
|-
| '''style'''
| '''style'''
| integer (constant)
| Integer
| style [[#Constants|constant]].
| See [[#Control Styles|Control Styles]]. <syntaxhighlight lang="cpp" inline>style = "0x400+0x02+0x10";</syntaxhighlight>
|-
| '''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 [[Fonts#Available_Fonts|available fonts]] for possible values.
|-
| '''colorText'''
| [[Array]]
| Text color
|-
| '''colorBackground'''
| [[Array]]
| Background color
|-
| '''text'''
| [[String]]
| The text '''or picture''' to display.
|-
|-
| '''x'''
| '''shadow'''
| float
| Integer
| the offset from the left side of the window (0..1; 0.0 = left side; 1.0 = right side)
| Can be applied to most controls (0 = no shadow, 1 = drop shadow with soft edges, 2 = stroke).
|-
|-
| '''y'''
| '''tooltip'''
| float
| [[String]]
| the offset from the top side of the window (0..1; 0.0 = left side; 1.0 = right side)
| 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 {{GVI| arma3|1.48}}, most controls now support tooltips. A linebreak can be created by adding '''\n'''.
|-
|-
| '''w'''
| '''tooltipColorShade'''
| float
| [[Array]]
| the width of the control (0..1)
| Tooltip background color
|-
|-
| '''h'''
| '''tooltipColorText'''
| float
| [[Array]]
| the height of the control (0..1)
| Tooltip text color
|-
|-
| '''sizeEx'''
| '''tooltipColorBox'''
| float
| [[Array]]
| the font size of text (0..1)
| 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".
|-
|-
| '''font'''
| '''url'''
| string
| [[String]]
| the [[Fonts|font]] to use
| (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]]
| {{GVI|arma3|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.
|}
|}


To save space and effort, it is generally a good idea to make use of class polymorphism, i.e. deriving from very basic classes that already have some specific properties set. See the [[#Best_Practice|Best Practice]] chapter for details.
A property to enable or disable a control does not exist (because of implementation issues). However, there is a simple workaround based on the [[User_Interface_Event_Handlers#onLoad|onLoad]] UI Event Handler that can be used to disable a control in the config:
<syntaxhighlight lang="cpp">onLoad = "(_this # 0) ctrlEnable false;";</syntaxhighlight>


=== Static ===
=== Attributes Class ===


Static controls represent exactly that: static data. Primarily they are used for texts, dialog backgrounds and pictures. The constant ''type'' property for these controls usually is <tt>CT_STATIC</tt>.
{| class="wikitable" width="70%"
 
{| border="1" align="center" cellpadding="3" cellspacing="0" |
! colspan="3" bgcolor="#bbbbff" | Properties
|-
|-
! bgcolor="#ddddff" | Name
! Name
! bgcolor="#ddddff" | Type
! Type
! bgcolor="#ddddff" | Remark
! Remark
|-
|-
| '''colorText'''
| '''font'''
| color array
| [[String]]
| text color
| [[FXY_File_Format#Available_Fonts|Available Fonts]]
|-
|-
| '''colorBackground'''
| '''color'''
| color array
| HTML color
| background color
| {{Link|https://html-color-codes.info/|HTML Color Codes}}
|-
| '''text'''
| string
| the text to display initially
|-
|-
| '''lineSpacing'''
| '''align'''
| float
| [[String]]
| line spacing. Required, if the style was set to <tt>ST_MULTI</tt>.
| "center", "left", "right"
|-
|-
| '''shadow'''
| Integer
| 0 = no shadow, 1 = drop shadow with soft edges, 2 = stroke
|}
|}


==== Text ====
=== AttributesImage Class ===
[[Image:Dialog controls text.jpg|thumb||''Hello world'' text with semi-transparent background]]
Most often this type of control will be used to add text to dialogs. If you want the text to change dynamically while playing the mission, you should set the ''idc'' property to a positive number, which allows usage of the [[ctrlSetText]] function. Text alignment can be controlled using the ''style'' property and the <tt>ST_*</tt> constants.


By default, this will only display a '''single line''' (and cut the overflow); use <tt>ST_MULTI</tt> if you intend to use multiple lines. This also requires setting the property ''lineSpacing'', which indicates the relative space between lines; usually, you can set this to 1 for normal line spacing.
{| class="wikitable" width="70%"
|-
! Name
! Type
! Remark
|-
| '''font'''
| [[String]]
| [[FXY_File_Format#Available_Fonts|Available Fonts]] (Optional)
|-
| '''color'''
| HTML color
| {{Link|https://html-color-codes.info/|HTML Color Codes}}
|-
| '''align'''
| [[String]]
| "center", "left", "Right" (optional)
|-
|}<br clear="all">


* '''Example:'''
=== Example Config ===
<code><nowiki>class MyHelloPlayerExample {
idc = -1;
type = CT_STATIC;  // defined constant
style = ST_CENTER;  // defined constant
colorText[] = { 0, 0, 0, 1 };
colorBackground[] = { 1, 1, 1, 0.75 };
font = FontM;  // defined constant
sizeEx = 0.023;
x = 0.3; y = 0.1;
w = 0.4;  h = 0.03;
text = "Hello player!";
};</nowiki></code>


==== Solid rectangles ====
<spoiler text="Show Example Config">
[[Image:Dialog controls background.jpg|thumb||Semi-transparent background]]
<syntaxhighlight lang="cpp">
One can too use this control type to add solid background to dialogs by simply leaving the ''text'' property empty. This way, it will look like a regular rectangle.
#include "\a3\ui_f\hpp\definecommongrids.inc"


* '''Example:'''
class RscButton
<code><nowiki>class MyRedBackgroundExample {
{
/* ... same as the text example, except for */
deletable = 0;
colorBackground[] = { 1, 0.1, 0.1, 0.8 };
fade = 0;
access = 0;
type = 1;
text = "";
text = "";
};</nowiki></code>
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;
};
</syntaxhighlight>
</spoiler>


==== Pictures ====
Using specific style constants you can enhance your dialogs with pictures too. These pictures should reside in your mission folder as [[paa]]-files. Then set your ''style'' property to <tt>ST_PICTURE</tt> (to display it once) or <tt>ST_TILE_PICTURE</tt> (to tile it) and use the ''text'' property to locate the paa image you want to use, relative to your mission folder.


* '''Example:'''
== Control Types ==
<code><nowiki>class MyPictureExample {
/* ... same as the text example, except for */
style = ST_PICTURE;
text = "mypicture.paa";
};</nowiki></code>


=== Button ===
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:
Buttons are one way to add interactivity to your dialogs. Their corresponding ''type'' property is <tt>CT_BUTTON</tt>.
<sqf>createDialog "RscTestControlTypes";</sqf>
 
{{Navbox/CT}}
Buttons can have different states (see screenshot) and will render slightly different to give the user a visual feedback on the button's state:
<!---
* '''Enabled''': the button has not been [[ctrlEnable|disabled]], it currently doesn't have any mouse or keyboard related focus
{| class="wikitable sortable" Style ="Width: 100%"
* '''Disabled''': the button has been explicitely disabled. It will not be clickable.
! Define !! Decimal !! Hexadecimal !! Remark
* '''Enabled''' + '''Focused''': As enabled; additionally it will have a small border of the color defined in the ''colorFocused'' property. This occurs when the button currently has focus (ie. is the default button or has been selected via the ''Tab'' key).
|-
* '''Enabled''' + '''Active''': As enabled; additionally it will have a different background as specified in the ''colorBackgroundActive'' background. This occurs when the mouse is currently hovering over an unfocused button.
| [[CT_STATIC]] || 0 || 0x00 ||
* '''Enabled''' + '''Active''' + '''Focused''': The combined result of the above two states. The mouse is currently hovering over the button in question and it has input focus.
|-
 
| [[CT_BUTTON]] || 1 || 0x01 ||
Button can also have code attached to it in the ''action'' property. This code will be run when the button is clicked. Most often, you will have at least one button that closes the dialog via [[closeDialog]]. In this case you can provide ''0'' as the right-side parameter to close the currently open dialog.
|-
 
| [[CT_EDIT]] || 2 || 0x02 ||
{| border="1" align="center" cellpadding="3" cellspacing="0" |
|-
! colspan="3" bgcolor="#bbbbff" | Properties
| [[CT_SLIDER]] || 3 || 0x03 ||
|-
| [[CT_COMBO]] || 4 || 0x04 ||
|-
| [[CT_LISTBOX]] || 5 || 0x05 ||
|-
| [[CT_TOOLBOX]] || 6 || 0x06 ||
|-
| [[CT_CHECKBOXES]] || 7 || 0x07 ||
|-
| [[CT_PROGRESS]] || 8 || 0x08 ||
|-
| [[CT_HTML]] || 9 || 0x09 ||
|-
| [[CT_STATIC_SKEW]] || 10 || 0x0A ||
|-
| [[CT_ACTIVETEXT]] || 11|| 0x0B||
|-
| [[CT_TREE]] || 12 || 0x0C ||
|-
| [[CT_STRUCTURED_TEXT]] || 13 || 0x0D ||
|-
| [[CT_CONTEXT_MENU]] || 14 || 0x0E ||
|-
| [[CT_CONTROLS_GROUP]] || 15 || 0x0F ||
|-
| [[CT_SHORTCUTBUTTON]] || 16 || 0x10 ||
|-
| [[CT_HITZONES]] || 17 || 0x11 ||
|-
| [[CT_VEHICLETOGGLES]] || 18 || 0x12 ||
|-
| [[CT_CONTROLS_TABLE]] || 19 || 0x13 ||
|-
|-
! bgcolor="#ddddff" | Name
| [[CT_XKEYDESC]] || 40 || 0x28 ||
! bgcolor="#ddddff" | Type
! bgcolor="#ddddff" | Remark
|-
|-
| '''action'''
| [[CT_XBUTTON]] || 41 || 0x29 ||
| string
| a statement that is executed when the button is not disabled and clicked
|-
|-
| '''text'''
| [[CT_XLISTBOX]] || 42 || 0x2A ||
| string
| the text to display initially
|-
|-
| '''default'''
| [[CT_XSLIDER]] || 43 || 0x2B ||
| boolean
| Whether or not this button is the dialog's initially selected button
|-
|-
| '''colorText'''
| [[CT_XCOMBO]] || 44 || 0x2C ||
| color array
| text color
|-
|-
| '''colorDisabled'''
| [[CT_ANIMATED_TEXTURE]] || 45 || 0x2D ||
| color array
| text color, if the control has been disabled via [[ctrlEnable]]
|-
|-
| '''colorFocused'''
| [[CT_MENU]] || 46 || 0x2E || {{arma3}} (EDEN)
| color array
|
|-
|-
| '''colorShadow'''
| [[CT_MENU_STRIP]] || 47 || 0x2F || {{arma3}} (EDEN)
| color array
| the color of the shadow
|-
|-
| '''colorBorder'''
| [[CT_CHECKBOX]] || 77 || 0x4D || {{arma3}}
| color array
| the color of the border, if any
|-
|-
| '''borderSize'''
| [[CT_OBJECT]] || 80 || 0x50 ||
| float
| the width of the border
|-
|-
| '''colorBackgroundActive'''
| [[CT_OBJECT_ZOOM]] || 81 || 0x51 ||
| color array
|  
|-
|-
| '''colorBackgroundDisabled'''
| [[CT_OBJECT_CONTAINER]] || 82 || 0x52 ||
| color array
| background color, if the control has disabled via [[ctrlEnable]]
|-
|-
| '''offsetX'''
| [[CT_OBJECT_CONT_ANIM]] || 83 || 0x53 ||
| float
| the relative X offset between the button and its shadow
|-
|-
| '''offsetY'''
| [[CT_LINEBREAK]] || 98 || 0x62 ||
| float
| the relative Y offset between the button and its shadow
|-
|-
| '''offsetPressedX'''
| [[CT_USER]] || 99 || 0x63 ||
| float
| the relative X offset between the button and its shadow, when it's pressed
|-
|-
| '''offsetPressedY'''
| [[CT_MAP]] || 100 || 0x64 ||
| float
| the relative Y offset between the button and its shadow, when it's pressed
|-
|-
| '''soundEnter'''
| [[CT_MAP_MAIN]] || 101 || 0x65 ||
| sound array
| the sound to play, when the cursor enters the button's bounds
|-
|-
| '''soundPush'''
| [[CT_LISTNBOX]] || 102 || 0x66 ||
| sound array
| the sound to play, when the button has been pushed
|-
|-
| '''soundClick'''
| [[CT_ITEMSLOT]] || 103 || 0x67 ||
| sound array
| the sound to play, when the button is being released
|-
|-
| '''soundEscape'''
| [[CT_LISTNBOX_CHECKABLE]] || 104 || 0x68 ||
| sound array
|
|-
|-
| [[CT_VEHICLE_DIRECTION]] || 105 || 0x69 ||
|}
|}
--->


=== Control Type Definitions ===
All definitions can be retrieved with <sqf inline>"Default" call BIS_fnc_exportGUIBaseClasses;</sqf>.<br>
<spoiler text="Show Control Type Definitions">
<syntaxhighlight lang="cpp">
#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
</syntaxhighlight>
</spoiler>


The following example uses almost the same code as the buttons shown in the example screenshot.
== Control Styles ==
[[Image:Dialog controls button.jpg|thumb|110px|The same button four times in different states]]


* '''Example:'''
To further customize controls there are several different styles for each control type available.<br>
<code><nowiki>class MyButton {
idc = -1;
type = CT_BUTTON;
style = ST_LEFT;
default = false;
font = FontM;
sizeEx = 0.03;
colorText[] = { 0, 0, 0, 1 };
colorFocused[] = { 1, 0, 0, 1 };  // border color for focused state
colorDisabled[] = { 0, 0, 1, 0.7 };  // text color for disabled state
colorBackground[] = { 1, 1, 1, 0.8 };
colorBackgroundDisabled[] = { 1, 1, 1, 0.5 };  // background color for disabled state
colorBackgroundActive[] = { 1, 1, 1, 1 };  // background color for active state
offsetX = 0.003;
offsetY = 0.003;
offsetPressedX = 0.002;
offsetPressedY = 0.002;
colorShadow[] = { 0, 0, 0, 0.5 };
colorBorder[] = { 0, 0, 0, 1 };
borderSize = 0;
soundEnter[] = { "", 0, 1 };  // no sound
soundPush[] = { "buttonpushed.ogg", 0.1, 1 };
soundClick[] = { "", 0, 1 };  // no sound
soundEscape[] = { "", 0, 1 };  // no sound
x = 0.4; y = 0.475;
w = 0.2; h = 0.05;
text = "Close";
action = "closeDialog 0; hint ""Dialog closed. You are good to go now!""";
};</nowiki></code>


=== Active text ===
To get an idea of how the styles look like you can create the following dialog:
<sqf>createDialog "RscTestControlStyles";</sqf>


The Active Text control behaves very similar to buttons. It shows up as regular text with the additional functionality that you can click and select it. The dialog's currently selected Active Text control will be underlined to indicate it's status. By default, the first Active Text control is selected. When the mouse cursor hovers over an instance of this control, it will show up in the color defined in the ''colorActive'' property.
{{Feature | important | Note that drawing of vertical text is not supported and any attempt to use {{hl|ST_UP}}, {{hl|ST_DOWN}}, {{hl|ST_VCENTER}} is likely to result in the following ''.rpt'' spam:<br>{{hl|Obsolete, sizeH and sizeW calculation missing}}<br>In addition, {{hl|ST_UP}}, {{hl|ST_DOWN}}, {{hl|ST_VCENTER}} are stand alone styles and should not be mixed with any other styles}}


'''Notice:''' This control doesn't render the usually common ''colorBackground'' property and ''colorText'' is replaced with ''color''.
{| class="wikitable" Style="Width: 100%"
 
! Define !! Decimal !! Hexadecimal !! Remark
{| border="1" align="center" cellpadding="3" cellspacing="0" |
|-
! colspan="3" bgcolor="#bbbbff" | Properties
| 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
|-
|-
! bgcolor="#ddddff" | Name
| ST_GROUP_BOX2 || 112 || 0x70 || Plain single line box, same as ST_SINGLE, only with a slight border similar to ST_MULTI box border
! bgcolor="#ddddff" | Type
! bgcolor="#ddddff" | Remark
|-
|-
| '''action'''
| ST_HUD_BACKGROUND || 128 || 0x80 || Sets special texture for corners. It was used for rounded corners in {{Name|ofp|short}}, {{Name|arma1|short}} and {{arma2}}. In {{arma3}}, square corners are used everywhere, so the texture is adapted to the unified style, but the technology is not removed. In {{arma3}} it looks the same as normal ST_SINGLE. Corner textures are defined in <sqf inline>configFile >> "CfgInGameUI" >> "imageCornerElement"</sqf> (can be set only globally for the whole game, not per control)
| string
| a statement that is executed when the control has been clicked
|-
|-
| '''text'''
| 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.
| string
| the text to display initially
|-
|-
| '''default'''
| 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''
| boolean
| Whether or not this control is the dialog's initially selected active text
|-
|-
| '''color'''
| 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''
| color array
| '''replaces ''colorText''''', standard text and underline color
|-
|-
| '''colorActive'''
| ST_UPPERCASE || 192 || 0xC0 || Forces control text to upper case
| color array
| text and underline color whenever the mouse hovers over the control
|-
|-
| <strike>'''colorBackground'''</strike>
| ST_LOWERCASE || 208 || 0xD0 || Forces control text to lower case
| <strike>color array</strike>
| '''not applicable'''
|-
|-
| '''soundEnter'''
| ST_ADDITIONAL_INFO || 3840 || 0x0F00 || ST_SHADOW + ST_NO_RECT + SL_HORZ + ST_KEEP_ASPECT_RATIO
| sound array
| the sound to play, when the cursor enters the button's bounds
|-
|-
| '''soundPush'''
| ST_SHADOW || 256 || 0x0100 ||
| sound array
| the sound to play, when the button has been pushed
|-
|-
| '''soundClick'''
| ST_NO_RECT || 512 || 0x0200 || This style works for [[CT_STATIC]] in conjunction with ST_MULTI
| sound array
| the sound to play, when the button is being released
|-
|-
| '''soundEscape'''
| ST_KEEP_ASPECT_RATIO || 2048 || 0x0800 || When used with image or texture, stops it from stretching to fit the control
| sound array
|
|-
|-
| ST_TITLE || 34 || 0x22 || ST_TITLE_BAR + ST_CENTER
|}
|}


The following example uses almost the same code as the controls shown in the example screenshot.
=== Control Specific Styles ===
[[Image:Dialog controls activetext.jpg|thumb|110px|Simple dialog with three Active Text controls]]
==== [[CT_LISTBOX]] Specific Styles ====
* '''Example:'''
{| class="wikitable" width="70%"
<code><nowiki>class MyActiveText {
! Define !! Decimal !! Hexadecimal !! Remark
idc = -1;
|-
type = CT_ACTIVETEXT;
| LB_TEXTURES || 16 || 0x10 ||
style = ST_LEFT;
|-
x = 0.75; y = 0.5;
| LB_MULTI || 32 || 0x20 || Makes [[CT_LISTBOX]] multi-selectable
w = 0.2; h = 0.035;
|}
font = FontM;
sizeEx = 0.024;
color[] = { 1, 1, 1, 1 };
colorActive[] = { 1, 0.2, 0.2, 1 };
soundEnter[] = { "", 0, 1 };
soundPush[] = { "", 0, 1 };
soundClick[] = { "", 0, 1 };
soundEscape[] = { "", 0, 1 };  // no sound
action = "hint ""Good choice!""";
text = "Text";
default = true;
};</nowiki></code>


=== Structured text ===
==== [[CT_PROGRESS]] Specific Styles ====
=== Text box ===
{| class="wikitable" width="70%"
=== Slider ===
! Define !! Decimal !! Hexadecimal
=== Combobox ===
|-
=== Listbox ===
| ST_VERTICAL || 1 || 0x01
=== Toolbox ===
|-
=== Checkbox ===
| ST_HORIZONTAL || 0 || 0x00
=== Progress bar ===
|}
=== Context menu ===
=== HTML ===
=== Tree ===
=== Static skew ===
=== Controls group ===
=== Animated texture ===
=== 3D Objects ===
=== Map ===


== Best practice ==
==== [[CT_SLIDER]] Specific Styles ====
{| class="wikitable" width="70%"
|-
! Define !! Decimal !! Hexadecimal
|-
| SL_VERT || 0 || 0x00
|-
| SL_HORZ || 1024 || 0x0400
|-
| SL_TEXTURES || 16 || 0x10
|}


=== Inheritance ===
==== [[CT_TREE]] Specific Styles ====
<!-- added by Dr_Eyeball. Example not tested. 11 May 2007. Modify it as you see fit, but don't forget this important topic. -->
{| class="wikitable" width="70%"
<!-- Nasty person and Java developer that I am, I dared to move all opening braces at the end of the previous line to make it look more compact. Furthermore I removed some placeholders, because they didn't seem to be needed that much. I hope you don't mind. Also, I love to meddle... :) ~~~~ -->
! Define !! Decimal !! Hexadecimal !! Remark
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 redeclare all attributes for each class definition.
|-
| 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
|}


* '''Example:'''
=== Control Style Definitions ===
<code><nowiki>class RscText {
All definitions can be retrieved with <sqf inline>"Default" call BIS_fnc_exportGUIBaseClasses;</sqf>.<br>
  type = CT_STATIC;
<spoiler text="Show Control Style Definitions">
  idc = -1;
<syntaxhighlight lang="cpp">
  style = ST_LEFT;
#define ST_LEFT 0x00
  colorBackground[] = {0, 0, 0, 1};
#define ST_RIGHT 0x01
  colorText[] = {1, 1, 1, 1};
#define ST_CENTER 0x02
  font = FontM;
#define ST_DOWN 0x04
  sizeEx = 0.04;
#define ST_UP 0x08
  h = 0.04;
#define ST_VCENTER 0x0C
  text = "";
#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
</syntaxhighlight>
</spoiler>
 
== Positioning ==


class My_BlueText : RscText {
A detailed description of how you can achieve proper GUI placement can be found on the [[Arma 3: GUI Coordinates]] page.
  colorText[] = {0, 0, 1, 1};
  x = 0.1;
  w = 0.4;
};


class My_Dialog {
== Inheritance ==
  //...


  controls[] = {
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.
    My_Text_1,
    My_Text_2
  };


  class My_Text_1 : My_BlueText {
{{Feature|informative|Using inheritance can make your GUI config hard to read for others.}}
    text = "Line 1";
    y = 0.2; 
  };


  class My_Text_2 : My_BlueText {
View the [[Class Inheritance|dedicated inheritance page]] for more information.
    text = "Line 2";
    y = 0.25; 
  };
};</nowiki></code>


=== Preprocessor instructions ===
== 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 isn't applicable). Also it can make your code look more readable sometimes.
Note that you can also add your own [[PreProcessor_Commands|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:'''
=== Example Config ===
<code><nowiki>#define COLOR_LIGHTBROWN { 0.776, 0.749, 0.658, 1 }
<spoiler text="Show Example Config">
<syntaxhighlight lang="cpp">
#define COLOR_HALF_BLACK { 0, 0, 0, 0.5 }
#define COLOR_HALF_BLACK { 0, 0, 0, 0.5 }
#define COLOR_TRANSPARENT { 0, 0, 0, 0 }


// ...
class MyDialog
 
{
class MyDialog {
idd = -1;
idd = -1;
movingEnable = 1;
movingEnable = 1;
objects[] = {};
objects[] = {};
controlsBackground[] = { MyDialogBackground };
controlsBackground[] = { MyDialogBackground };
controls[] = { MyDialogText };


class MyDialogBackground : RscText {
class MyDialogBackground : RscText
{
colorBackground[] = COLOR_HALF_BLACK;
colorBackground[] = COLOR_HALF_BLACK;
x = 0.7;  y = 0.1;
x = 0.7;  y = 0.1;
w = 0.25; h = 0.15;
w = 0.25; h = 0.15;
};
};
};
</syntaxhighlight>
</spoiler>
=== Useful includes ===


class MyDialogText : RscText {
{{arma3}} offers a wide range of useful files which can be included to get access to some  helpful macros.
style = ST_MULTI;
{| class="wikitable"
colorBackground[] = COLOR_TRANSPARENT;
|-
colorText[] = COLOR_LIGHTBROWN;
! Include Code !! Description / Content
text = "No power in the 'Verse can stop me.";
|-
lineSpacing = 1;
| <syntaxhighlight lang="cpp">#include "\a3\3DEN\UI\macros.inc"</syntaxhighlight> || Defines for [[:Category:Eden Editor|Eden Editor]] like colors, text sizes custom pixel grid macros.
x = 0.71; y = 0.11;
|-
w = 0.23; h = 0.13;
| <syntaxhighlight lang="cpp">#include "\a3\3DEN\UI\macroexecs.inc"</syntaxhighlight> || Defines for [[:Category:Eden Editor|Eden Editor]] to calculate text sizes etc.
};
|-
};</nowiki></code>
| <syntaxhighlight lang="cpp">#include "\a3\ui_f\hpp\definedikcodes.inc"</syntaxhighlight> || Useful when working with custom shortcuts. Contains defines for key codes.
|-
| <syntaxhighlight lang="cpp">#include "\a3\ui_f\hpp\definecommoncolors.inc"</syntaxhighlight> || Colors used in {{arma3}}, like background color set by the user.
|-
| <syntaxhighlight lang="cpp">#include "\a3\ui_f\hpp\definecommongrids.inc"</syntaxhighlight> || UI grids such as GUI_GRID and all its variants.
|-
| <syntaxhighlight lang="cpp">#include "\a3\ui_f\hpp\defineresincl.inc"</syntaxhighlight> || IDCs and IDDs of many {{arma3}} UIs.
|}
 
== User Interface Event Handlers ==
 
User Interface Event Handlers are a key component of any {{arma3}} 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:
* [[:Category:Function_Group:_GUI|GUI Functions]]
* [[:Category:Command Group: GUI Control|GUI Commands]]
 
 
== Native {{arma3}} GUIs ==
 
{{arma3}} comes with a wide varity of various displays and dialogs. They can be found in:
* [[configFile]] usually with names like '''Rsc'''SomeDisplayName or '''Display'''SomeDisplayName
 
Additonally, {{arma3}} 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:
* {{Link|https://github.com/7erra/-Terra-s-Editing-Extensions/tree/master/TER_editing/gui|Terra's Editing Extensions}}
* {{Link|https://github.com/ConnorAU/A3ExtendedFunctionViewer|A3ExtendedFunctionViewer}}
* {{Link|https://github.com/ConnorAU/A3UserInputMenus|A3UserInputMenus}}
* {{Link|https://github.com/ConnorAU/A3ColorPicker|A3ColorPicker}}
* {{Link|https://github.com/R3voA3/3den-Enhanced/tree/master/3denEnhanced/GUI|3den Enhanced}}
 
== Tips for creating GUIs ==
<!-- What is this? -->
* Functionality
* Layout
* Style
* Behaviour
* Customizability
 
{{Wiki|stub}}
 
 
== Tutorials ==
 
* [[GUI Tutorial]]
{{Wiki|stub}}
 
 
== See Also ==
 
* [[Arma 3: IDD List]]
* [[Arma 3: User Interface Editor]]
* [[Arma 3: GUI Coordinates]]
* [[:Category:Function Group:_GUI|GUI Functions]]
* [[:Category:Command Group: GUI Control|GUI Commands]]
* [[User Interface Event Handlers]]
* [[Class Inheritance]]
* [[PreProcessor Commands]]
 
 
[[Category:GUI Topics|GUI Configuration]]

Latest revision as of 10:31, 19 April 2024

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

    Custom Briefing Editor

  • Teamswitch GUI

    Teamswitch GUI

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

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.
ⓘ
Generally speaking, dialogs and displays are identical. They are only differentiated by the way they are created (createDisplay, createDialog).

HUD

ⓘ
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

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:

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

#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 Arma 3 logo black.png1.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 Arma 3 logo black.png2.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

#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 Types / MACRO (TYPE VALUE)
Text/Image/Video

CT_STATIC (0) | CT_EDIT (2) | CT_HTML (9) | CT_STRUCTURED_TEXT (13)

Buttons

CT_BUTTON (1) | CT_ACTIVETEXT (11) | CT_SHORTCUTBUTTON (16) | CT_CHECKBOX (77) | CT_XBUTTON (41)

Lists

CT_COMBO (4) | CT_TOOLBOX (6) | CT_CHECKBOXES (7) | CT_TREE (12) | CT_CONTROLS_TABLE (19) | CT_XCOMBO (44) | CT_LISTBOX (5) | CT_LISTNBOX (102) | CT_LISTNBOX_CHECKABLE (104) | CT_XLISTBOX (45)

3D Objects

CT_OBJECT (80) | CT_OBJECT_ZOOM (81) | CT_OBJECT_CONTAINER (82) | CT_OBJECT_CONT_ANIM (83)

Maps

CT_MAP (100) | CT_MAP_MAIN (101)

Meta

CT_SLIDER (3) | CT_XSLIDER (43) | CT_PROGRESS (8) | CT_CONTROLS_GROUP (15) | CT_WEBBROWSER (106) | CT_EXTENSION (107)

Menu

CT_CONTEXT_MENU (14) | CT_MENU (46) | CT_MENU_STRIP (47)

Unknown

CT_STATIC_SKEW (10) | CT_HITZONES (17) | CT_VEHICLETOGGLES (18) | CT_XKEYDESC (40) | CT_ANIMATED_TEXTURE (45) | CT_LINEBREAK (98) | CT_USER (99) | CT_ITEMSLOT (103) | CT_VEHICLE_DIRECTION (105)


Control Type Definitions

All definitions can be retrieved with "Default" call BIS_fnc_exportGUIBaseClasses;.

#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;.

#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

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


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.


GUI References

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

Tips for creating GUIs

  • Functionality
  • Layout
  • Style
  • Behaviour
  • Customizability
This article is a Stub. You can help BI Community Wiki by expanding it.


Tutorials

This article is a Stub. You can help BI Community Wiki by expanding it.


See Also

Retrieved from "https://community.bistudio.com/wiki?title=Arma:_GUI_Configuration&oldid=363772"