Примеры ввода

Введение

В этом уроке вы узнаете, как использовать систему InputEvent Godot для захвата ввода игрока. Существует множество различных типов ввода, которые может использовать ваша игра - клавиатура, геймпад, мышь и т. д. - и множество различных способов превратить эти входные данные в действия в вашей игре. Этот документ покажет вам некоторые из наиболее распространенных сценариев, которые вы можете использовать в качестве отправной точки для своих собственных проектов.

Примечание

Для получения подробного обзора того, как работает система входных событий Godot, см. Использование InputEvent.

Сравнение событий и опроса

Иногда вы хотите, чтобы ваша игра реагировала на определенное входное событие - например, нажатие кнопки "прыжок". В других ситуациях вы можете захотеть, чтобы что-то происходило, пока нажата клавиша, например движение. В первом случае вы можете использовать функцию _input(), которая будет вызываться всякий раз, когда происходит событие ввода. Во втором случае Godot предоставляет синглтон Input, который можно использовать для запроса состояния ввода.

Примеры:

func _input(event):
    if event.is_action_pressed("jump"):
        jump()


func _physics_process(delta):
    if Input.is_action_pressed("move_right"):
        # Move as long as the key/button is pressed.
        position.x += speed * delta

public override void _Input(InputEvent @event)
{
    if (@event.IsActionPressed("jump"))
    {
        Jump();
    }
}

public override void _PhysicsProcess(double delta)
{
    if (Input.IsActionPressed("move_right"))
    {
        // Move as long as the key/button is pressed.
        position.X += speed * (float)delta;
    }
}

Это дает вам гибкость - возможность смешивать и сочетать типы обработки входных данных, которую вы делаете.

В оставшейся части этого урока мы сосредоточимся на захвате отдельных событий в _input().

Входящие события

События ввода - это объекты, которые наследуются от InputEvent. В зависимости от типа события объект будет содержать определенные свойства, связанные с этим событием. Чтобы увидеть, как на самом деле выглядят события, добавьте Node и прикрепите следующий скрипт:

extends Node


func _input(event):
    print(event.as_text())

using Godot;

public partial class Node : Godot.Node
{
    public override void _Input(InputEvent @event)
    {
        GD.Print(@event.AsText());
    }
}

Когда вы нажимаете клавиши, перемещаете мышь и выполняете другие вводы, вы увидите, как каждое событие прокручивается в окне вывода. Вот пример вывода:

A
Mouse motion at position ((971, 5)) with velocity ((0, 0))
Right Mouse Button
Mouse motion at position ((870, 243)) with velocity ((0.454937, -0.454937))
Left Mouse Button
Mouse Wheel Up
A
B
Shift
Alt+Shift
Alt
Shift+T
Mouse motion at position ((868, 242)) with velocity ((-2.134768, 2.134768))

Как вы можете видеть, результаты очень различны для разных типов входных данных. Ключевые события даже печатаются как их ключевые символы. Например, рассмотрим InputEventMouseButton. Он наследуется от следующих классов:

InputEvent - базовый класс для всех входных событий
InputEventWithModifiers - добавляет возможность проверять, нажаты ли модификаторы, такие как Shift или Alt.
InputEventMouse - добавляет свойства события мыши, такие как position
InputEventMouseButton - содержит индекс кнопки, которая была нажата, был ли это двойной щелчок и т. д.

Совет

Рекомендуется держать ссылку на класс открытой во время работы с событиями, чтобы вы могли проверить доступные свойства и методы типа события.

Вы можете столкнуться с ошибками, если попытаетесь получить доступ к свойству типа ввода, которое его не содержит , например, вызывая position на InputEventKey. Чтобы избежать этого, сначала проверьте тип события:

func _input(event):
    if event is InputEventMouseButton:
        print("mouse button event at ", event.position)

public override void _Input(InputEvent @event)
{
    if (@event is InputEventMouseButton mouseEvent)
    {
        GD.Print("mouse button event at ", mouseEvent.Position);
    }
}

InputMаp

InputMap — это самый гибкий способ обработки различных входных данных. Он используется для создания именованных actions ввода, которым можно назначить любое количество событий ввода, таких как нажатия клавиш или щелчки мыши. Чтобы увидеть их и добавить свои собственные, откройте Project -> Project Settings и выберите вкладку InputMap:

Совет

Новый проект Godot включает ряд уже определённых действий по умолчанию. Чтобы увидеть их, включите Show Built-in Actions в диалоговом окне InputMap.

Захват действий

После того как вы определили свои действия, вы можете обработать их в своих сценариях с помощью is_action_pressed() и is_action_released(), передав имя искомого действия:

func _input(event):
    if event.is_action_pressed("my_action"):
        print("my_action occurred!")

public override void _Input(InputEvent @event)
{
    if (@event.IsActionPressed("my_action"))
    {
        GD.Print("my_action occurred!");
    }
}

События клавиатуры

События клавиатуры фиксируются в InputEventKey. Хотя вместо этого рекомендуется использовать входные действия, могут быть случаи, когда вы хотите специально посмотреть на ключевые события. Например, давайте проверим T:

func _input(event):
    if event is InputEventKey and event.pressed:
        if event.keycode == KEY_T:
            print("T was pressed")

public override void _Input(InputEvent @event)
{
    if (@event is InputEventKey keyEvent && keyEvent.Pressed)
    {
        if (keyEvent.Keycode == Key.T)
        {
            GD.Print("T was pressed");
        }
    }
}

Совет

См. @GlobalScope_Key для получения списка констант кодов клавиш.

Предупреждение

Из-за эффекта фантомного нажатия клавиш не все нажатия клавиш могут быть зарегистрированы одновременно, если вы нажмете слишком много клавиш одновременно. Из-за своего расположения на клавиатуре некоторые клавиши подвержены фантомному срабатыванию чаще, чем другие. Некоторые клавиатуры оснащены аппаратной функцией защиты от фантомных нажатий, но на бюджетных клавиатурах и клавиатурах ноутбуков эта функция, как правило, отсутствует.

В связи с этим рекомендуется использовать раскладку клавиатуры по умолчанию, которая разработана для работы на клавиатуре без функции Anti-Ghosting. См. this Gamedev Stack Exchange question для получения дополнительной информации.

Модификаторы клавиатуры

Свойства модификатора наследуются от InputEventWithModifiers. Это позволяет вам проверять комбинации модификаторов с использованием булевых (boolean) свойств. Давайте представим, что вы хотите, чтобы при нажатии клавиши T происходило одно, а при нажатии клавиши Shift + T— что-то другое:

func _input(event):
    if event is InputEventKey and event.pressed:
        if event.keycode == KEY_T:
            if event.shift_pressed:
                print("Shift+T was pressed")
            else:
                print("T was pressed")

public override void _Input(InputEvent @event)
{
    if (@event is InputEventKey keyEvent && keyEvent.Pressed)
    {
        switch (keyEvent.Keycode)
        {
            case Key.T:
                GD.Print(keyEvent.ShiftPressed ? "Shift+T was pressed" : "T was pressed");
                break;
        }
    }
}

Совет

См. @GlobalScope_Key для получения списка констант кодов клавиш.

События мыши

События мыши происходят из класса InputEventMouse и разделяются на два типа: InputEventMouseButton и InputEventMouseMotion. Обратите внимание, что это означает, что все события мыши будут содержать свойство position.

Кнопки мыши

Захват кнопок мыши очень похож на обработку событий клавиш. @GlobalScope_MouseButton содержит список констант MOUSE_BUTTON_* для каждой возможной кнопки, которые будут указаны в свойстве button_index события. Обратите внимание, что колесо прокрутки также считается кнопкой — точнее, двумя кнопками, причем MOUSE_BUTTON_WHEEL_UP и MOUSE_BUTTON_WHEEL_DOWN являются отдельными событиями.

func _input(event):
    if event is InputEventMouseButton:
        if event.button_index == MOUSE_BUTTON_LEFT and event.pressed:
            print("Left button was clicked at ", event.position)
        if event.button_index == MOUSE_BUTTON_WHEEL_UP and event.pressed:
            print("Wheel up")

public override void _Input(InputEvent @event)
{
    if (@event is InputEventMouseButton mouseEvent && mouseEvent.Pressed)
    {
        switch (mouseEvent.ButtonIndex)
        {
            case MouseButton.Left:
                GD.Print($"Left button was clicked at {mouseEvent.Position}");
                break;
            case MouseButton.WheelUp:
                GD.Print("Wheel up");
                break;
        }
    }
}

Движение мыши

События InputEventMouseMotion происходят всякий раз, когда мышь перемещается. Вы можете найти расстояние перемещения с помощью свойства relative.

Вот пример использования событий мыши для перетаскивания узла Sprite2D:

extends Node


var dragging = false
var click_radius = 32 # Size of the sprite.


func _input(event):
    if event is InputEventMouseButton and event.button_index == MOUSE_BUTTON_LEFT:
        if (event.position - $Sprite2D.position).length() < click_radius:
            # Start dragging if the click is on the sprite.
            if not dragging and event.pressed:
                dragging = true
        # Stop dragging if the button is released.
        if dragging and not event.pressed:
            dragging = false

    if event is InputEventMouseMotion and dragging:
        # While dragging, move the sprite with the mouse.
        $Sprite2D.position = event.position

using Godot;

public partial class MyNode2D : Node2D
{
    private bool _dragging = false;
    private int _clickRadius = 32; // Size of the sprite.

    public override void _Input(InputEvent @event)
    {
        Sprite2D sprite = GetNodeOrNull<Sprite2D>("Sprite2D");
        if (sprite == null)
        {
            return; // No suitable node was found.
        }

        if (@event is InputEventMouseButton mouseEvent && mouseEvent.ButtonIndex == MouseButton.Left)
        {
            if ((mouseEvent.Position - sprite.Position).Length() < _clickRadius)
            {
                // Start dragging if the click is on the sprite.
                if (!_dragging && mouseEvent.Pressed)
                {
                    _dragging = true;
                }
            }
            // Stop dragging if the button is released.
            if (_dragging && !mouseEvent.Pressed)
            {
                _dragging = false;
            }
        }
        else
        {
            if (@event is InputEventMouseMotion motionEvent && _dragging)
            {
                // While dragging, move the sprite with the mouse.
                sprite.Position = motionEvent.Position;
            }
        }
    }
}

Сенсорные события

Если вы используете устройство с сенсорным экраном, вы можете генерировать сенсорные события. InputEventScreenTouch эквивалентно событию щелчка мыши, а InputEventScreenDrag работает почти так же, как движение мыши.

Совет

Чтобы протестировать сенсорные события на устройстве без сенсорного экрана, откройте Project Settings и перейдите в раздел "Input Devices/Pointing". Включите функцию "Emulate Touch From Mouse", и ваш проект будет интерпретировать щелчки мыши и движение как сенсорные события.