7erra/Sandbox – User

From Bohemia Interactive Community
Jump to navigation Jump to search
m (English, typo)
(bis_fnc_arsenal variables)
 
(36 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{SideTOC}}
=== Variables ===
{{wip}}
This is a list of all the variables that are used by the Virtual Arsenal.
== Example ==
{| class="wikitable"
{{GVI|arma3|1.66}}
|-
You can check some of the grid systems on an interactive test menu in game:
! colspan=3 | [[missionNamespace]]
# Open [[Eden Editor]]
|-
# Open debug console (Tools > Debug Console)
! Variable !! Data Type !! Explanation
# Execute this code: <syntaxhighlight lang="cpp">finddisplay 313 createdisplay "RscTestGrids";</syntaxhighlight>
|-
| BIS_fnc_arsenal_data || [[Array]] of arrays of [[String|strings]] || All available items that can be accessed in the Arsenal (not the actual content!). Format:<br>


A menu where you can see how all grid systems react to specific resolution, aspect ratio and interface size.
[[File:a3_GUI_grids.png|320px]]
* Hovering over each grid will show detailed description in tooltip.
* Data for each grid show the current size and max number of grids horizontally and vertically. Useful to making sure your menu proportions will work in all combinations.
* Click COPY TO CLIPBOARD button to copy a code with example that can be used directly in [[Config.cpp]] or [[Description.ext]].
== Grids ==
=== Absolute ===
The absolute grid refers to a 4:3 screen with UI size "Very Large". It is the oldest of the three grids (absolute, safeZone and pixelGrid). Because of this it is never advisable to use it. Config example:
<syntaxhighlight lang="cpp">class TextAbsolute: RscText
{
text = "Absolute grid";
x = 0;
y = 0.5;
w = 0.15;
h = 0.028;
};
</syntaxhighlight>
=== [[SafeZone]] ===
<!--- TODO?: new safezone picture with safeZoneWAbs and safeZoneHAbs --->
[[File:safezone.jpg|thumb|safeZone values and their position on screen. The 0 and 1 are the absolute values.|500px]]
To keep the dialog on screen the safeZone values were introduced. Here is a quick overview over the six commands:
{| class="wikitable"
{| class="wikitable"
|-
|-
! Command !! Explanation
! Index !! Content
|-
|-
| [[safeZoneX]] || The left edge of the screen on SINGLE monitor settings.
| 0 || Primary Weapons
|-
|-
| [[safeZoneXAbs]] || The left edge of the screen on MULTIPLE monitors (Triple Head, three screens).
| 1 || Secondary Weapons
|-
|-
| [[safeZoneY]] || The top edge of the screen.
| 2 || Handguns
|-
|-
| [[safeZoneW]] || The width of of the screen in a SINGLE monitor setup (or the center one in case of triple head).
| 3 || Uniforms
|-
|-
| [[safeZoneWAbs]] || The width of a triple head setup. In case of a single monitor this is equal to safeZoneW.
| 4 || Vests
|-
|-
| [[safeZoneH]] || The height of the screen
| 5 || Backpacks
|}
|-
 
| 6 || Headgear
<syntaxhighlight lang="cpp">
|-
//--- Text box which covers the top right quarter of the (center) screen
| 7 || Goggles
class TextboxTopRightQuarter: RscText
|-
{
| 8 || NVGs
x = safezoneX + 0.5 * safeZoneW;
y = safezoneY;
w = 0.5 * safezoneW;
h = 0.5 * safezoneH;
};
//--- Textbox which covers the entire screen on a triple head setup
class TextboxFullTripleScreen: RscText
{
x = safeZoneXAbs;
y = safeZoneY;
w = safeZoneWAbs;
h = safeZoneH;
};
</syntaxhighlight>
 
=== GUI_GRID ===
[[File:GUI GRID defines.png|thumb|GUI_GRIDs on "Very Large", "Normal" and "Very Small" (from top to bottom) on a 1920x1080 (16:9) screen. Not shown here are the pictures for the UI sizes "Small" and "Large".|500px]]
The GUI_GRID is based on the safeZone grid and is used by the majority of the game's dialogs. The additional functionality is the possibility to stay on screen even with different user settings such as aspect ratio or UI scale. It also helps to keep a uniform style between dialogs. If you are using the base classes starting with "Rsc" then it is advisable to use this grid as some attributes (eg. fonts) will only scale correctly with this grid. The defines for use in configs and scripts can be accessed by adding this line to your config:
<syntaxhighlight lang="cpp">#include "\a3\ui_f\hpp\definecommongrids.inc"</syntaxhighlight>
The following table will list the most commonly used grids which are defined in said file. To use them add the appropiate suffix _X, _Y, _W or _H to the variable name, eg GUI_GRID includes GUI_GRID_X, GUI_GRID_Y, GUI_GRID_W and GUI_GRID_H. The second and third column refer to where the dialog will originate from on other UI sizes.
 
{| class="wikitable"
|-
|-
! #define !! Horizontal !! Vertical !! Notes
| 9 || Binoculars
|-
|-
| GUI_GRID || Left || Bottom || Example: Escape menu (RscDisplayInterrupt)
| 10 || Maps
|-
|-
| GUI_GRID_CENTER || Center || Middle || Example: RscDisplayTeamSwitch
| 11 || GPS
|-
|-
| GUI_GRID_TOPCENTER || Center || Top ||  
| 12 || Radio
|-
|-
| GUI_GRID_BOTTOMCENTER || Center || Bottom || Example: Revive UI
| 13 || Compass
|-
|-
| GUI_GRID_CENTER_BOTTOM || Center || Bottom || Same as GUI_GRID_BOTTOMCENTER
| 14 || Watch
|-
|-
| GUI_GRID_TOPLEFT || Left || Top || Diary (the top left part of the map)
| 15 || Face (empty)
|}
 
The GUI_GRID divides the screen into 40 parts on the horizontal axis and into 25 vertically. Therefore no content should have negative x or y values nor should it exceed a width of 40 or a height of 25. Using a height of 25 or width of 40 is not the same as using screen height or width because the GUI_GRID will get smaller with smaller UI sizes as it should be. Examples:
<syntaxhighlight lang="cpp">
//--- Okay, will use entire available space:
x = GUI_GRID_CENTER_X + 0 * GUI_GRID_CENTER_W;
y = GUI_GRID_CENTER_Y + 0 * GUI_GRID_CENTER_H;
w = 40 * GUI_GRID_CENTER_W;
h = 25 * GUI_GRID_CENTER_H;
</syntaxhighlight>
<syntaxhighlight lang="cpp">
//--- NOT okay:
x = GUI_GRID_CENTER_X - 1 * GUI_GRID_CENTER_W;
y = GUI_GRID_CENTER_Y - 1 * GUI_GRID_CENTER_H;
w = 50 * GUI_GRID_CENTER_W;
h = 30 * GUI_GRID_CENTER_H;
</syntaxhighlight>
The second example will dissapear on certain settings on the left and top edge as well as exceed the screen's width and height.
 
Here is a copy paste example:
<syntaxhighlight lang="cpp">#include "\a3\ui_f\hpp\definecommongrids.inc"
class MyDialog
{
idd = -1;
class controls
{
class TextGUIGRID: RscStructuredText
{
text = "Text on the left bottom";
x = GUI_GRID_X + 0 * GUI_GRID_W;
y = GUI_GRID_Y + 24 * GUI_GRID_H;
w = 40 * GUI_GRID_W;
h = 1 * GUI_GRID_H;
};
class TextGUIGRIDCENTER: RscStructuredText
{
text = "<t align='center'>Text in the middle</t>";
x = GUI_GRID_CENTER_X + 0 * GUI_GRID_CENTER_W;
y = GUI_GRID_CENTER_Y + 12.5 * GUI_GRID_CENTER_H;
w = 40 * GUI_GRID_CENTER_W;
h = 1 * GUI_GRID_CENTER_H;
};
class TextGUIGRIDTOPCENTER: RscStructuredText
{
text = "<t align='center'>Text in the top center</t>";
x = GUI_GRID_TOPCENTER_X + 0 * GUI_GRID_TOPCENTER_W;
y = GUI_GRID_TOPCENTER_Y + 0 * GUI_GRID_TOPCENTER_H;
w = 40 * GUI_GRID_TOPCENTER_W;
h = 1 * GUI_GRID_TOPCENTER_H;
};
class TextGUIGRIDBOTTOMCENTER: RscStructuredText
{
text = "<t align='center'>Text bottom center</t>";
x = GUI_GRID_BOTTOMCENTER_X + 0 * GUI_GRID_BOTTOMCENTER_W;
y = GUI_GRID_BOTTOMCENTER_Y + 24 * GUI_GRID_BOTTOMCENTER_H;
w = 40 * GUI_GRID_BOTTOMCENTER_W;
h = 1 * GUI_GRID_BOTTOMCENTER_H;
};
class TextGUIGRIDTOPLEFT: TextGUIGRID
{
text = "Text on the left top";
x = GUI_GRID_TOPLEFT_X + 0 * GUI_GRID_TOPLEFT_W;
y = GUI_GRID_TOPLEFT_Y + 0 * GUI_GRID_TOPLEFT_H;
// w and h are inherited from TextGUIGRID
// GUI_GRID_name_W and GUI_GRID_name_H are the same for every define
};
};
};
</syntaxhighlight>
 
=== [[Pixel Grid System|Pixel Grid]] ===
The pixel grid system was introduced to resolve issues with UI elements which appeared not as they should be because of the fact that the computer can't draw inbetween pixels. For a more indepth explanation of the grid go to the [[Pixel Grid System|dedicated BIKI page]]. The base controls from which to inherit from usually start with ctrl, eg. ctrlPicture, ctrlStrucuturedText, etc.. Mixing controls with different grids on the same dialog might lead to undesired visuals.
 
==== Commands ====
{| class="wikitable"
|-
|-
! Command !! Explanation
| 16 || Voice (empty)
|-
|-
| [[pixelW]] || Width of one pixel. On displays with too fine resolution (e.g., 4K), it can get too small for practical use.
| 17 || Insignia (empty)
|-
|-
| [[pixelH]] || Height of one pixel. On displays with too fine resolution (e.g., 4K), it can get too small for practical use.
| 18 || Optic attachments (empty)
|-
|-
| [[pixelGrid]] || Multiplier based on resolution, interface size and some config values. It can be divided by up to 4 and still be a whole number. Due to this rounding, some interface sizes may use the same value.
| 19 || Side attachments (empty)
|-
|-
| [[pixelGridBase]] || Multiplier only based on the screen resolution.
| 20 || Muzzle attachments (empty)
|-
|-
| [[pixelGridNoUIScale]] || Similar to pixelGrid, but affected only by resolution, not interface size. Usually used to keep some important elements, e.g., spotlight buttons in the main menu.
| 21 || Compatible magazines (empty)
|}
 
==== Includes ====
<syntaxhighlight lang="cpp">#include "\a3\3DEN\UI\macros.inc"
#include "\a3\3DEN\UI\macroexecs.inc"</syntaxhighlight>
{| class="wikitable"
|-
|-
! #define !! Explanation
| 22 || Grenades
|-
|-
| GRID_W || Width of one grid
| 23 || Placeables
|-
|-
| GRID_H || Height of one grid
| 24 || Miscellaneous
|-
|-
| CENTER_X || Vertical screen center
| 25 || Bipod attachments (empty)
|-
|-
| CENTER_Y || Horizontal screen center
| 26 || All magazines
|}
|}


==== Examples ====
|}
<syntaxhighlight lang="cpp">#include "\a3\3DEN\UI\macros.inc"
#include "\a3\3DEN\UI\macroexecs.inc"
class MyPixelGridDialog
{
idd = -1;
class controls
{
class TextLeftTop: ctrlStructuredText
{
text = "Left top";
x = safeZoneX + 0 * GRID_W;
y = safeZoneY + 0 * GRID_H;
w = 50 * GRID_W;
h = 5 * GRID_H;
colorBackground[] = {1,0,0,1};
};
class TextCenterMiddle: TextLeftTop
{
text = "Center middle";
x = CENTER_X - 25 * GRID_W;
y = CENTER_Y - 2.5 * GRID_H;
};
class TextRightBottom: TextLeftTop
{
text = "Left bottom";
x = safeZoneX + safeZoneW - 50 * GRID_W;
y = safeZoneY + safeZoneH - 5 * GRID_H;
};
};
};</syntaxhighlight>
 
[[Category: Dialogs|GUI Coordinates]]

Latest revision as of 01:11, 6 September 2021

Variables

This is a list of all the variables that are used by the Virtual Arsenal.

missionNamespace
Variable Data Type Explanation
BIS_fnc_arsenal_data Array of arrays of strings All available items that can be accessed in the Arsenal (not the actual content!). Format:
Index Content
0 Primary Weapons
1 Secondary Weapons
2 Handguns
3 Uniforms
4 Vests
5 Backpacks
6 Headgear
7 Goggles
8 NVGs
9 Binoculars
10 Maps
11 GPS
12 Radio
13 Compass
14 Watch
15 Face (empty)
16 Voice (empty)
17 Insignia (empty)
18 Optic attachments (empty)
19 Side attachments (empty)
20 Muzzle attachments (empty)
21 Compatible magazines (empty)
22 Grenades
23 Placeables
24 Miscellaneous
25 Bipod attachments (empty)
26 All magazines
Retrieved from "https://community.bistudio.com/wiki?title=User:7erra/Sandbox&oldid=293365"