Class TouchScreenButton

Button for touch screen devices for gameplay use.

Inheritance

Node2D

CanvasItem

Node

Object

TouchScreenButton

Remarks

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 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

action

The button's action. Actions can be handled with InputEventAction.

var action : String = ""

Property Value

String

Remarks

• void set_action(String value)
• String get_action

bitmask

The button's bitmask.

var bitmask : BitMap

Property Value

BitMap

Remarks

• void set_bitmask(BitMap value)
• BitMap get_bitmask

passby_press

If 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.

var passby_press : bool = false

Property Value

bool

Remarks

• void set_passby_press(bool value)
• bool is_passby_press_enabled

shape

The button's shape.

var shape : Shape2D

Property Value

Shape2D

Remarks

• void set_shape(Shape2D value)
• Shape2D get_shape

shape_centered

If true, the button's shape is centered in the provided texture. If no texture is used, this property has no effect.

var shape_centered : bool = true

Property Value

bool

Remarks

• void set_shape_centered(bool value)
• bool is_shape_centered

shape_visible

If true, the button's shape is visible in the editor.

var shape_visible : bool = true

Property Value

bool

Remarks

• void set_shape_visible(bool value)
• bool is_shape_visible

texture_normal

The button's texture for the normal state.

var texture_normal : Texture2D

Property Value

Texture2D

Remarks

• void set_texture_normal(Texture2D value)
• Texture2D get_texture_normal

texture_pressed

The button's texture for the pressed state.

var texture_pressed : Texture2D

Property Value

Texture2D

Remarks

• void set_texture_pressed(Texture2D value)
• Texture2D get_texture_pressed

visibility_mode

The button's visibility mode. See VisibilityMode for possible values.

var visibility_mode : int = 0

Property Value

int

Remarks

• void set_visibility_mode(int value)
• int get_visibility_mode

Methods

is_pressed

Qualifiers: const

Returns true if this button is currently pressed.

bool is_pressed

Events

pressed

Emitted when the button is pressed (down).

signal pressed

released

Emitted when the button is released (up).

signal released