DialogControls-Text: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Added scripted example for HTML.)
m (disamb page now)
Tag: Replaced
Line 1: Line 1:
{{SideTOC}}
* [[CT_STATIC]]
{{Informative|TokenNames common to most controls, such as x, y, w, h, text, idc... can be found [[Arma:_GUI_Configuration#Common_Properties|'''here''']].}}
* [[CT_STRUCTURED_TEXT]]
=== CT_STATIC=0 ===
* [[CT_HTML]]


Static controls represent exactly that: static data. Static means there is NO possible user interaction. CT_STATIC is primarily used for texts, dialog backgrounds, pictures (and video). The constant ''type'' property for these controls usually is <tt>CT_STATIC</tt>.
{{Template:Disambig}}
 
{|class="wikitable" border="1" align="left" cellpadding="3" cellspacing="0" |
! colspan="3" bgcolor="#bbbbff" | Properties
|-
! bgcolor="#ddddff" | Name
! bgcolor="#ddddff" | Type
! bgcolor="#ddddff" | Remark
|-
| '''autoplay'''
| [[Boolean]]
| Whether or not to autostart .ogv/.ogg file set as texture
|-
| '''loops'''
| [[Integer]]
| How many times to play video
|-
| '''lineSpacing'''
| [[Float]]
| Line spacing, required if the style was set to <tt>ST_MULTI</tt>
|-
| '''fixedWidth'''
| [[Boolean]]
| Makes normal text like "LALALA" appear like "L A L A L A"
|-
| '''colorShadow'''
| array
| Sets color of the shadow under text, when '''shadow''' = 1;
|-
| '''blinkingPeriod'''
| [[Float]]
| Speed with which control blinks, i.e. smoothly and repeatedly changes opacity from 1 to 0 and back
|}<br clear="all">
 
 
==== Static Text ====
[[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.
 
* '''Example Config:'''
<syntaxhighlight lang="cpp">class RscText
{
  access = 0;
  type = CT_STATIC;
  idc = -1;
  style = ST_LEFT;
  w = 0.1; h = 0.05;
  //x and y are not part of a global class since each rsctext will be positioned 'somewhere'
  font = "TahomaB";
  sizeEx = 0.04;
  colorBackground[] = {0,0,0,0};
  colorText[] = {1,1,1,1};
  text = "";
  fixedWidth = 0;
  shadow = 0;
};
class Dialog
{
  class Controls
  {
    class Background: RscText
    {
      text = "whatever";
      colorBackground[] = {0,0,0,1};
      x = 0;  y = 0;  w = 1;  h = 1;
      colorText[] = {0,0,0,0};
    };
  };
};</syntaxhighlight>
 
==== Static Lines ====
<syntaxhighlight lang="cpp">class MyLine:RscText
{
  style = ST_LINE;
  colorText[] = {0.2941,0.8745,0.2157,1.0}; // to whatever gives you a thrill
};</syntaxhighlight>
==== Static Frames ====
<syntaxhighlight lang="cpp">class RscFrame
{
  type = CT_STATIC;
  idc = -1;
  style = 64;
  shadow = 2;
  colorBackground[] = {0,0,0,0};
  colorText[] = {1,1,1,1};
  font = "Zeppelin32";
  sizeEx = 0.02;
  text = "";
};</syntaxhighlight>
 
==== Static Background ====
[[Image:Dialog controls background.jpg|thumb||Semi-transparent background]]
One can also 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.
 
* '''Example Config:'''
<syntaxhighlight lang="cpp">class MyRedBackgroundExample
{
  /* ... same as the text example, except for */
  colorBackground[] = { 1, 0.1, 0.1, 0.8 };
  text = "";
};</syntaxhighlight>
 
==== Static Pictures ====
Using specific style constants you can enhance your dialogs with pictures too. These pictures should reside in your mission folder as [[PAA File Format|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 addon or mission folder (''absolute paths cannot be used'').
 
[[Image:Dialog controls picture.jpg|thumb|100px|Dialog control showing a picture]]
* '''Example Config:'''
<syntaxhighlight lang="cpp">class RscPicture
{
  access = 0;
  type = CT_STATIC;
  idc = -1;
  style = 48;//ST_PICTURE
  colorBackground[] = {0,0,0,0};
  colorText[] = {1,1,1,1};
  font = "TahomaB";
  sizeEx = 0;
  lineSpacing = 0;
  text = "";
  fixedWidth = 0;
  shadow = 0;
};
class Dialog
{
  class Controls
  {
    class Picture: RscPicture
    {
      text = "#(argb,8,8,3)color(1,1,1,1)";
      /* or */
      text = "mypicture.paa";
      x = 0.46;
      y = 0.63;
      w = 0.08;
      h = 0.1;
      colorText[] = {0.4,0.6745,0.2784,1.0};// whatever gives you a thrill
    };
  };
};</syntaxhighlight>
 
====  Static Videos ====
[[Image:arma2oa_1.56.gif]]
 
All settings are same as for pictures, only source file must be of ''.OGV'' format. Two additional properties are available - ''autoplay'' (when 1, video starts automatically) and ''loops'' (defines how many times video will be played in loop).
 
For video encoding, you can use:
* [http://www.v2v.cc/~j/ffmpeg2theora/download.html ffmpeg2theora]
* [http://sourceforge.net/projects/theoraconverter/ Theora Converter .NET (GUI for ffmpeg2theora)]
 
* '''Example Config:'''
<syntaxhighlight lang="cpp">MyVideoExample
{
  /* ... same as the picture example, with addition of */
  text = "myVideo.ogv";
  autoplay = 1;
  loops = 10;
};</syntaxhighlight>
 
===CT_STRUCTURED_TEXT=13===
The Structured Text control can display [[Structured Text]]. This is a separate [[Data Types|data type]] in Arma.
Structured Text can not only hold some text values, it also can contain some attributes to format the text, as you can see in the example picture below.
You ''can'' contain a subclass '''Attributes''' to change the default attributes for your control. But the ''Attributes class'' and all of its attributes are ''optional'' and do not have to be specified.
 
{|class="wikitable" border="1" align="left" cellpadding="3" cellspacing="0" |
! colspan="3" bgcolor="#bbbbff" | Properties
|-
! bgcolor="#ddddff" | Name
! bgcolor="#ddddff" | Type
! bgcolor="#ddddff" | Remark
|-
| '''size'''
| [[Float]]
| Set the size of the text where 1 is the size value of parent class.
|-
| '''Attributes'''
| class
| see below
|-
| '''ShowImage'''
| [[Boolean]]
| found in an xbox dialog and probably quite useless
|-
|}<br clear="all">
 
 
{|class="wikitable" border="1" align="left" cellpadding="3" cellspacing="0" |
! colspan="4" bgcolor="#bbbbff" | Optional SubClass Attributes Properties
|-
! bgcolor="#ddddff" | Name
! bgcolor="#ddddff" | Type
! bgcolor="#ddddff" | Remark
! bgcolor="#ddddff" | Default Value
|-
| '''font'''
| string
| fontname to use
| "Zeppelin32"
|-
| '''size'''
| [[Float]]
| Set the size of the text where 1 is the size value of parent class.
| 1
|-
| '''color'''
| string
| text color defined in HMTL-like syntax.
| "#ffffff"
|-
| '''align'''
| string
| align of text. Values can be "left", "center" or "right"
| "center"
|-
| '''valign'''
| string
| vertical align of text. Values can be "top", "middle", "bottom".
| "middle"
|-
| '''shadow'''
| [[Integer]]
| affects the shadow of the text.
| 1 (true)
|-
| '''shadowColor'''
| string
| shadow color defined in HMTL-like syntax.
| "#000000"
|-
| '''shadowOffset'''
|
|
|
|-
| '''image'''
| string
|
|
|-
| '''underline'''
|
|
|
|-
| '''href'''
| string
|
|
|-
| '''linkColor'''
| string
|
|
|-
|}<br clear="all">
 
The following example uses almost the same code as the controls shown in the example screenshot.
[[Image:ControlStructuredText.jpg|thumb|400px|A StructuredText control based on sample code]]
* '''Example Config:'''
<syntaxhighlight lang="cpp">class MyRscStructuredText
{
  idc = -1;
  type = CT_STRUCTURED_TEXT;  // defined constant
  style = ST_LEFT;            // defined constant
  colorBackground[] = { 1, 1, 1, 1 };
  x = 0.1;
  y = 0.1;
  w = 0.3;
  h = 0.1;
  size = 0.018;
  text = "";
  class Attributes
  {
    font = "TahomaB";
    color = "#000000";
    align = "center";
    valign = "middle";
    shadow = false;
    shadowColor = "#ff0000";
    size = "1";
  };
};</syntaxhighlight>
 
* '''Helpful Script Commands:'''
'''[[ctrlSetStructuredText]], [[lineBreak]], [[parseText]], [[composeText]], [[image]]'''
 
===CT_HTML=9===
 
The HTML control is well known as the "notebook" in the Map-View of the game. It can display a text over more pages and can inherit links to other, own defined sections. It has some simple formatting possibilities. It also can display images.
 
{|class="wikitable" border="1" align="left" cellpadding="3" cellspacing="0" |
! colspan="3" bgcolor="#bbbbff" | Properties
|-
! bgcolor="#ddddff" | Name
! bgcolor="#ddddff" | Type
! bgcolor="#ddddff" | Remark
|-
| '''align'''
| string
| "center"
|-
| '''cyclelinks'''
| [[Boolean]]
|
|-
| '''filename'''
| string
| the html file to load into the control at startup
|-
| '''text'''
| string
| the text the control should display. Leave it blank, if you set a '''filename'''
|-
| '''colorBold'''
| color array
| color of '''bold''' text (between &lt;b&gt; and </b> tags)
|-
| '''colorLink'''
| color array
| text color of links (between <a href="#Sectionname> and </a>)
|-
| '''colorLinkActive'''
| color array
| text color of the active link (normaly the fist on in page)
|-
| '''colorPicture'''
| color array
| color of transparent part of image
|-
| '''colorPictureBorder'''
| color array
| color of the borader arround image
|-
| '''colorPictureLink'''
| color array
| color of transparent part of image within links
|-
| '''colorPictureSelected'''
| color array
| color of transparent part of image within active links
|-
| '''tooltipColorText'''
| color array
| 
|-
| '''tooltipColorBox'''
| color array
| 
|-
| '''tooltipColorShade'''
| color array
| 
|-
| '''prevPage'''
| string argb
| filename of image which is used as left arrow
|-
| '''nextPage'''
| string argb
| filename of image which is used as right arrow
|-
! colspan="3" bgcolor="#bbbbff" | Properties of subclass (H1-H6,P)
|-
! bgcolor="#ddddff" | Name
! bgcolor="#ddddff" | Type
! bgcolor="#ddddff" | Remark
|-
| '''font'''
| string
| font to use for default text
|-
| '''fontBold'''
| string
| font to use within bold tags
|-
| '''sizeEx'''
| [[Float]]
| font size
|-
|}<br clear="all">
 
=== Example Config ===
<syntaxhighlight lang="cpp">class RscHTML
{
  deletable = 0;
  fade = 0;
  access = 0;
  type = CT_HTML;
  idc = -1;
  style = ST_LEFT;
  filename = "";
  colorBackground[] = {0,0,0,0};
  colorText[] = {1,1,1,1};
  colorBold[] = {1,1,1,1};
  colorLink[] = {1,1,1,0.75};
  colorLinkActive[] = {1,1,1,1};
  colorPicture[] = {1,1,1,1};
  colorPictureLink[] = {1,1,1,1};
  colorPictureSelected[] = {1,1,1,1};
  colorPictureBorder[] = {0,0,0,0};
  tooltipColorText[] = {1,1,1,1};
  tooltipColorBox[] = {1,1,1,1};
  tooltipColorShade[] = {0,0,0,0.65};
  class H1
  {
      font = "RobotoCondensed";
      fontBold = "RobotoCondensedBold";
      sizeEx = GUI_TEXT_SIZE_LARGE;
      align = "left";
  };
  class H2
  {
      font = "RobotoCondensed";
      fontBold = "RobotoCondensedBold";
      sizeEx = GUI_TEXT_SIZE_MEDIUM;
      align = "right";
  };
  class H3
  {
      font = "RobotoCondensed";
      fontBold = "RobotoCondensedBold";
      sizeEx = GUI_TEXT_SIZE_MEDIUM;
      align = "left";
  };
  class H4
  {
      font = "RobotoCondensed";
      fontBold = "RobotoCondensedBold";
      sizeEx = GUI_TEXT_SIZE_MEDIUM;
      align = "left";
  };
  class H5
  {
      font = "RobotoCondensed";
      fontBold = "RobotoCondensedBold";
      sizeEx = GUI_TEXT_SIZE_MEDIUM;
      align = "left";
  };
  class H6
  {
      font = "RobotoCondensed";
      fontBold = "RobotoCondensedBold";
      sizeEx = GUI_TEXT_SIZE_MEDIUM;
      align = "left";
  };
  class P
  {
      font = "RobotoCondensed";
      fontBold = "RobotoCondensedBold";
      sizeEx = GUI_TEXT_SIZE_MEDIUM;
      align = "left";
  };
  x = 0;
  y = 0;
  w = 0.1;
  h = 0.1;
  sizeEx = GUI_TEXT_SIZE_MEDIUM;
  prevPage = "\A3\ui_f\data\gui\rsccommon\rschtml\arrow_left_ca.paa";
  nextPage = "\A3\ui_f\data\gui\rsccommon\rschtml\arrow_right_ca.paa";
  shadow = 2;
};</syntaxhighlight>
 
=== Scripted Example ===
[[File:A3 CT HTML EXAMPLE.jpg|thumb|Scripted Example]]
 
# Open [[Eden Editor]]
# Save the mission
# Create the file test.html in the mission folder and copy the html code from this page in it (see below)
# Open the [[Arma 3 Debug Console]] and execute the sqf code
 
==== SQF Code ====
[[disableSerialization]];
 
[[private]] _display = [[findDisplay]] 313 [[createDisplay]] "RscDisplayEmpty";
 
[[private]] _ctrlGroup = _display [[ctrlCreate]] ["RscControlsGroup", -1];
[[private]] _ctrlHTML = _display [[ctrlCreate]] ["RscHTML", -1, _ctrlGroup];
 
_ctrlGroup [[ctrlSetPosition]] [0,[[safeZoneY]] + 0.01,1,[[safeZoneH]] - 0.02];
_ctrlGroup [[ctrlCommit]] 0;
 
_ctrlHTML [[ctrlSetPosition]] [0,0,0.98,2];
_ctrlHTML [[ctrlSetBackgroundColor]] [0,0,0,1];
_ctrlHTML [[ctrlCommit]] 0;
_ctrlHTML [[htmlLoad]] "test.html"
 
==== test.html ====
<syntaxhighlight lang="html">
<html>
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
        <title>PageTitle</title>
    </head>
    <body>
        <h1><a name="FirstSection">First Section</a></h1>
        <p>This is the text to display in this section. You can write a lot of text here.</p>
        <br>
        <h1><a name="Alignment">Alignment</a></h1>
        <p>Text can be aligned left, center or right</p>
        <br>
        <p align="left"><a name="left">Left</a></p>
        <p align="center"><a name="center">Center</a></p>
        <p align="right">Right</p>
        <h1><a name="Font Sizes">Font Sizes</a></h1>
        <p>Out of the box the CT_HTML offers seven font sizes. These can be changed in the controls config.</p>
        <p>P (default)</p>
        <h1>H1</h1>
        <h2>H2</h2>
        <h3>H3</h3>
        <h4>H4</h4>
        <h5>H5</h5>
        <h6>H6</h6>
        <br>
        <h1><a name="Links">Links</a></h1>
        <p>It is possible to link to sections or websites.</p>
        <p><a href="#FirstSection">A link to the first section.</a></p>
        <p><a href="https://community.bistudio.com/wiki/HTML_File_Format">A link to the BIKI.</a></p>
        <br>
        <h1><a name="Images">Images</a></h1>
        <p>Images can also be displayed</p>
        <p align="center"><img src="\a3\ui_f_curator\data\logos\arma3_curator_logo_ca.paa" height="100" width="100"></p>
        <h1><a name="TextFormatting">Text Formatting</a></h1>
        <p>Text can also be <b>bold</b>. The color and font used for this can be defined in config.</p>
    </body>
</html>
</syntaxhighlight>
 
* '''Helpful Script Commands:'''
'''[[htmlLoad]]'''
[[Category: Dialogs|Text]]

Revision as of 15:06, 29 November 2020

Template:Disambig

Retrieved from "https://community.bistudio.com/wiki?title=DialogControls-Text&oldid=170118"