Class reference
TouchScreenButton
Inherits Node2D
Button for touch screen devices for gameplay use.
Description
TouchScreenButton allows you to create on-screen buttons for touch devices. It's intended for gameplay use, such as a unit you have to touch to move. Unlike Button, TouchScreenButton supports multitouch out of the box. Several TouchScreenButtons can be pressed at the same time with touch input. This node inherits from Node2D. Unlike with Control nodes, you cannot set anchors on it. If you want to create menus or user interfaces, you may want to use Button nodes instead. To make button nodes react to touch events, you can enable ProjectSettings.input_devices/pointing/emulate_mouse_from_touch in the Project Settings. You can configure TouchScreenButton to be visible only on touch devices, helping you develop your game both for desktop and mobile devices.
Properties
String action = ""
String action = ""The button's action. Actions can be handled with InputEventAction.
BitMap bitmask
BitMap bitmaskThe button's bitmask.
bool passby_press = false
bool passby_press = falseIf true, the pressed and released signals are emitted whenever a pressed finger goes in and out of the button, even if the pressure started outside the active area of the button. Note: This is a "pass-by" (not "bypass") press mode.
Shape2D shape
Shape2D shapeThe button's shape.
bool shape_centered = true
bool shape_centered = trueIf true, the button's shape is centered in the provided texture. If no texture is used, this property has no effect.
bool shape_visible = true
bool shape_visible = trueIf true, the button's shape is visible in the editor.
Texture2D texture_normal
Texture2D texture_normalThe button's texture for the normal state.
Texture2D texture_pressed
Texture2D texture_pressedThe button's texture for the pressed state.
int visibility_mode = 0
int visibility_mode = 0The button's visibility mode.
Methods
bool is_pressed() const
bool is_pressed() constReturns true if this button is currently pressed.
Signals
pressed()
Emitted when the button is pressed (down).
released()
Emitted when the button is released (up).
Constants
VISIBILITY_ALWAYS = 0
Always visible.
VISIBILITY_TOUCHSCREEN_ONLY = 1
Visible on touch screens only.