mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
65 lines
2.1 KiB
ReStructuredText
65 lines
2.1 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the InputEventAction.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_InputEventAction:
|
|
|
|
InputEventAction
|
|
================
|
|
|
|
**Inherits:** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Input event type for actions.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-----------------------------+---------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`action<class_InputEventAction_property_action>` |
|
|
+-----------------------------+---------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`pressed<class_InputEventAction_property_pressed>` |
|
|
+-----------------------------+---------------------------------------------------------+
|
|
|
|
Description
|
|
-----------
|
|
|
|
Contains a generic action which can be targeted from several type of inputs. Actions can be created from the project settings menu ``Project > Project Settings > Input Map``. See :ref:`Node._input<class_Node_method__input>`.
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- `#actions <../tutorials/inputs/inputevent.html#actions>`_ in :doc:`../tutorials/inputs/inputevent`
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_InputEventAction_property_action:
|
|
|
|
- :ref:`String<class_String>` **action**
|
|
|
|
+----------+-------------------+
|
|
| *Setter* | set_action(value) |
|
|
+----------+-------------------+
|
|
| *Getter* | get_action() |
|
|
+----------+-------------------+
|
|
|
|
The action's name. Actions are accessed via this :ref:`String<class_String>`.
|
|
|
|
.. _class_InputEventAction_property_pressed:
|
|
|
|
- :ref:`bool<class_bool>` **pressed**
|
|
|
|
+----------+--------------------+
|
|
| *Setter* | set_pressed(value) |
|
|
+----------+--------------------+
|
|
| *Getter* | is_pressed() |
|
|
+----------+--------------------+
|
|
|
|
If ``true``, the action's state is pressed. If ``false``, the action's state is released.
|
|
|