:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/InputEvent.xml. .. _class_InputEvent: InputEvent ========== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Inherited By:** :ref:`InputEventAction`, :ref:`InputEventJoypadButton`, :ref:`InputEventJoypadMotion`, :ref:`InputEventMIDI`, :ref:`InputEventScreenDrag`, :ref:`InputEventScreenTouch`, :ref:`InputEventWithModifiers` Generic input event. .. rst-class:: classref-introduction-group Description ----------- Base class of all sort of input event. See :ref:`Node._input`. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`InputEvent <../tutorials/inputs/inputevent>` - :doc:`Viewport and canvas transforms <../tutorials/2d/2d_transforms>` - `2D Dodge The Creeps Demo `__ - `3D Voxel Demo `__ .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------+-------------------------------------------------+-------+ | :ref:`int` | :ref:`device` | ``0`` | +-----------------------+-------------------------------------------------+-------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`accumulate` **(** :ref:`InputEvent` with_event **)** | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`as_text` **(** **)** |const| | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_action_strength` **(** :ref:`String` action, :ref:`bool` exact_match=false **)** |const| | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_action` **(** :ref:`String` action, :ref:`bool` exact_match=false **)** |const| | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action, :ref:`bool` allow_echo=false, :ref:`bool` exact_match=false **)** |const| | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action, :ref:`bool` exact_match=false **)** |const| | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_action_type` **(** **)** |const| | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_canceled` **(** **)** |const| | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_echo` **(** **)** |const| | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_pressed` **(** **)** |const| | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_released` **(** **)** |const| | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`shortcut_match` **(** :ref:`InputEvent` event, :ref:`bool` exact_match=true **)** |const| | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`InputEvent` | :ref:`xformed_by` **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2( 0, 0 ) **)** |const| | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_InputEvent_property_device: .. rst-class:: classref-property :ref:`int` **device** = ``0`` .. rst-class:: classref-property-setget - void **set_device** **(** :ref:`int` value **)** - :ref:`int` **get_device** **(** **)** The event's device ID. \ **Note:** This device ID will always be ``-1`` for emulated mouse input from a touchscreen. This can be used to distinguish emulated mouse input from physical mouse input. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_InputEvent_method_accumulate: .. rst-class:: classref-method :ref:`bool` **accumulate** **(** :ref:`InputEvent` with_event **)** Returns ``true`` if the given input event and this input event can be added together (only for events of type :ref:`InputEventMouseMotion`). The given input event's position, global position and speed will be copied. The resulting ``relative`` is a sum of both events. Both events' modifiers have to be identical. .. rst-class:: classref-item-separator ---- .. _class_InputEvent_method_as_text: .. rst-class:: classref-method :ref:`String` **as_text** **(** **)** |const| Returns a :ref:`String` representation of the event. .. rst-class:: classref-item-separator ---- .. _class_InputEvent_method_get_action_strength: .. rst-class:: classref-method :ref:`float` **get_action_strength** **(** :ref:`String` action, :ref:`bool` exact_match=false **)** |const| Returns a value between 0.0 and 1.0 depending on the given actions' state. Useful for getting the value of events of type :ref:`InputEventJoypadMotion`. If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref:`InputEventKey` and :ref:`InputEventMouseButton` events, and the direction for :ref:`InputEventJoypadMotion` events. .. rst-class:: classref-item-separator ---- .. _class_InputEvent_method_is_action: .. rst-class:: classref-method :ref:`bool` **is_action** **(** :ref:`String` action, :ref:`bool` exact_match=false **)** |const| Returns ``true`` if this input event matches a pre-defined action of any type. If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref:`InputEventKey` and :ref:`InputEventMouseButton` events, and the direction for :ref:`InputEventJoypadMotion` events. .. rst-class:: classref-item-separator ---- .. _class_InputEvent_method_is_action_pressed: .. rst-class:: classref-method :ref:`bool` **is_action_pressed** **(** :ref:`String` action, :ref:`bool` allow_echo=false, :ref:`bool` exact_match=false **)** |const| Returns ``true`` if the given action is being pressed (and is not an echo event for :ref:`InputEventKey` events, unless ``allow_echo`` is ``true``). Not relevant for events of type :ref:`InputEventMouseMotion` or :ref:`InputEventScreenDrag`. If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref:`InputEventKey` and :ref:`InputEventMouseButton` events, and the direction for :ref:`InputEventJoypadMotion` events. \ **Note:** Due to keyboard ghosting, :ref:`is_action_pressed` may return ``false`` even if one of the action's keys is pressed. See `Input examples <../tutorials/inputs/input_examples.html#keyboard-events>`__ in the documentation for more information. .. rst-class:: classref-item-separator ---- .. _class_InputEvent_method_is_action_released: .. rst-class:: classref-method :ref:`bool` **is_action_released** **(** :ref:`String` action, :ref:`bool` exact_match=false **)** |const| Returns ``true`` if the given action is released (i.e. not pressed). Not relevant for events of type :ref:`InputEventMouseMotion` or :ref:`InputEventScreenDrag`. If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref:`InputEventKey` and :ref:`InputEventMouseButton` events, and the direction for :ref:`InputEventJoypadMotion` events. .. rst-class:: classref-item-separator ---- .. _class_InputEvent_method_is_action_type: .. rst-class:: classref-method :ref:`bool` **is_action_type** **(** **)** |const| Returns ``true`` if this input event's type is one that can be assigned to an input action. .. rst-class:: classref-item-separator ---- .. _class_InputEvent_method_is_canceled: .. rst-class:: classref-method :ref:`bool` **is_canceled** **(** **)** |const| Returns ``true`` if this input event has been canceled. .. rst-class:: classref-item-separator ---- .. _class_InputEvent_method_is_echo: .. rst-class:: classref-method :ref:`bool` **is_echo** **(** **)** |const| Returns ``true`` if this input event is an echo event (only for events of type :ref:`InputEventKey`). .. rst-class:: classref-item-separator ---- .. _class_InputEvent_method_is_pressed: .. rst-class:: classref-method :ref:`bool` **is_pressed** **(** **)** |const| Returns ``true`` if this input event is pressed. Not relevant for events of type :ref:`InputEventMouseMotion` or :ref:`InputEventScreenDrag`. \ **Note:** Due to keyboard ghosting, :ref:`is_action_pressed` may return ``false`` even if one of the action's keys is pressed. See `Input examples <../tutorials/inputs/input_examples.html#keyboard-events>`__ in the documentation for more information. .. rst-class:: classref-item-separator ---- .. _class_InputEvent_method_is_released: .. rst-class:: classref-method :ref:`bool` **is_released** **(** **)** |const| Returns ``true`` if this input event is released. Not relevant for events of type :ref:`InputEventMouseMotion` or :ref:`InputEventScreenDrag`. .. rst-class:: classref-item-separator ---- .. _class_InputEvent_method_shortcut_match: .. rst-class:: classref-method :ref:`bool` **shortcut_match** **(** :ref:`InputEvent` event, :ref:`bool` exact_match=true **)** |const| Returns ``true`` if the specified ``event`` matches this event. Only valid for action events i.e key (:ref:`InputEventKey`), button (:ref:`InputEventMouseButton` or :ref:`InputEventJoypadButton`), axis :ref:`InputEventJoypadMotion` or action (:ref:`InputEventAction`) events. If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref:`InputEventKey` and :ref:`InputEventMouseButton` events, and the direction for :ref:`InputEventJoypadMotion` events. .. rst-class:: classref-item-separator ---- .. _class_InputEvent_method_xformed_by: .. rst-class:: classref-method :ref:`InputEvent` **xformed_by** **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2( 0, 0 ) **)** |const| Returns a copy of the given input event which has been offset by ``local_ofs`` and transformed by ``xform``. Relevant for events of type :ref:`InputEventMouseButton`, :ref:`InputEventMouseMotion`, :ref:`InputEventScreenTouch`, :ref:`InputEventScreenDrag`, :ref:`InputEventMagnifyGesture` and :ref:`InputEventPanGesture`. .. |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.)`