TouchScreenButton

TouchScreenButton

Inherits: Node2D < CanvasItem < Node < Object

Category: Core

Brief Description

Button for touch screen devices.

Properties

String	action
BitMap	bitmask
Texture	normal
bool	passby_press
Texture	pressed
Shape2D	shape
bool	shape_centered
bool	shape_visible
VisibilityMode	visibility_mode

Methods

bool	is_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.

Description

Button for touch screen devices. You can set it to be visible on all screens, or only on touch devices.

Property Descriptions

String action

Setter	set_action(value)
Getter	get_action()

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

BitMap bitmask

Setter	set_bitmask(value)
Getter	get_bitmask()

The button’s bitmask.

Texture normal

Setter	set_texture(value)
Getter	get_texture()

The button’s texture for the normal state.

bool passby_press

Setter	set_passby_press(value)
Getter	is_passby_press_enabled()

If true, passby presses are enabled.

Texture pressed

Setter	set_texture_pressed(value)
Getter	get_texture_pressed()

The button’s texture for the pressed state.

Shape2D shape

Setter	set_shape(value)
Getter	get_shape()

The button’s shape.

bool shape_centered

Setter	set_shape_centered(value)
Getter	is_shape_centered()

If true, the button’s shape is centered.

bool shape_visible

Setter	set_shape_visible(value)
Getter	is_shape_visible()

If true, the button’s shape is visible.

VisibilityMode visibility_mode

Setter	set_visibility_mode(value)
Getter	get_visibility_mode()

The button’s visibility mode. See VISIBILITY_* constants.

Method Descriptions

bool is_pressed ( ) const

Returns true if this button is currently pressed.