Files
godot-docs-l10n/classes/ru/class_inputeventaction.rst

132 lines
7.7 KiB
ReStructuredText
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

:github_url: hide
.. _class_InputEventAction:
InputEventAction
================
**Наследует:** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
Тип входного события для действий.
.. rst-class:: classref-introduction-group
Описание
----------------
Содержит общее действие, которое может быть направлено из нескольких типов входов. Действия и их события можно задать на вкладке **Input Map** в **Project > Project Settings** или с помощью класса :ref:`InputMap<class_InputMap>`.
\ **Примечание:** В отличие от других подклассов :ref:`InputEvent<class_InputEvent>`, которые сопоставляются с уникальными физическими событиями, этот виртуальный не выдается движком. Этот класс полезен для ручной отправки действий с помощью :ref:`Input.parse_input_event()<class_Input_method_parse_input_event>`, которые затем принимаются в :ref:`Node._input()<class_Node_private_method__input>`. Чтобы проверить, соответствует ли физическое событие действию из Input Map, используйте :ref:`InputEvent.is_action()<class_InputEvent_method_is_action>` и :ref:`InputEvent.is_action_pressed()<class_InputEvent_method_is_action_pressed>`.
.. rst-class:: classref-introduction-group
Обучающие материалы
--------------------------------------
- `Использование InputEvent: Действия <../tutorials/inputs/inputevent.html#actions>`__
- `2D Dodge The Creeps Демо <https://godotengine.org/asset-library/asset/2712>`__
- `Демоверсия 3D вокселей <https://godotengine.org/asset-library/asset/2755>`__
.. rst-class:: classref-reftable-group
Свойства
----------------
.. table::
:widths: auto
+-------------------------------------+-----------------------------------------------------------------+-----------+
| :ref:`StringName<class_StringName>` | :ref:`action<class_InputEventAction_property_action>` | ``&""`` |
+-------------------------------------+-----------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`event_index<class_InputEventAction_property_event_index>` | ``-1`` |
+-------------------------------------+-----------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`pressed<class_InputEventAction_property_pressed>` | ``false`` |
+-------------------------------------+-----------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`strength<class_InputEventAction_property_strength>` | ``1.0`` |
+-------------------------------------+-----------------------------------------------------------------+-----------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Описания свойств
--------------------------------
.. _class_InputEventAction_property_action:
.. rst-class:: classref-property
:ref:`StringName<class_StringName>` **action** = ``&""`` :ref:`🔗<class_InputEventAction_property_action>`
.. rst-class:: classref-property-setget
- |void| **set_action**\ (\ value\: :ref:`StringName<class_StringName>`\ )
- :ref:`StringName<class_StringName>` **get_action**\ (\ )
Имя действия. Обычно это название существующего действия в ``Inputmap``, которое вы хотите, чтобы это пользовательское событие соответствовало.
.. rst-class:: classref-item-separator
----
.. _class_InputEventAction_property_event_index:
.. rst-class:: classref-property
:ref:`int<class_int>` **event_index** = ``-1`` :ref:`🔗<class_InputEventAction_property_event_index>`
.. rst-class:: classref-property-setget
- |void| **set_event_index**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_event_index**\ (\ )
Реальный индекс события в действии, которому соответствует это событие (из событий, определенных для этого действия в :ref:`InputMap<class_InputMap>`). Если ``-1``, будет использоваться уникальный идентификатор, и действия, нажатые с этим идентификатором, необходимо будет отпустить с помощью другого **InputEventAction**.
.. rst-class:: classref-item-separator
----
.. _class_InputEventAction_property_pressed:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **pressed** = ``false`` :ref:`🔗<class_InputEventAction_property_pressed>`
.. rst-class:: classref-property-setget
- |void| **set_pressed**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_pressed**\ (\ )
Если ``true``, состояние действия нажато. Если ``false``, состояние действия отпущено.
.. rst-class:: classref-item-separator
----
.. _class_InputEventAction_property_strength:
.. rst-class:: classref-property
:ref:`float<class_float>` **strength** = ``1.0`` :ref:`🔗<class_InputEventAction_property_strength>`
.. rst-class:: classref-property-setget
- |void| **set_strength**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_strength**\ (\ )
Сила действия от 0 до 1. Это значение считается равным 0, если нажатие равно ``false``. Сила события позволяет имитировать события движения аналогового джойстика, указывая, насколько сильно ось джойстика сгибается или нажимается.
.. |virtual| replace:: :abbr:`virtual (Этот метод обычно должен быть переопределен пользователем, чтобы иметь какой-либо эффект.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |const| replace:: :abbr:`const (Этот метод не имеет побочных эффектов. Он не изменяет ни одну из переменных-членов экземпляра.)`
.. |vararg| replace:: :abbr:`vararg (Этот метод принимает любое количество аргументов после описанных здесь.)`
.. |constructor| replace:: :abbr:`constructor (Этот метод используется для создания типа.)`
.. |static| replace:: :abbr:`static (Этот метод не нуждается в вызове экземпляра, поэтому его можно вызвать напрямую, используя имя класса.)`
.. |operator| replace:: :abbr:`operator (Этот метод описывает допустимый оператор для использования с этим типом в качестве левого операнда.)`
.. |bitfield| replace:: :abbr:`BitField (Это значение является целым числом, составленным как битовая маска следующих флагов.)`
.. |void| replace:: :abbr:`void (Нет возвращаемого значения.)`