CheckButton

On/off switch with ToggleMode enabled.

1.0.0

class CheckButtonReckfellSharpInherits Button

Creates a toggle button with switch visuals and left-aligned text. For an on/off setting use ButtonPressed and Toggled(bool) rather than ButtonDown/ButtonUp. Visuals differ, but Disabled, SetPressedNoSignal and ButtonGroup retain BaseButton semantics.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

CheckButtonConstructor

# CheckButton

C#
public CheckButton();

Creates a switch with ToggleMode = true and left-aligned text. Uses shared BaseButton rules.

Theme properties

These are Theme resource keys, not C# properties. Use the matching Control GetTheme…() and AddTheme…Override() methods for each value type.

Key and type	Description
`button_checked_color` `Color`	The color of the checked icon when the checkbox is pressed. Default: `Color(1, 1, 1, 1)`
`button_unchecked_color` `Color`	The color of the unchecked icon when the checkbox is not pressed. Default: `Color(1, 1, 1, 1)`
`check_v_offset` `int`	The vertical offset used when rendering the toggle icons (in pixels). Default: `0`
`checked` `Texture2D`	The icon to display when the `CheckButton` is checked (for left-to-right layouts).
`checked_disabled` `Texture2D`	The icon to display when the `CheckButton` is checked and disabled (for left-to-right layouts).
`checked_disabled_mirrored` `Texture2D`	The icon to display when the `CheckButton` is checked and disabled (for right-to-left layouts).
`checked_mirrored` `Texture2D`	The icon to display when the `CheckButton` is checked (for right-to-left layouts).
`unchecked` `Texture2D`	The icon to display when the `CheckButton` is unchecked (for left-to-right layouts).
`unchecked_disabled` `Texture2D`	The icon to display when the `CheckButton` is unchecked and disabled (for left-to-right layouts).
`unchecked_disabled_mirrored` `Texture2D`	The icon to display when the `CheckButton` is unchecked and disabled (for right-to-left layouts).
`unchecked_mirrored` `Texture2D`	The icon to display when the `CheckButton` is unchecked (for right-to-left layouts).

Reckfell Engine documentationBack to top ↑