Shortcut

Inherits: Resource < RefCounted < Object

A shortcut for binding input.

Description

Shortcuts (also known as hotkeys) are containers of InputEvent resources. They are commonly used to interact with a Control element from an InputEvent.

One shortcut can contain multiple InputEvent resources, making it possible to trigger one action with multiple different inputs.

Example: Capture the Ctrl + S shortcut using a Shortcut resource:

Properties

Array

events

[]

Methods

String	get_as_text() const
bool	has_valid_event() const
bool	matches_event(event: InputEvent) const

---

Property Descriptions

Array events = [] 🔗

• void set_events(value: Array)

• Array get_events()

The shortcut’s InputEvent array.

Generally the InputEvent used is an InputEventKey, though it can be any InputEvent, including an InputEventAction.

---

Method Descriptions

String get_as_text() const 🔗

Returns the shortcut’s first valid InputEvent as a String.

---

bool has_valid_event() const 🔗

Returns whether events contains an InputEvent which is valid.

---

bool matches_event(event: InputEvent) const 🔗

Returns whether any InputEvent in events equals event. This uses InputEvent.is_match() to compare events.