Checkbox Widgets let you add simple binary options to your UI.

The Widget consists of a box and some accompanying text. In the options, you’ll see the standard font, color, and size options for the text. The size of the box is not directly configurable, but it will automatically grow or shrink at certain text sizes.

The “Start Checked” option determines if this box is checked or not by default when the UI is instantiated.

The controls below that allow you to change the color of the box in its unchecked (Regular) and checked states, as well as when it is moused over in each of those situations.

Scripting a Checkbox

To check whether a checkbox is checked in a script, use the “.isChecked,” as shown in the following example:

For more info, see Adding Scripts to UI.