Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

Shortcut

Hérite de : Resource < RefCounted < Object

Un raccourci lié à une entrée.

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:

extends Node

var save_shortcut = Shortcut.new()
func _ready():
    var key_event = InputEventKey.new()
    key_event.keycode = KEY_S
    key_event.ctrl_pressed = true
    key_event.command_or_control_autoremap = true # Swaps Ctrl for Command on Mac.
    save_shortcut.events = [key_event]

func _input(event):
    if save_shortcut.matches_event(event) and event.is_pressed() and not event.is_echo():
        print("Save shortcut pressed!")
        get_viewport().set_input_as_handled()

using Godot;

public partial class MyNode : Node
{
    private readonly Shortcut _saveShortcut = new Shortcut();

    public override void _Ready()
    {
        InputEventKey keyEvent = new InputEventKey
        {
            Keycode = Key.S,
            CtrlPressed = true,
            CommandOrControlAutoremap = true, // Swaps Ctrl for Command on Mac.
        };

        _saveShortcut.Events = [keyEvent];
    }

    public override void _Input(InputEvent @event)
    {
        if (@event is InputEventKey keyEvent &&
            _saveShortcut.MatchesEvent(@event) &&
            keyEvent.Pressed && !keyEvent.Echo)
        {
            GD.Print("Save shortcut pressed!");
            GetViewport().SetInputAsHandled();
        }
    }
}

Propriétés

Array

events

[]

Méthodes

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

Descriptions des propriétés

Array events = [] 🔗

void set_events(value: Array)
Array get_events()

Le tableau d'InputEvents du raccourci.

En général, InputEvent utilisé est un InputEventKey, bien qu'il puisse être n'importe quel InputEvent, y compris un InputEventAction.

Descriptions des méthodes

String get_as_text() const 🔗

Renvoie le premier InputEvent valide du raccourci en tant que String.

bool has_valid_event() const 🔗

Renvoie si events contient un InputEvent qui est valide.

bool matches_event(event: InputEvent) const 🔗

Renvoie si au moins un InputEvent dans events est égal à event. Cela utilise InputEvent.is_match() pour comparer les événements.