Arma 3 Scripting

CT CHECKBOXES

  • Also known as DialogControls-CheckBoxes

Topic · Markdown · JSON · original wiki page

Introduction

The Checkboxes (also known as textual checkboxes) are a set of state change buttons, ordered by columns and rows. Unlike the Toolbox Control more than one button can become active. Maximum number of checkboxes available for a single control is 32. It is possible to create more than 32 checkboxes, however over-the-limit checkboxes will just become duplicates. CT_CHECKBOXES fully inherits from CT_TOOLBOX, the difference is that with CheckBoxes one can make multiple selections or have no item selected. When CheckBoxes style is ST_PICTURE, the strings property is treated as array of textures, and checked_strings property is ignored.

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_CHECKBOXES 7

C

checked_strings

Type: Array

Description: Checkboxes texts to display when checkboxes are checked

checked_strings[] = {"CHECKED"};

color

Type: Array

Description: n/a

color[] = {0,0,0,0};

colorBackground

Type: Array

Description: Color of the background when checkbox is not in focus (doesn't matter if checked or not).

colorBackground[] = {0,0,0,0};

colorDisable

Type: Array

Description: n/a

colorDisable[] = {0.4,0.4,0.4,1};

colorSelect

Type: Array

Description: n/a

colorSelect[] = {0,0,0,1};

colorSelectedBg

Type: Array

Description: Color of the background when checkbox is in focus (doesn't matter if checked or not).

colorSelectedBg[] = {"(profilenamespace getvariable ['GUI_BCG_RGB_R',0.13])","(profilenamespace getvariable ['GUI_BCG_RGB_G',0.54])","(profilenamespace getvariable ['GUI_BCG_RGB_B',0.21])",1};

colorText

Type: Array

Description: Color of the unchecked checkbox text

colorText[] = {0.4,0.4,0.4,1};

colorTextDisable

Type: Array

Description: n/a

colorTextDisable[] = {0.4,0.4,0.4,1};

colorTextSelect

Type: Array

Description: Color of the checked checkbox text

colorTextSelect[] = {0,0.8,0,1};

columns

Type: Number

Description: Amount of columns to arrange checkboxes into

columns = 1;

R

rows

Type: Number

Description: Amount of rows to arrange checkboxes into.

rows = 1;

S

strings

Type: Array

Description: Checkboxes texts to display

strings[] = {"UNCHECKED"};

T

tooltips

Type: Array

Description: Tooltips for each checkbox.

tooltips[] = {"tip0","tip1","tip2","tip3","tip4","tip5","tip6","tip7","tip8","tip9","tip10","tip11","tip12","tip13","tip14","tip15","tip16","tip17","tip18","tip19","tip20","tip21","tip22","tip23","tip24","tip25","tip26","tip27","tip28","tip29","tip30","tip31"};;

V

values

Type: Array

Description: Numerical values associated with items. Can be retrieved or set with lbValue and lbSetValue.

values[] = {1,2,3,4};

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.

Neither the export nor the configFile contains a base class for this control type.

Example Classes

class MyCheckBoxes
{
    onLoad = "_this select 0 ctrlSetChecked [1, true]; _this select 0 ctrlSetChecked [7, true]; _this select 0 ctrlSetChecked [15, true];";

    idc = -1;
    type = 7; // CT_CHECKBOXES
    style = 2; // ST_CENTER

    x = 0.25;
    y = 0.25;
    w = 0.5;
    h = 0.5;

    colorText[] = {0, 1, 0, 1};
    colorTextSelect[] = {1, 0, 0, 1};

    colorBackground[] = {0, 0, 1, 0.3};
    colorSelectedBg[] = {0, 0, 0, 0.2};

    font = "RobotoCondensed";
    sizeEx = 0.04;

    onCheckBoxesSelChanged = "hint str _this";

    columns = 8;
    rows = 4;

    strings[] = {"0","1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30","31"};
    checked_strings[] = {"[0]","[1]","[2]","[3]","[4]","[5]","[6]","[7]","[8]","[9]","[10]","[11]","[12]","[13]","[14]","[15]","[16]","[17]","[18]","[19]","[20]","[21]","[22]","[23]","[24]","[25]","[26]","[27]","[28]","[29]","[30]","[31]"};
    values[] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31};
    tooltips[] = {"tip0","tip1","tip2","tip3","tip4","tip5","tip6","tip7","tip8","tip9","tip10","tip11","tip12","tip13","tip14","tip15","tip16","tip17","tip18","tip19","tip20","tip21","tip22","tip23","tip24","tip25","tip26","tip27","tip28","tip29","tip30","tip31"};
};