Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

Shortcut

Inherits: Resource < RefCounted < Object

A shortcut for binding input.

Description

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

One shortcut can contain multiple InputEvent's, allowing the possibility of triggering one action with multiple different inputs.

Properties

Array

events

[]

Methods

String

get_as_text ( ) const

bool

has_valid_event ( ) const

bool

matches_event ( InputEvent event ) const


Property Descriptions

Array events = []

  • void set_events ( Array value )

  • 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.