Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

TouchScreenButton

Inherits: Node2D < CanvasItem < Node < Object

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 the Emulate Mouse option 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

""

BitMap

bitmask

bool

passby_press

false

Shape2D

shape

bool

shape_centered

true

bool

shape_visible

true

Texture2D

texture_normal

Texture2D

texture_pressed

VisibilityMode

visibility_mode

0

Methods

bool

is_pressed ( ) const


Signals

pressed ( )

Emitted when the button is pressed (down).


released ( )

Emitted when the button is released (up).