InputEventMouseButton | Godot Docs 4.6

class-description

NEWS

COMMUNITY

STORE

TUTORIALS

LOGOUT

LOGOUT

Object

InputEventWithModifiers

InputEventMouse

InputEventMouseButton

Represents a mouse button being pressed or released.

Stores information about mouse click events. See [method Node._input].
Note: On Wear OS devices, rotary input is mapped to MOUSE_BUTTON_WHEEL_UP and MOUSE_BUTTON_WHEEL_DOWN. This can be changed to MOUSE_BUTTON_WHEEL_LEFT and MOUSE_BUTTON_WHEEL_RIGHT with the [member ProjectSettings.input_devices/pointing/android/rotary_input_scroll_axis] setting.

set get

int

button_index

()

:int

set get

The mouse button identifier, one of the MouseButton button or button wheel constants.

set get

bool

canceled

()

:bool

set get

If true, the mouse button event has been canceled.

set get

bool

double_click

()

:bool

set get

If true, the mouse button's state is a double-click.

set get

float

factor

()

:float

set get

The amount (or delta) of the event. When used for high-precision scroll events, this indicates the scroll amount (vertical or horizontal). This is only supported on some platforms; the reported sensitivity varies depending on the platform. May be 0 if not supported.

set get

bool

pressed

()

:bool

set get

If true, the mouse button's state is pressed. If false, the mouse button's state is released.