CT STRUCTURED TEXT

Topic · Markdown · JSON · original wiki page

Introduction

The Structured Text control can display Structured Text. This is a separate 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 add the Attributes subclass to change the default Structured Text attributes of your control, but the Attributes class and all of its attributes are optional and do not have to be specified.

Events: General

Alphabetical Order

Note
TokenNames common to most controls, such as x, y, w, h, text, idc... can be found here.

Warning
Not all of the listed attributes might have an effect nor might the list be complete. All attributes were gathered with this config crawler.

#define CT_STRUCTURED_TEXT 13

A

Attributes

Type: Class

Description

Subclass with options how the text should be rendered. Attributes represent the Structured Text options.

Warning
Attributes ( class Attributes) are not inherited from an existing CT_STRUCTURED_TEXT control. While no error is shown, properties of class Attributes will be set to some default values. Re-define needed properties manually.

Optional SubClass Attributes Properties
Name	Type	Remark	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". Important Seems to be broken	"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

class Attributes
{
    font = "RobotoCondensed";
    color = "#ffffff";
    colorLink = "#D09B43";
    align = "left";
    shadow = 1;
};

Default Classes

Note
Arma 3: AddOns: Classes need to be initialised first with class SomeClass;

Missions: Since Arma 3 v2.02 one can use import SomeClass; to initialise a class (see the import keyword).

In older versions, use "Default" call BIS_fnc_exportGUIBaseClasses; and paste the result into the description.ext.

RscStructuredText

class RscStructuredText
{
    deletable = 0;
    fade = 0;
    access = 0;
    type = CT_STRUCTURED_TEXT;
    idc = -1;
    style = ST_LEFT;
    colorText[] = {1,1,1,1};
    class Attributes
    {
        font = "RobotoCondensed";
        color = "#ffffff";
        colorLink = "#D09B43";
        align = "left";
        shadow = 1;
    };
    x = 0;
    y = 0;
    h = 0.035;
    w = 0.1;
    text = "";
    size = GUI_TEXT_SIZE_MEDIUM;
    shadow = 1;
};

Other Examples

The following example uses almost the same code as the controls shown in the example screenshot.

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";
    };
};