W3cubDocs

/Godot 4.2

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.

bool matches_event ( InputEvent event ) const

Returns whether any InputEvent in events equals event.

© 2014–present Juan Linietsky, Ariel Manzur and the Godot community
Licensed under the Creative Commons Attribution Unported License v3.0.
https://docs.godotengine.org/en/4.2/classes/class_shortcut.html