InputEvent

    Inherited By: , InputEventJoypadButton, , InputEventMIDI, , InputEventScreenTouch,

    Generic input event.

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

    Tutorials

    Methods

    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

    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 .

    • bool is_action ( action ) const

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

    • bool is_action_pressed ( action, bool allow_echo=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 .

    • bool is_action_released ( action ) const
    • bool is_action_type ( ) const

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

    • is_echo ( ) const

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

    • is_pressed ( ) const

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

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

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

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