godot-docs/classes/class_inputeventaction.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/InputEventAction.xml.

.. _class_InputEventAction:

InputEventAction
================

**Inherits:** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

Input event type for actions.

.. rst-class:: classref-introduction-group

Description
-----------

Contains a generic action which can be targeted from several types of inputs. Actions can be created from the **Input Map** tab in the **Project > Project Settings** menu. See :ref:`Node._input<class_Node_method__input>`.

.. rst-class:: classref-introduction-group

Tutorials
---------

- `InputEvent: Actions <../tutorials/inputs/inputevent.html#actions>`__

- `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/515>`__

- `3D Voxel Demo <https://godotengine.org/asset-library/asset/676>`__

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +-----------------------------+-----------------------------------------------------------+-----------+
   | :ref:`String<class_String>` | :ref:`action<class_InputEventAction_property_action>`     | ``""``    |
   +-----------------------------+-----------------------------------------------------------+-----------+
   | :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

Property Descriptions
---------------------

.. _class_InputEventAction_property_action:

.. rst-class:: classref-property

:ref:`String<class_String>` **action** = ``""``

.. rst-class:: classref-property-setget

- void **set_action** **(** :ref:`String<class_String>` value **)**
- :ref:`String<class_String>` **get_action** **(** **)**

The action's name. Actions are accessed via this :ref:`String<class_String>`.

.. rst-class:: classref-item-separator

----

.. _class_InputEventAction_property_pressed:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **pressed** = ``false``

.. rst-class:: classref-property-setget

- void **set_pressed** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_pressed** **(** **)**

If ``true``, the action's state is pressed. If ``false``, the action's state is released.

.. rst-class:: classref-item-separator

----

.. _class_InputEventAction_property_strength:

.. rst-class:: classref-property

:ref:`float<class_float>` **strength** = ``1.0``

.. rst-class:: classref-property-setget

- void **set_strength** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_strength** **(** **)**

The action's strength between 0 and 1. This value is considered as equal to 0 if pressed is ``false``. The event strength allows faking analog joypad motion events, by specifying how strongly the joypad axis is bent or pressed.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`