Class CheckButton
A Button with two additional states: checked and unchecked.
This region works exactly like a classic Button, but is has two additional special textures for the check sign.
Inherits all methods from: Region, Frame, Button.
Child classes: none.
Methods
| checkbutton:is_checked() | Checks if this CheckButton is checked. |
| checkbutton:get_checked_texture() | Returns this button's checked texture. |
| checkbutton:get_disabled_checked_texture() | Returns this button's disabled checked texture. |
| checkbutton:set_checked(is_checked) | Check or uncheck the button. |
| checkbutton:set_checked() | Checks the button. |
| checkbutton:set_checked_texture(tex) | Sets this button's checked texture. |
| checkbutton:set_disabled_checked_texture(tex) | Sets this button's disabled checked texture. |
Methods
- checkbutton:is_checked()
-
Checks if this CheckButton is checked.
Returns:
-
boolean
'true' if checked, 'false' otherwise
- checkbutton:get_checked_texture()
-
Returns this button's checked texture.
Returns:
-
Texture
This button's checked texture
- checkbutton:get_disabled_checked_texture()
-
Returns this button's disabled checked texture.
Returns:
-
Texture
This button's disabled checked texture
- checkbutton:set_checked(is_checked)
-
Check or uncheck the button.
Parameters:
- is_checked boolean 'true' to check, 'false' to uncheck (if nil or missing, equivalent to 'true')
- checkbutton:set_checked()
- Checks the button.
- checkbutton:set_checked_texture(tex)
-
Sets this button's checked texture.
Parameters:
- tex Texture The new texture
- checkbutton:set_disabled_checked_texture(tex)
-
Sets this button's disabled checked texture.
Parameters:
- tex Texture The new texture