Inheritance #
- AudioServer
- CameraServer
- ClassDB
- DisplayServer
- EditorFileSystemDirectory
- EditorInterface
- EditorPaths
- EditorSelection
- EditorUndoRedoManager
- EditorVCSInterface
- Engine
- EngineDebugger
- FramebufferCacheRD
- GDExtensionManager
- Geometry2D
- Geometry3D
- IP
- Input
- InputMap
- JNISingleton
- JSONRPC
- JavaClassWrapper
- JavaScriptBridge
- MainLoop (1)
- Marshalls
- MovieWriter
- NativeMenu
- NavigationMeshGenerator
- NavigationServer2D
- NavigationServer3D
- Node (21)
- OS
- OpenXRExtensionWrapperExtension
- OpenXRInteractionProfileMetadata
- Performance
- PhysicsDirectBodyState2D (1)
- PhysicsDirectBodyState3D (1)
- PhysicsDirectSpaceState2D (1)
- PhysicsDirectSpaceState3D (1)
- PhysicsServer2D (1)
- PhysicsServer2DManager
- PhysicsServer3D (1)
- PhysicsServer3DManager
- PhysicsServer3DRendering
ServerHandler
- ProjectSettings
- RefCounted (121)
- RenderData (2)
- RenderSceneData (2)
- RenderingDevice
- RenderingServer
- ResourceLoader
- ResourceSaver
- ResourceUID
- ScriptLanguage (1)
- ShaderIncludeDB
- TextServerManager
- ThemeDB
- TileData
- Time
- TranslationServer
- TreeItem
- UndoRedo
- UniformSetCacheRD
- WorkerThreadPool
- XRServer
- XRVRS
- AnimationMixer (2)
- AudioStreamPlayer
- CanvasItem (2)
- CanvasLayer (1)
- EditorFileSystem
- EditorPlugin (1)
- EditorResourcePreview
- HTTPRequest
- InstancePlaceholder
- MissingNode
- MultiplayerSpawner
- MultiplayerSynchronizer
- NavigationAgent2D
- NavigationAgent3D
- Node3D (31)
- ResourcePreloader
- ShaderGlobalsOverride
- StatusIndicator
- Timer
- Viewport (2)
- WorldEnvironment
- AnimatedSprite2D
- AudioListener2D
- AudioStreamPlayer2D
- BackBufferCopy
- Bone2D
- CPUParticles2D
- Camera2D
- CanvasGroup
- CanvasModulate
- CollisionObject2D (2)
- CollisionPolygon2D
- CollisionShape2D
- GPUParticles2D
- Joint2D (3)
- Light2D (2)
- LightOccluder2D
- Line2D
- Marker2D
- MeshInstance2D
- MultiMeshInstance2D
- NavigationLink2D
- NavigationObstacle2D
- NavigationRegion2D
- Parallax2D
- ParallaxLayer
- Path2D
- PathFollow2D
- Polygon2D
- RayCast2D
- RemoteTransform2D
- ShapeCast2D
- Skeleton2D
- Sprite2D
- TileMap
- TileMapLayer
- TouchScreenButton
- VisibleOnScreenNotifier2D (1)
Table of contents
-
var action: String = "" -
var bitmask: BitMap -
var passby_press: bool = false -
var shape: Shape2D -
var shape_centered: bool = true -
var shape_visible: bool = true -
var texture_normal: Texture2D -
var texture_pressed: Texture2D -
var visibility_mode = VISIBILITY_ALWAYS -
const func is_pressed() -> bool -
const VISIBILITY_ALWAYS = 0 enum VisibilityMode -
const VISIBILITY_TOUCHSCREEN_ONLY = 1 enum VisibilityMode -
enum VisibilityMode -
signal pressed() -
signal released()
TouchScreenButton #
is_instantiable, Node2D, Node, core, not_builtin_classes
Button for touch screen devices for gameplay use.
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 ProjectSettings.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.
Members #
var action: String = ""#
The button's action. Actions can be handled with InputEventAction.
var bitmask: BitMap#
The button's bitmask.
var passby_press: bool = false#
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 shape: Shape2D#
The button's shape.
var shape_centered: bool = true#
If true, the button's shape is centered in the provided texture. If no texture is used, this property has no effect.
var shape_visible: bool = true#
If true, the button's shape is visible in the editor.
var texture_normal: Texture2D#
The button's texture for the normal state.
var texture_pressed: Texture2D#
The button's texture for the pressed state.
var visibility_mode = VISIBILITY_ALWAYS#
The button's visibility mode. See VisibilityMode for possible values.
Methods #
const func is_pressed() -> bool#
Returns true if this button is currently pressed.
Annotations #
Constants #
const VISIBILITY_ALWAYS = 0 enum VisibilityMode#
Always visible.
const VISIBILITY_TOUCHSCREEN_ONLY = 1 enum VisibilityMode#
Visible on touch screens only.
Constructors #
Enums #
VisibilityMode#
enum VisibilityMode {
VISIBILITY_ALWAYS = 0,
VISIBILITY_TOUCHSCREEN_ONLY = 1,
} Operators #
Signals #
signal pressed()#
Emitted when the button is pressed (down).
signal released()#
Emitted when the button is released (up).