Attention: Here be dragons
This is the
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Abstract base class for input events.
Abstract base class of all types of input events. See Node._input.
as_text ( ) const
is_action_type ( ) const
is_canceled ( ) const
is_echo ( ) const
is_pressed ( ) const
is_released ( ) const
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.
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.
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.
true if this input event matches a pre-defined action of any type.
true if the given action is being pressed (and is not an echo event for InputEventKey events, unless
true). Not relevant for events of type InputEventMouseMotion or InputEventScreenDrag.
bool is_action_type ( ) const
true if this input event's type is one that can be assigned to an input action.
bool is_canceled ( ) const
true if this input event has been canceled.
bool is_echo ( ) const
true if this input event is an echo event (only for events of type InputEventKey). Any other event type returns
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.
bool is_pressed ( ) const
bool is_released ( ) 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 InputEventMouseButton, InputEventMouseMotion, InputEventScreenTouch, InputEventScreenDrag, InputEventMagnifyGesture and InputEventPanGesture.