godot-docs/classes/class_visualscriptinputaction.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/visual_script/doc_classes/VisualScriptInputAction.xml.

.. _class_VisualScriptInputAction:

VisualScriptInputAction
=======================

**Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

A Visual Script node returning a state of an action.

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

``VisualScriptInputAction`` can be used to check if an action is pressed or released.

Properties
----------

+------------------------------------------------+--------------------------------------------------------------+---------+
| :ref:`StringName<class_StringName>`            | :ref:`action<class_VisualScriptInputAction_property_action>` | ``&""`` |
+------------------------------------------------+--------------------------------------------------------------+---------+
| :ref:`Mode<enum_VisualScriptInputAction_Mode>` | :ref:`mode<class_VisualScriptInputAction_property_mode>`     | ``0``   |
+------------------------------------------------+--------------------------------------------------------------+---------+

Enumerations
------------

.. _enum_VisualScriptInputAction_Mode:

.. _class_VisualScriptInputAction_constant_MODE_PRESSED:

.. _class_VisualScriptInputAction_constant_MODE_RELEASED:

.. _class_VisualScriptInputAction_constant_MODE_JUST_PRESSED:

.. _class_VisualScriptInputAction_constant_MODE_JUST_RELEASED:

enum **Mode**:

- **MODE_PRESSED** = **0** --- ``True`` if action is pressed.

- **MODE_RELEASED** = **1** --- ``True`` if action is released (i.e. not pressed).

- **MODE_JUST_PRESSED** = **2** --- ``True`` on the frame the action was pressed.

- **MODE_JUST_RELEASED** = **3** --- ``True`` on the frame the action was released.

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

.. _class_VisualScriptInputAction_property_action:

- :ref:`StringName<class_StringName>` **action**

+-----------+------------------------+
| *Default* | ``&""``                |
+-----------+------------------------+
| *Setter*  | set_action_name(value) |
+-----------+------------------------+
| *Getter*  | get_action_name()      |
+-----------+------------------------+

Name of the action.

----

.. _class_VisualScriptInputAction_property_mode:

- :ref:`Mode<enum_VisualScriptInputAction_Mode>` **mode**

+-----------+------------------------+
| *Default* | ``0``                  |
+-----------+------------------------+
| *Setter*  | set_action_mode(value) |
+-----------+------------------------+
| *Getter*  | get_action_mode()      |
+-----------+------------------------+

State of the action to check. See :ref:`Mode<enum_VisualScriptInputAction_Mode>` for options.

.. |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.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`