Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

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

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 InputEventMouseButton events, and the direction for InputEventJoypadMotion events.


bool is_action_pressed ( StringName action, bool allow_echo=false, bool exact_match=false ) const

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

If 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 ( StringName action, bool exact_match=false ) const

Returns true if the given action is released (i.e. not pressed). Not relevant for events of type InputEventMouseMotion or InputEventScreenDrag.

If 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

Returns true if this input event's type is one that can be assigned to an input action.


bool is_canceled ( ) const

Returns true if this input event has been canceled.


bool is_echo ( ) const

Returns true if this input event is an echo event (only for events of type InputEventKey). Any other event type returns false.


bool is_match ( InputEvent event, bool exact_match=true ) const

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.

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


bool is_pressed ( ) const

Returns true if this input event is pressed. Not relevant for events of type InputEventMouseMotion or InputEventScreenDrag.

Note: Due to keyboard ghosting, is_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_released ( ) const

Returns true if this input event is released. Not relevant for events of type InputEventMouseMotion or InputEventScreenDrag.


InputEvent xformed_by ( Transform2D xform, 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 InputEventMouseButton, In