Shortcut

package
v0.0.0-...-c858641 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 14, 2025 License: MIT Imports: 24 Imported by: 0

Documentation

Overview

Shortcuts are commonly used for interacting with a graphics.gd/classdb/Control element from an graphics.gd/classdb/InputEvent (also known as hotkeys).

One shortcut can contain multiple [graphics.gd/classdb/InputEvent]s, allowing the possibility of triggering one action with multiple different inputs.

Index

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
	AsShortcut() 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]) AsObject

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

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

func (*Extension[T]) AsResource

func (self *Extension[T]) AsResource() Resource.Instance

func (*Extension[T]) AsShortcut

func (self *Extension[T]) AsShortcut() 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.Shortcut

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) AsObject

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

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsResource

func (self Instance) AsResource() Resource.Instance

func (Instance) AsShortcut

func (self Instance) AsShortcut() Instance

func (Instance) Events

func (self Instance) Events() []any

func (Instance) GetAsText

func (self Instance) GetAsText() string

Returns the shortcut's first valid graphics.gd/classdb/InputEvent as a string.

func (Instance) HasValidEvent

func (self Instance) HasValidEvent() bool

Returns whether Instance.Events contains an graphics.gd/classdb/InputEvent which is valid.

func (Instance) ID

func (self Instance) ID() ID

func (Instance) MatchesEvent

func (self Instance) MatchesEvent(event InputEvent.Instance) bool

Returns whether any graphics.gd/classdb/InputEvent in Instance.Events equals 'event'. This uses graphics.gd/classdb/InputEvent.Instance.IsMatch to compare events.

func (Instance) SetEvents

func (self Instance) SetEvents(value []any)

func (*Instance) SetObject

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

func (Instance) Virtual

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

Jump to

Keyboard shortcuts

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