Class reference
CheckButton
Inherits Button
A button that represents a binary choice.
Description
CheckButton is a toggle button displayed as a check field. It's similar to CheckBox in functionality, but it has a different appearance. To follow established UX patterns, it's recommended to use CheckButton when toggling it has an immediate effect on something. For example, it can be used when pressing it shows or hides advanced settings, without asking the user to confirm this action. See also BaseButton which contains common properties and methods associated with this node.
Properties
Theme properties
Color button_checked_color = Color(1, 1, 1, 1)
Color button_checked_color = Color(1, 1, 1, 1)The color of the checked icon when the checkbox is pressed.
Color button_unchecked_color = Color(1, 1, 1, 1)
Color button_unchecked_color = Color(1, 1, 1, 1)The color of the unchecked icon when the checkbox is not pressed.
int check_v_offset = 0
int check_v_offset = 0The vertical offset used when rendering the toggle icons (in pixels).
Texture2D checked
Texture2D checkedThe icon to display when the CheckButton is checked (for left-to-right layouts).
Texture2D checked_disabled
Texture2D checked_disabledThe icon to display when the CheckButton is checked and disabled (for left-to-right layouts).
Texture2D checked_disabled_mirrored
Texture2D checked_disabled_mirroredThe icon to display when the CheckButton is checked and disabled (for right-to-left layouts).
Texture2D checked_mirrored
Texture2D checked_mirroredThe icon to display when the CheckButton is checked (for right-to-left layouts).
Texture2D unchecked
Texture2D uncheckedThe icon to display when the CheckButton is unchecked (for left-to-right layouts).
Texture2D unchecked_disabled
Texture2D unchecked_disabledThe icon to display when the CheckButton is unchecked and disabled (for left-to-right layouts).
Texture2D unchecked_disabled_mirrored
Texture2D unchecked_disabled_mirroredThe icon to display when the CheckButton is unchecked and disabled (for right-to-left layouts).
Texture2D unchecked_mirrored
Texture2D unchecked_mirroredThe icon to display when the CheckButton is unchecked (for right-to-left layouts).