Welcome to the Godot Reference Fork and the Godot Proposals Fork alternatives. Why?

InputEvent

0 0 vote
Article Rating

Inherits: Resource < Reference < Object

Inherited By: InputEventAction, InputEventJoypadButton, InputEventJoypadMotion, InputEventMIDI, InputEventScreenDrag, InputEventScreenTouch, InputEventWithModifiers

Generic input event.

Description

Base class of all sort of input event. See Node._input.

Properties

intdevice0

Methods

boolaccumulate ( InputEvent with_event )
Stringas_text ( ) const
floatget_action_strength ( String action ) const
boolis_action ( String action ) const
boolis_action_pressed ( String action, bool allow_echo=false ) const
boolis_action_released ( String action ) const
boolis_action_type ( ) const
boolis_echo ( ) const
boolis_pressed ( ) const
boolshortcut_match ( InputEvent event ) const
InputEventxformed_by ( Transform2D xform, Vector2 local_ofs=Vector2( 0, 0 ) ) const

Property Descriptions

Default0
Setterset_device(value)
Getterget_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

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.


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.


Returns true if this input event matches a pre-defined action of any type.


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.


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


  • 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_echo ( ) const

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


  • bool is_pressed ( ) const

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


Returns true if the given input event is checking for the same key (InputEventKey), button (InputEventJoypadButton) or action (InputEventAction).


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.

Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.

Subscribe
Notify of
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x