Up to date

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

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

Введение

В этом уроке вы узнаете, как использовать систему 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

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

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

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

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

extends Node


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

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

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)

InputMаp

The InputMap is the most flexible way to handle a variety of inputs. You use this by creating named input actions, to which you can assign any number of input events, such as keypresses or mouse clicks. To see them, and to add your own, open Project -> Project Settings and select the InputMap tab:

../../_images/inputs_inputmap.webp

Совет

A new Godot project includes a number of default actions already defined. To see them, turn on Show Built-in Actions in the InputMap dialog.

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

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

func _input(event):
    if event.is_action_pressed("my_action"):
        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")

Совет

See @GlobalScope_Key for a list of keycode constants.

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

Due to keyboard ghosting, not all key inputs may be registered at a given time if you press too many keys at once. Due to their location on the keyboard, certain keys are more prone to ghosting than others. Some keyboards feature antighosting at a hardware level, but this feature is generally not present on low-end keyboards and laptop keyboards.

As a result, it's recommended to use a default keyboard layout that is designed to work well on a keyboard without antighosting. See this Gamedev Stack Exchange question for more information.

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

Modifier properties are inherited from InputEventWithModifiers. This allows you to check for modifier combinations using boolean properties. Let's imagine you want one thing to happen when the T is pressed, but something different when it's 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")

Совет

See @GlobalScope_Key for a list of keycode constants.

События мыши

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

Кнопки мыши

Capturing mouse buttons is very similar to handling key events. @GlobalScope_MouseButton contains a list of MOUSE_BUTTON_* constants for each possible button, which will be reported in the event's button_index property. Note that the scrollwheel also counts as a button - two buttons, to be precise, with both MOUSE_BUTTON_WHEEL_UP and MOUSE_BUTTON_WHEEL_DOWN being separate events.

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")

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

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

Here's an example using mouse events to drag-and-drop a Sprite2D node:

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

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

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

Совет

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