Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

TouchScreenButton¶

Inherits: Node2D < CanvasItem < Node < Object

Button for touch screen devices for gameplay use.

Descripción¶

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.

Propiedades¶

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`

Métodos¶

bool	is_pressed ( ) const

Señales¶

pressed ( )

Se emite cuando se presiona el botón (abajo).

released ( )

Se emite cuando se suelta el botón (arriba).

Enumeraciones¶

enum VisibilityMode:

VISIBILITY_ALWAYS = 0 --- Siempre visible.
VISIBILITY_TOUCHSCREEN_ONLY = 1 --- Visible sólo en las pantallas táctiles.

Descripciones de Propiedades¶

String action

Default	`""`
Setter	set_action(value)
Getter	get_action()

La acción del botón. Las acciones se pueden manejar con InputEventAction.

BitMap bitmask

Setter	set_bitmask(value)
Getter	get_bitmask()

La máscara del botón.

Texture normal

Setter	set_texture(value)
Getter	get_texture()

La textura del botón para el estado normal.

bool passby_press

Default	`false`
Setter	set_passby_press(value)
Getter	is_passby_press_enabled()

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.

Texture pressed

Setter	set_texture_pressed(value)
Getter	get_texture_pressed()

La textura del botón para el estado presionado.

Shape2D shape

Setter	set_shape(value)
Getter	get_shape()

La forma del botón.

bool shape_centered

Default	`true`
Setter	set_shape_centered(value)
Getter	is_shape_centered()

Si true, la forma del botón se centra en la textura proporcionada. Si no se utiliza ninguna textura, esta propiedad no tiene ningún efecto.

bool shape_visible

Default	`true`
Setter	set_shape_visible(value)
Getter	is_shape_visible()

Si true, la forma del botón es visible.

VisibilityMode visibility_mode

Default	`0`
Setter	set_visibility_mode(value)
Getter	get_visibility_mode()

El modo de visibilidad del botón. Vea VisibilityMode para los posibles valores.

Descripciones de Métodos¶

bool is_pressed ( ) const

Devuelve true si este botón está actualmente pulsado.