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.

Methods

boolis_pressed ( ) const

Signals

  • pressed ( )

Emitted when the button is pressed (down).


  • released ( )

Emitted when the button is released (up).

Enumerations

enum VisibilityMode:

  • VISIBILITY_ALWAYS = 0 — Always visible.
  • VISIBILITY_TOUCHSCREEN_ONLY = 1 — Visible on touch screens only.

Property Descriptions

Default""
Setterset_action(value)
Getterget_action()

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


Setterset_bitmask(value)
Getterget_bitmask()

The button’s bitmask.


Setterset_texture(value)
Getterget_texture()

The button’s texture for the normal state.


Defaultfalse
Setterset_passby_press(value)
Getteris_passby_press_enabled()

If true, pass-by presses are enabled.


Setterset_texture_pressed(value)
Getterget_texture_pressed()

The button’s texture for the pressed state.


Setterset_shape(value)
Getterget_shape()

The button’s shape.


Defaulttrue
Setterset_shape_centered(value)
Getteris_shape_centered()

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


Defaulttrue
Setterset_shape_visible(value)
Getteris_shape_visible()

If true, the button’s shape is visible.


Default0
Setterset_visibility_mode(value)
Getterget_visibility_mode()

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

Method Descriptions

  • bool is_pressed ( ) const

Returns true if this button is currently pressed.

doradoro's advice! Getters and Setters will be deprecated! Avoid their use!

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 2020-03-07 at 01:42:24. It's the English Stable version because it's what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.