A button that represents a binary choice.
[CheckBox] allows the user to choose one of only two possible options. It's similar to [CheckButton] in functionality, but it has a different appearance. To follow established UX patterns, it's recommended to use [CheckBox] when toggling it has [b]no[/b] immediate effect on something. For example, it could be used when toggling it will only do something once a confirmation button is pressed.
See also [BaseButton] which contains common properties and methods associated with this node.
When [member BaseButton.button_group] specifies a [ButtonGroup], [CheckBox] changes its appearance to that of a radio button and uses the various [code]radio_*[/code] theme properties.
The [CheckBox] text's font color.
The [CheckBox] text's font color when it's disabled.
The [CheckBox] text's font color when it's focused. Only replaces the normal text color of the checkbox. Disabled, hovered, and pressed states take precedence over this color.
The [CheckBox] text's font color when it's hovered.
The [CheckBox] text's font color when it's hovered and pressed.
The tint of text outline of the [CheckBox].
The [CheckBox] text's font color when it's pressed.
The vertical offset used when rendering the check icons (in pixels).
The separation between the check icon and the text (in pixels). Negative values will be treated as [code]0[/code] when used.
The size of the text outline.
[b]Note:[/b] If using a font with [member FontFile.multichannel_signed_distance_field] enabled, its [member FontFile.msdf_pixel_range] must be set to at least [i]twice[/i] the value of [theme_item outline_size] for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.
The [Font] to use for the [CheckBox] text.
Font size of the [CheckBox]'s text.
The check icon to display when the [CheckBox] is checked.
The check icon to display when the [CheckBox] is checked and is disabled.
The check icon to display when the [CheckBox] is configured as a radio button and is checked.
The check icon to display when the [CheckBox] is configured as a radio button, is disabled, and is unchecked.
The check icon to display when the [CheckBox] is configured as a radio button and is unchecked.
The check icon to display when the [CheckBox] is configured as a radio button, is disabled, and is unchecked.
The check icon to display when the [CheckBox] is unchecked.
The check icon to display when the [CheckBox] is unchecked and is disabled.
The [StyleBox] to display as a background when the [CheckBox] is disabled.
The [StyleBox] to display as a background when the [CheckBox] is focused. The [code]focus[/code] [StyleBox] is displayed [i]over[/i] the base [StyleBox], so a partially transparent [StyleBox] should be used to ensure the base [StyleBox] remains visible. A [StyleBox] that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a [StyleBoxEmpty] resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.
The [StyleBox] to display as a background when the [CheckBox] is hovered.
The [StyleBox] to display as a background when the [CheckBox] is hovered and pressed.
The [StyleBox] to display as a background.
The [StyleBox] to display as a background when the [CheckBox] is pressed.