Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
CheckBox
Inherits: Button < BaseButton < Control < CanvasItem < Node < Object
A button that represents a binary choice.
Description
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 no 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 BaseButton.button_group specifies a ButtonGroup, CheckBox changes its appearance to that of a radio button and uses the various radio_*
theme properties.
Properties
alignment |
|
|
toggle_mode |
|
Theme Properties
|
||
|
||
|
||
Theme Property Descriptions
Color checkbox_checked_color = Color(1, 1, 1, 1)
🔗
The color of the checked icon when the checkbox is pressed.
Color checkbox_unchecked_color = Color(1, 1, 1, 1)
🔗
The color of the unchecked icon when the checkbox is not pressed.
The vertical offset used when rendering the check icons (in pixels).
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.
Texture2D radio_checked_disabled 🔗
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.
Texture2D radio_unchecked_disabled 🔗
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.
Texture2D unchecked_disabled 🔗
The check icon to display when the CheckBox is unchecked and is disabled.