Table of Contents

Class CheckButton

A button that represents a binary choice.

Inheritance
CheckButton

Remarks

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

check_v_offset

Theme Property

The vertical offset used when rendering the toggle icons (in pixels).

 = ``0``

Property Value

int

checked

Theme Property

The icon to display when the CheckButton is checked (for left-to-right layouts).

Texture2D checked

Property Value

Texture2D

checked_disabled

Theme Property

The icon to display when the CheckButton is checked and disabled (for left-to-right layouts).

Texture2D checked_disabled

Property Value

Texture2D

checked_disabled_mirrored

Theme Property

The icon to display when the CheckButton is checked and disabled (for right-to-left layouts).

Texture2D checked_disabled_mirrored

Property Value

Texture2D

checked_mirrored

Theme Property

The icon to display when the CheckButton is checked (for right-to-left layouts).

Texture2D checked_mirrored

Property Value

Texture2D

unchecked

Theme Property

The icon to display when the CheckButton is unchecked (for left-to-right layouts).

Texture2D unchecked

Property Value

Texture2D

unchecked_disabled

Theme Property

The icon to display when the CheckButton is unchecked and disabled (for left-to-right layouts).

Texture2D unchecked_disabled

Property Value

Texture2D

unchecked_disabled_mirrored

Theme Property

The icon to display when the CheckButton is unchecked and disabled (for right-to-left layouts).

Texture2D unchecked_disabled_mirrored

Property Value

Texture2D

unchecked_mirrored

Theme Property

The icon to display when the CheckButton is unchecked (for right-to-left layouts).

Texture2D unchecked_mirrored

Property Value

Texture2D