Files
godot-docs/classes/class_inputeventaction.rst
2017-10-21 13:55:57 +02:00

63 lines
2.5 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.
Member Functions
----------------
+------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_action<class_InputEventAction_get_action>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------+
| void | :ref:`set_action<class_InputEventAction_set_action>` **(** :ref:`String<class_string>` action **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pressed<class_InputEventAction_set_pressed>` **(** :ref:`bool<class_bool>` pressed **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_InputEventAction_action:
- :ref:`String<class_string>` **action** - The action's name. Actions are accessed via this :ref:`String<class_string>`.
.. _class_InputEventAction_pressed:
- :ref:`bool<class_bool>` **pressed** - If ``true`` the action's state is pressed. If ``false`` the action's state is released.
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[/Code]. See [method Node._input].
Member Function Description
---------------------------
.. _class_InputEventAction_get_action:
- :ref:`String<class_string>` **get_action** **(** **)** const
.. _class_InputEventAction_set_action:
- void **set_action** **(** :ref:`String<class_string>` action **)**
.. _class_InputEventAction_set_pressed:
- void **set_pressed** **(** :ref:`bool<class_bool>` pressed **)**