{"name":"CT CHECKBOX","title":"CT CHECKBOX","type":"topic","url":"https://community.bistudio.com/wiki/CT_CHECKBOX","revid":342180,"updated":"2023-07-09T12:26:56Z","aliases":["DialogControls-CheckBox"],"markdown":"### Introduction\n\nA toggleable control. There are two states that can be switched between: Checked and Unchecked.\n\n#### Related commands & functions\n\n- Commands: General\n- Commands: UI Eventhandlers\n- cbSetChecked\n- cbChecked\n\n#### Related User Interface Eventhandlers\n\n- Events: General\n- Events: Checkbox\n\n### Alphabetical Order\n\n> [!NOTE]\n> TokenNames common to most controls, such as x, y, w, h, text, idc... can be found **here**.\n\n> [!WARNING]\n> Not all of the listed attributes might have an effect nor might the list be complete. All attributes were gathered with [this](https://github.com/7erra/BIKI.VR/blob/master/fnc/generateCTPage.sqf) config crawler.\n\n```cpp\n#define CT_CHECKBOX 77\n```\n\n#### C\n\n##### checked\n\n**Type:** Number\n\n**Description:** Default state of the control. Can be either 0 or 1.\n\n```cpp\nchecked = 0;\n```\n\n##### color\n\n**Type:** Array\n\n**Description:** n/a\n\n```cpp\ncolor[] = {1,1,1,0.7};\n```\n\n##### colorBackgroundDisabled\n\n**Type:** Array\n\n**Description:** n/a\n\n```cpp\ncolorBackgroundDisabled[] = {0,0,0,0};\n```\n\n##### colorBackgroundFocused\n\n**Type:** Array\n\n**Description:** n/a\n\n```cpp\ncolorBackgroundFocused[] = {0,0,0,0};\n```\n\n##### colorBackgroundHover\n\n**Type:** Array\n\n**Description:** n/a\n\n```cpp\ncolorBackgroundHover[] = {0,0,0,0};\n```\n\n##### colorBackgroundPressed\n\n**Type:** Array\n\n**Description:** n/a\n\n```cpp\ncolorBackgroundPressed[] = {0,0,0,0};\n```\n\n##### colorFocused\n\n**Type:** Array\n\n**Description:** n/a\n\n```cpp\ncolorFocused[] = {1,1,1,1};\n```\n\n##### colorHover\n\n**Type:** Array\n\n**Description:** n/a\n\n```cpp\ncolorHover[] = {1,1,1,1};\n```\n\n##### colorPressed\n\n**Type:** Array\n\n**Description:** n/a\n\n```cpp\ncolorPressed[] = {1,1,1,1};\n```\n\n#### S\n\n##### soundClick\n\n**Type:** Array\n\n**Description:** n/a\n\n```cpp\nsoundClick[] = {\"\",0.1,1};\n```\n\n##### soundEnter\n\n**Type:** Array\n\n**Description:** n/a\n\n```cpp\nsoundEnter[] = {\"\\A3\\ui_f\\data\\sound\\RscButton\\soundEnter\",0.09,1};\n```\n\n##### soundEscape\n\n**Type:** Array\n\n**Description:** n/a\n\n```cpp\nsoundEscape[] = {\"\\A3\\ui_f\\data\\sound\\RscButton\\soundEscape\",0.09,1};\n```\n\n##### soundPush\n\n**Type:** Array\n\n**Description:** n/a\n\n```cpp\nsoundPush[] = {\"\",0.1,1};\n```\n\n#### T\n\n##### textureChecked\n\n**Type:** String\n\n**Description:** n/a\n\n```cpp\ntextureChecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_checked_ca.paa\";\n```\n\n##### textureDisabledChecked\n\n**Type:** String\n\n**Description:** n/a\n\n```cpp\ntextureDisabledChecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_checked_ca.paa\";\n```\n\n##### textureDisabledUnchecked\n\n**Type:** String\n\n**Description:** n/a\n\n```cpp\ntextureDisabledUnchecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_unchecked_ca.paa\";\n```\n\n##### textureFocusedChecked\n\n**Type:** String\n\n**Description:** n/a\n\n```cpp\ntextureFocusedChecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_checked_ca.paa\";\n```\n\n##### textureFocusedUnchecked\n\n**Type:** String\n\n**Description:** n/a\n\n```cpp\ntextureFocusedUnchecked = \"\\a3\\3DEN\\Data\\Displays\\Display3DEN\\ToolBar\\widget_scaling_off_ca.paa\";\n```\n\n##### textureHoverChecked\n\n**Type:** String\n\n**Description:** n/a\n\n```cpp\ntextureHoverChecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_checked_ca.paa\";\n```\n\n##### textureHoverUnchecked\n\n**Type:** String\n\n**Description:** n/a\n\n```cpp\ntextureHoverUnchecked = \"\\a3\\3DEN\\Data\\Displays\\Display3DEN\\ToolBar\\widget_area_off_ca.paa\";\n```\n\n##### texturePressedChecked\n\n**Type:** String\n\n**Description:** n/a\n\n```cpp\ntexturePressedChecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_checked_ca.paa\";\n```\n\n##### texturePressedUnchecked\n\n**Type:** String\n\n**Description:** n/a\n\n```cpp\ntexturePressedUnchecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_unchecked_ca.paa\";\n```\n\n##### textureUnchecked\n\n**Type:** String\n\n**Description:** n/a\n\n```cpp\ntextureUnchecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_unchecked_ca.paa\";\n```\n\n### Default Classes\n\n> [!NOTE]\n> **Arma 3:** **AddOns:** Classes need to be initialised first with `class SomeClass;`\n>\n> ---\n>\n> **Missions:** Since Arma 3 v2.02 one can use `import SomeClass;` to initialise a class (see the import keyword).\n>\n> In older versions, use `\"Default\" call BIS_fnc_exportGUIBaseClasses;` and paste the result into the description.ext.\n\n#### RscCheckbox\n\n```cpp\nclass RscCheckBox\n{\n    idc = -1;\n    type = CT_CHECKBOX;\n    deletable = 0;\n    style = ST_LEFT;\n    checked = 0;\n    x = \"0.375 * safezoneW + safezoneX\";\n    y = \"0.36 * safezoneH + safezoneY\";\n    w = \"0.025 * safezoneW\";\n    h = \"0.04 * safezoneH\";\n    color[] = {1,1,1,0.7};\n    colorFocused[] = {1,1,1,1};\n    colorHover[] = {1,1,1,1};\n    colorPressed[] = {1,1,1,1};\n    colorDisabled[] = {1,1,1,0.2};\n    colorBackground[] = {0,0,0,0};\n    colorBackgroundFocused[] = {0,0,0,0};\n    colorBackgroundHover[] = {0,0,0,0};\n    colorBackgroundPressed[] = {0,0,0,0};\n    colorBackgroundDisabled[] = {0,0,0,0};\n    textureChecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_checked_ca.paa\";\n    textureUnchecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_unchecked_ca.paa\";\n    textureFocusedChecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_checked_ca.paa\";\n    textureFocusedUnchecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_unchecked_ca.paa\";\n    textureHoverChecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_checked_ca.paa\";\n    textureHoverUnchecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_unchecked_ca.paa\";\n    texturePressedChecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_checked_ca.paa\";\n    texturePressedUnchecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_unchecked_ca.paa\";\n    textureDisabledChecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_checked_ca.paa\";\n    textureDisabledUnchecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_unchecked_ca.paa\";\n    tooltipColorText[] = {1,1,1,1};\n    tooltipColorBox[] = {1,1,1,1};\n    tooltipColorShade[] = {0,0,0,0.65};\n    soundEnter[] =\n    {\n        \"\",\n        0.1,\n        1\n    };\n    soundPush[] =\n    {\n        \"\",\n        0.1,\n        1\n    };\n    soundClick[] =\n    {\n        \"\",\n        0.1,\n        1\n    };\n    soundEscape[] =\n    {\n        \"\",\n        0.1,\n        1\n    };\n};\n```","sections":[{"heading":"Introduction","level":3,"markdown":"A toggleable control. There are two states that can be switched between: Checked and Unchecked."},{"heading":"Related commands & functions","level":4,"markdown":"- Commands: General\n- Commands: UI Eventhandlers\n- cbSetChecked\n- cbChecked"},{"heading":"Related User Interface Eventhandlers","level":4,"markdown":"- Events: General\n- Events: Checkbox"},{"heading":"Alphabetical Order","level":3,"markdown":"> [!NOTE]\n> TokenNames common to most controls, such as x, y, w, h, text, idc... can be found **here**.\n\n> [!WARNING]\n> Not all of the listed attributes might have an effect nor might the list be complete. All attributes were gathered with [this](https://github.com/7erra/BIKI.VR/blob/master/fnc/generateCTPage.sqf) config crawler.\n\n```cpp\n#define CT_CHECKBOX 77\n```"},{"heading":"C","level":4,"markdown":""},{"heading":"checked","level":5,"markdown":"**Type:** Number\n\n**Description:** Default state of the control. Can be either 0 or 1.\n\n```cpp\nchecked = 0;\n```"},{"heading":"color","level":5,"markdown":"**Type:** Array\n\n**Description:** n/a\n\n```cpp\ncolor[] = {1,1,1,0.7};\n```"},{"heading":"colorBackgroundDisabled","level":5,"markdown":"**Type:** Array\n\n**Description:** n/a\n\n```cpp\ncolorBackgroundDisabled[] = {0,0,0,0};\n```"},{"heading":"colorBackgroundFocused","level":5,"markdown":"**Type:** Array\n\n**Description:** n/a\n\n```cpp\ncolorBackgroundFocused[] = {0,0,0,0};\n```"},{"heading":"colorBackgroundHover","level":5,"markdown":"**Type:** Array\n\n**Description:** n/a\n\n```cpp\ncolorBackgroundHover[] = {0,0,0,0};\n```"},{"heading":"colorBackgroundPressed","level":5,"markdown":"**Type:** Array\n\n**Description:** n/a\n\n```cpp\ncolorBackgroundPressed[] = {0,0,0,0};\n```"},{"heading":"colorFocused","level":5,"markdown":"**Type:** Array\n\n**Description:** n/a\n\n```cpp\ncolorFocused[] = {1,1,1,1};\n```"},{"heading":"colorHover","level":5,"markdown":"**Type:** Array\n\n**Description:** n/a\n\n```cpp\ncolorHover[] = {1,1,1,1};\n```"},{"heading":"colorPressed","level":5,"markdown":"**Type:** Array\n\n**Description:** n/a\n\n```cpp\ncolorPressed[] = {1,1,1,1};\n```"},{"heading":"S","level":4,"markdown":""},{"heading":"soundClick","level":5,"markdown":"**Type:** Array\n\n**Description:** n/a\n\n```cpp\nsoundClick[] = {\"\",0.1,1};\n```"},{"heading":"soundEnter","level":5,"markdown":"**Type:** Array\n\n**Description:** n/a\n\n```cpp\nsoundEnter[] = {\"\\A3\\ui_f\\data\\sound\\RscButton\\soundEnter\",0.09,1};\n```"},{"heading":"soundEscape","level":5,"markdown":"**Type:** Array\n\n**Description:** n/a\n\n```cpp\nsoundEscape[] = {\"\\A3\\ui_f\\data\\sound\\RscButton\\soundEscape\",0.09,1};\n```"},{"heading":"soundPush","level":5,"markdown":"**Type:** Array\n\n**Description:** n/a\n\n```cpp\nsoundPush[] = {\"\",0.1,1};\n```"},{"heading":"T","level":4,"markdown":""},{"heading":"textureChecked","level":5,"markdown":"**Type:** String\n\n**Description:** n/a\n\n```cpp\ntextureChecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_checked_ca.paa\";\n```"},{"heading":"textureDisabledChecked","level":5,"markdown":"**Type:** String\n\n**Description:** n/a\n\n```cpp\ntextureDisabledChecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_checked_ca.paa\";\n```"},{"heading":"textureDisabledUnchecked","level":5,"markdown":"**Type:** String\n\n**Description:** n/a\n\n```cpp\ntextureDisabledUnchecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_unchecked_ca.paa\";\n```"},{"heading":"textureFocusedChecked","level":5,"markdown":"**Type:** String\n\n**Description:** n/a\n\n```cpp\ntextureFocusedChecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_checked_ca.paa\";\n```"},{"heading":"textureFocusedUnchecked","level":5,"markdown":"**Type:** String\n\n**Description:** n/a\n\n```cpp\ntextureFocusedUnchecked = \"\\a3\\3DEN\\Data\\Displays\\Display3DEN\\ToolBar\\widget_scaling_off_ca.paa\";\n```"},{"heading":"textureHoverChecked","level":5,"markdown":"**Type:** String\n\n**Description:** n/a\n\n```cpp\ntextureHoverChecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_checked_ca.paa\";\n```"},{"heading":"textureHoverUnchecked","level":5,"markdown":"**Type:** String\n\n**Description:** n/a\n\n```cpp\ntextureHoverUnchecked = \"\\a3\\3DEN\\Data\\Displays\\Display3DEN\\ToolBar\\widget_area_off_ca.paa\";\n```"},{"heading":"texturePressedChecked","level":5,"markdown":"**Type:** String\n\n**Description:** n/a\n\n```cpp\ntexturePressedChecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_checked_ca.paa\";\n```"},{"heading":"texturePressedUnchecked","level":5,"markdown":"**Type:** String\n\n**Description:** n/a\n\n```cpp\ntexturePressedUnchecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_unchecked_ca.paa\";\n```"},{"heading":"textureUnchecked","level":5,"markdown":"**Type:** String\n\n**Description:** n/a\n\n```cpp\ntextureUnchecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_unchecked_ca.paa\";\n```"},{"heading":"Default Classes","level":3,"markdown":"> [!NOTE]\n> **Arma 3:** **AddOns:** Classes need to be initialised first with `class SomeClass;`\n>\n> ---\n>\n> **Missions:** Since Arma 3 v2.02 one can use `import SomeClass;` to initialise a class (see the import keyword).\n>\n> In older versions, use `\"Default\" call BIS_fnc_exportGUIBaseClasses;` and paste the result into the description.ext."},{"heading":"RscCheckbox","level":4,"markdown":"```cpp\nclass RscCheckBox\n{\n    idc = -1;\n    type = CT_CHECKBOX;\n    deletable = 0;\n    style = ST_LEFT;\n    checked = 0;\n    x = \"0.375 * safezoneW + safezoneX\";\n    y = \"0.36 * safezoneH + safezoneY\";\n    w = \"0.025 * safezoneW\";\n    h = \"0.04 * safezoneH\";\n    color[] = {1,1,1,0.7};\n    colorFocused[] = {1,1,1,1};\n    colorHover[] = {1,1,1,1};\n    colorPressed[] = {1,1,1,1};\n    colorDisabled[] = {1,1,1,0.2};\n    colorBackground[] = {0,0,0,0};\n    colorBackgroundFocused[] = {0,0,0,0};\n    colorBackgroundHover[] = {0,0,0,0};\n    colorBackgroundPressed[] = {0,0,0,0};\n    colorBackgroundDisabled[] = {0,0,0,0};\n    textureChecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_checked_ca.paa\";\n    textureUnchecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_unchecked_ca.paa\";\n    textureFocusedChecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_checked_ca.paa\";\n    textureFocusedUnchecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_unchecked_ca.paa\";\n    textureHoverChecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_checked_ca.paa\";\n    textureHoverUnchecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_unchecked_ca.paa\";\n    texturePressedChecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_checked_ca.paa\";\n    texturePressedUnchecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_unchecked_ca.paa\";\n    textureDisabledChecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_checked_ca.paa\";\n    textureDisabledUnchecked = \"A3\\Ui_f\\data\\GUI\\RscCommon\\RscCheckBox\\CheckBox_unchecked_ca.paa\";\n    tooltipColorText[] = {1,1,1,1};\n    tooltipColorBox[] = {1,1,1,1};\n    tooltipColorShade[] = {0,0,0,0.65};\n    soundEnter[] =\n    {\n        \"\",\n        0.1,\n        1\n    };\n    soundPush[] =\n    {\n        \"\",\n        0.1,\n        1\n    };\n    soundClick[] =\n    {\n        \"\",\n        0.1,\n        1\n    };\n    soundEscape[] =\n    {\n        \"\",\n        0.1,\n        1\n    };\n};\n```"}],"categories":["Control Types"],"groups":["GUI"]}