InputEvent

Inherits: Resource < Reference < Object Inherited By: InputEventAction, InputEventJoypadButton, InputEventJoypadMotion, InputEventMIDI, InputEventScreenDrag, InputEventScreenTouch, InputEventWithModifiers Generic input event.

Description

Node._input.

Tutorials

  • InputEvent
  • Viewport and canvas transforms
  • 2D Dodge The Creeps Demo
  • 3D Voxel Demo

    Properties

    Methods

    Property Descriptions

  • int 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.

    Method Descriptions

  • bool accumulate ( InputEvent with_event ) true if the given input event and this input event can be added together (only for events of type InputEventMouseMotion). relative is a sum of both events. Both events’ modifiers have to be identical.
  • String as_text ( ) const String representation of the event.
  • float get_action_strength ( String action, bool exact_match=false ) const InputEventJoypadMotion. exact_match is false, it ignores additional input modifiers for InputEventKey and InputEventMouseButton events, and the direction for InputEventJoypadMotion events.
  • bool is_action ( String action, bool exact_match=false ) const true if this input event matches a pre-defined action of any type. exact_match is false, it ignores additional input modifiers for InputEventKey and InputEventMouseButton events, and the direction for InputEventJoypadMotion events.
  • bool is_action_pressed ( String action, bool allow_echo=false, bool exact_match=false ) const true if the given action is being pressed (and is not an echo event for InputEventKey events, unless allow_echo is true). Not relevant for events of type InputEventMouseMotion or InputEventScreenDrag. exact_match is false, it ignores additional input modifiers for InputEventKey and InputEventMouseButton events, and the direction for InputEventJoypadMotion events. Note: Due to keyboard ghosting, is_action_pressed may return false even if one of the action’s keys is pressed. See Input examples in the documentation for more information.
  • bool is_action_released ( String action, bool exact_match=false ) const true if the given action is released (i.e. not pressed). Not relevant for events of type InputEventMouseMotion or InputEventScreenDrag. exact_match is false, it ignores additional input modifiers for InputEventKey and InputEventMouseButton events, and the direction for InputEventJoypadMotion events.
  • bool is_action_type ( ) const true if this input event’s type is one that can be assigned to an input action.
  • bool is_echo ( ) const true if this input event is an echo event (only for events of type InputEventKey).
  • bool is_pressed ( ) const true if this input event is pressed. Not relevant for events of type InputEventMouseMotion or InputEventScreenDrag. Note: Due to keyboard ghosting, is_action_pressed may return false even if one of the action’s keys is pressed. See Input examples in the documentation for more information.
  • bool shortcut_match ( InputEvent event, bool exact_match=true ) const true if the specified event matches this event. Only valid for action events i.e key (InputEventKey), button (InputEventMouseButton or InputEventJoypadButton), axis InputEventJoypadMotion or action (InputEventAction) events. exact_match is false, it ignores additional input modifiers for InputEventKey and InputEventMouseButton events, and the direction for InputEventJoypadMotion events.
  • InputEvent xformed_by ( Transform2D xform, Vector2 local_ofs=Vector2( 0, 0 ) ) const local_ofs and transformed by xform. Relevant for events of type InputEventMouseButton, InputEventMouseMotion, InputEventScreenTouch, InputEventScreenDrag, InputEventMagnifyGesture and InputEventPanGesture.