InputEvent

    Inherited By: InputEventAction, , InputEventJoypadMotion, , InputEventScreenDrag, , InputEventWithModifiers

    Generic input event.

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

    Tutorials

    Methods

    The event’s device ID.

    Method Descriptions

    • bool accumulate ( 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.

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

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

    • is_action ( String action, exact_match=false ) const

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

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

    • is_action_pressed ( String action, allow_echo=false, bool exact_match=false ) const

    Returns true if the given action is being pressed (and is not an echo event for events, unless allow_echo is true). Not relevant for events of type InputEventMouseMotion or .

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

    Note: Due to keyboard ghosting, may return false even if one of the action’s keys is pressed. See Input examples in the documentation for more information.

    • is_action_released ( String action, exact_match=false ) const

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

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

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

    • bool is_pressed ( ) const

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

    Note: Due to keyboard ghosting, may return false even if one of the action’s keys is pressed. See Input examples in the documentation for more information.

    Returns true if the specified event matches this event. Only valid for action events i.e key (), button (InputEventMouseButton or ), axis InputEventJoypadMotion or action () events.

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

    • xformed_by ( Transform2D xform, local_ofs=Vector2( 0, 0 ) ) const

    Returns a copy of the given input event which has been offset by and transformed by xform. Relevant for events of type InputEventMouseButton, , InputEventScreenTouch, , InputEventMagnifyGesture and .