TouchScreenButton

package

v0.0.0-...-ff35923 Latest Latest Go to latest Published: Sep 16, 2025 License: MIT Imports: 28 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/quaadgras/graphics.gd

Links

Open Source Insights

Documentation ¶

Overview ¶

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 graphics.gd/classdb/Button, TouchScreenButton supports multitouch out of the box. Several TouchScreenButtons can be pressed at the same time with touch input.

This node inherits from graphics.gd/classdb/Node2D. Unlike with graphics.gd/classdb/Control nodes, you cannot set anchors on it. If you want to create menus or user interfaces, you may want to use graphics.gd/classdb/Button nodes instead. To make button nodes react to touch events, you can enable graphics.gd/classdb/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.

Index ¶

type Advanced
type Any
type Extension
type ID
- func (id ID) Instance() (Instance, bool)
type Instance
- func New() Instance
type VisibilityMode

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Advanced ¶

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any ¶

type Any interface {
	gd.IsClass
	AsTouchScreenButton() Instance
}

type Extension ¶

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension

func (*Extension[T]) AsCanvasItem ¶

func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance

func (*Extension[T]) AsNode ¶

func (self *Extension[T]) AsNode() Node.Instance

func (*Extension[T]) AsNode2D ¶

func (self *Extension[T]) AsNode2D() Node2D.Instance

func (*Extension[T]) AsObject ¶

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsTouchScreenButton ¶

func (self *Extension[T]) AsTouchScreenButton() Instance

type ID ¶

type ID Object.ID

ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.

func (ID) Instance ¶

func (id ID) Instance() (Instance, bool)

type Instance ¶

type Instance [1]gdclass.TouchScreenButton

Instance of the class with convieniently typed arguments and results.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New ¶

func New() Instance

func (Instance) Action ¶

func (self Instance) Action() string

func (Instance) AsCanvasItem ¶

func (self Instance) AsCanvasItem() CanvasItem.Instance

func (Instance) AsNode ¶

func (self Instance) AsNode() Node.Instance

func (Instance) AsNode2D ¶

func (self Instance) AsNode2D() Node2D.Instance

func (Instance) AsObject ¶

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsTouchScreenButton ¶

func (self Instance) AsTouchScreenButton() Instance

func (Instance) Bitmask ¶

func (self Instance) Bitmask() BitMap.Instance

func (Instance) ID ¶

func (self Instance) ID() ID

func (Instance) IsPressed ¶

func (self Instance) IsPressed() bool

Returns true if this button is currently pressed.

func (Instance) OnPressed ¶

func (self Instance) OnPressed(cb func(), flags ...Signal.Flags)

func (Instance) OnReleased ¶

func (self Instance) OnReleased(cb func(), flags ...Signal.Flags)

func (Instance) PassbyPress ¶

func (self Instance) PassbyPress() bool

func (Instance) SetAction ¶

func (self Instance) SetAction(value string)

func (Instance) SetBitmask ¶

func (self Instance) SetBitmask(value BitMap.Instance)

func (*Instance) SetObject ¶

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetPassbyPress ¶

func (self Instance) SetPassbyPress(value bool)

func (Instance) SetShape ¶

func (self Instance) SetShape(value Shape2D.Instance)

func (Instance) SetShapeCentered ¶

func (self Instance) SetShapeCentered(value bool)

func (Instance) SetShapeVisible ¶

func (self Instance) SetShapeVisible(value bool)

func (Instance) SetTextureNormal ¶

func (self Instance) SetTextureNormal(value Texture2D.Instance)

func (Instance) SetTexturePressed ¶

func (self Instance) SetTexturePressed(value Texture2D.Instance)

func (Instance) SetVisibilityMode ¶

func (self Instance) SetVisibilityMode(value VisibilityMode)

func (Instance) Shape ¶

func (self Instance) Shape() Shape2D.Instance

func (Instance) ShapeCentered ¶

func (self Instance) ShapeCentered() bool

func (Instance) ShapeVisible ¶

func (self Instance) ShapeVisible() bool

func (Instance) TextureNormal ¶

func (self Instance) TextureNormal() Texture2D.Instance

func (Instance) TexturePressed ¶

func (self Instance) TexturePressed() Texture2D.Instance

func (Instance) Virtual ¶

func (self Instance) Virtual(name string) reflect.Value

func (Instance) VisibilityMode ¶

func (self Instance) VisibilityMode() VisibilityMode

type VisibilityMode ¶

type VisibilityMode int //gd:TouchScreenButton.VisibilityMode

const (
	// Always visible.
	VisibilityAlways VisibilityMode = 0
	// Visible on touch screens only.
	VisibilityTouchscreenOnly VisibilityMode = 1
)

Source Files ¶

View all Source files

class.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL