W3cubDocs

/Godot 3.0

InputEvent

Inherits: Resource < Reference < Object

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

Category: Core

Brief Description

Generic input event

Member Functions

bool action_match ( InputEvent event ) const
String as_text ( ) const
bool is_action ( String action ) const
bool is_action_pressed ( String action ) const
bool is_action_released ( String action ) const
bool is_action_type ( ) const
bool is_echo ( ) const
bool is_pressed ( ) const
bool shortcut_match ( InputEvent event ) const
InputEvent xformed_by ( Transform2D xform, Vector2 local_ofs=Vector2( 0, 0 ) ) const

Member Variables

int device - The event’s device ID.

Description

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

Member Function Description

bool action_match ( InputEvent event ) const

Returns true if this event matches event.

String as_text ( ) const

Returns a String representation of the event.

bool is_action ( String action ) const

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

bool is_action_pressed ( String action ) const

Returns true if the given action is being pressed (and is not an echo event for KEY events). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG or NONE.

bool is_action_released ( String action ) const

Returns true if the given action is released (i.e. not pressed). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG or NONE.

bool is_action_type ( ) const

Returns true if this input event’s type is one of the InputEvent constants.

bool is_echo ( ) const

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

bool is_pressed ( ) const

Returns true if this input event is pressed. Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG or NONE.

bool shortcut_match ( InputEvent event ) const

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

© 2014–2018 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
http://docs.godotengine.org/en/3.0/classes/class_inputevent.html