InputEventMouseButton

Category: Built-In Types

Brief Description

Built-in input event type for mouse button events.

Member Functions

bool	is_action ( String action )
bool	is_action_pressed ( String action )
bool	is_action_released ( String action )
bool	is_echo ( )
bool	is_pressed ( )
void	set_as_action ( String action, bool pressed )

Member Variables

• int ID - Event identifier, positive integer increased at each new event.
• bool alt - State of the Alt modifier.
• int button_index - Mouse button identifier, one of the BUTTON_* or BUTTON_WHEEL_* constants in [@Global Scope].
• int button_mask - Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@Global Scope].
• bool control - State of the Control modifier.
• int device - Device identifier.
• bool doubleclick - Whether the event is a double-click.
• Vector2 global_pos - Global position of the mouse click.
• int global_x - Global X coordinate of the mouse click.
• int global_y - Global Y coordinate of the mouse click.
• bool meta - State of the Meta modifier.
• Vector2 pos - Local position of the mouse click.
• bool pressed - Pressed state of the mouse button.
• bool shift - State of the Shift modifier.
• int type - Type of event (one of the [InputEvent] constants).
• int x - Local X coordinate of the mouse click.
• int y - Local Y coordinate of the mouse click.

Numeric Constants

• NONE = 0 — Empty input event.
• KEY = 1 — Key event.
• MOUSE_MOTION = 2 — Mouse motion event.
• MOUSE_BUTTON = 3 — Mouse button event.
• JOYSTICK_MOTION = 4 — Joystick motion event.
• JOYSTICK_BUTTON = 5 — Joystick button event.
• SCREEN_TOUCH = 6 — Screen touch event.
• SCREEN_DRAG = 7 — Screen drag event.
• ACTION = 8 — Pre-defined action event (see InputMap).

Description

Input event type for mouse button events that extends the global InputEvent type.

Member Function Description

bool is_action ( String action )

Return if this input event matches a pre-defined action.

bool is_action_pressed ( String action )

Return whether the given action is being pressed.

bool is_action_released ( String action )

Return whether the given action is released (i.e. not pressed).

bool is_echo ( )

Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type).

bool is_pressed ( )

Return if this input event is pressed.

void set_as_action ( String action, bool pressed )

Change the input event to an action event of the given name with the pressed status passed as argument.