TouchScreenButton¶
Inherits: Node2D < CanvasItem < Node < Object
Button for touch screen devices.
Description¶
Button for touch screen devices. You can set it to be visible on all screens, or only on touch devices.
Properties¶
| String | action | "" |
| BitMap | bitmask | |
| Texture | normal | |
| bool | passby_press | false |
| Texture | pressed | |
| Shape2D | shape | |
| bool | shape_centered | true |
| bool | shape_visible | true |
| VisibilityMode | visibility_mode | 0 |
Methods¶
| bool | is_pressed ( ) const |
Enumerations¶
Property Descriptions¶
- String action
| Default | "" |
| Setter | set_action(value) |
| Getter | get_action() |
The button’s action. Actions can be handled with InputEventAction.
- BitMap bitmask
| Setter | set_bitmask(value) |
| Getter | get_bitmask() |
The button’s bitmask.
- Texture normal
| Setter | set_texture(value) |
| Getter | get_texture() |
The button’s texture for the normal state.
- bool passby_press
| Default | false |
| Setter | set_passby_press(value) |
| Getter | is_passby_press_enabled() |
If true, pass-by presses are enabled.
- Texture pressed
| Setter | set_texture_pressed(value) |
| Getter | get_texture_pressed() |
The button’s texture for the pressed state.
- Shape2D shape
| Setter | set_shape(value) |
| Getter | get_shape() |
The button’s shape.
- bool shape_centered
| Default | true |
| Setter | set_shape_centered(value) |
| Getter | is_shape_centered() |
If true, the button’s shape is centered in the provided texture. If no texture is used, this property has no effect.
- bool shape_visible
| Default | true |
| Setter | set_shape_visible(value) |
| Getter | is_shape_visible() |
If true, the button’s shape is visible.
- VisibilityMode visibility_mode
| Default | 0 |
| Setter | set_visibility_mode(value) |
| Getter | get_visibility_mode() |
The button’s visibility mode. See VisibilityMode for possible values.