InputEvent

Inherits: Resource < RefCounted < Object

Inherited By: InputEventAction, InputEventFromWindow, InputEventJoypadButton, InputEventJoypadMotion, InputEventMIDI, InputEventShortcut

Abstract base class for input events.

Description

Abstract base class of all types of input events. See Node._input.

Tutorials

• Using InputEvent

• Viewport and canvas transforms

• 2D Dodge The Creeps Demo

• 3D Voxel Demo

Properties

int

device

0

Methods

bool	accumulate ( InputEvent with_event )
String	as_text ( ) const
float	get_action_strength ( StringName action, bool exact_match=false ) const
bool	is_action ( StringName action, bool exact_match=false ) const
bool	is_action_pressed ( StringName action, bool allow_echo=false, bool exact_match=false ) const
bool	is_action_released ( StringName action, bool exact_match=false ) const
bool	is_action_type ( ) const
bool	is_canceled ( ) const
bool	is_echo ( ) const
bool	is_match ( InputEvent event, bool exact_match=true ) const
bool	is_pressed ( ) const
bool	is_released ( ) const
InputEvent	xformed_by ( Transform2D xform, Vector2 local_ofs=Vector2(0, 0) ) const

---

Property Descriptions

int device = 0

• void set_device ( int value )

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

---

Method Descriptions

bool accumulate ( InputEvent with_event )

Returns true if the given input event and this input event can be added together (only for events of type 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.

---

String as_text ( ) const

Returns a String representation of the event.

---

float get_action_strength ( StringName action, 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 InputEventJoypadMotion.

If exact_match is false, it ignores additional input modifiers for InputEventKey and InputEventMouseButton events, and the direction for InputEventJoypadMotion events.

---

bool is_action ( StringName action, 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 InputEventKey and