Description

Stores information about mouse click events. SeeNode._input().

Note: On Wear OS devices, rotary input is mapped to@GlobalScope.MOUSE_BUTTON_WHEEL_UP and@GlobalScope.MOUSE_BUTTON_WHEEL_DOWN. This can be changed to@GlobalScope.MOUSE_BUTTON_WHEEL_LEFT and@GlobalScope.MOUSE_BUTTON_WHEEL_RIGHT with theProjectSettings.input_devices/pointing/android/rotary_input_scroll_axis setting.

Tutorials

• Using InputEvent

• Mouse and input coordinates

Properties

Property Descriptions

MouseButtonbutton_index =0🔗

• voidset_button_index(value:MouseButton)

• MouseButtonget_button_index()

The mouse button identifier, one of theMouseButton button or button wheel constants.

boolcanceled =false🔗

• voidset_canceled(value:bool)

• boolis_canceled()

Iftrue, the mouse button event has been canceled.

booldouble_click =false🔗

• voidset_double_click(value:bool)

• boolis_double_click()

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

floatfactor =1.0🔗

• voidset_factor(value:float)

• floatget_factor()

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 be0 if not supported.

boolpressed =false🔗

• voidset_pressed(value:bool)

• boolis_pressed()

Iftrue, the mouse button's state is pressed. Iffalse, the mouse button's state is released.