InputEventMouseButton

Inherits: InputEventMouse < InputEventWithModifiers < InputEvent < Resource < Reference < Object

Input event type for mouse button events.

Description

Contains mouse click information. See Node._input.

Tutorials

Properties

intbutton_index0
booldoubleclickfalse
floatfactor1.0
boolpressedfalse

Property Descriptions

  • int button_index
Default0
Setterset_button_index(value)
Getterget_button_index()

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


Defaultfalse
Setterset_doubleclick(value)
Getteris_doubleclick()

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


Default1.0
Setterset_factor(value)
Getterget_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 be 0 if not supported.


Defaultfalse
Setterset_pressed(value)
Getteris_pressed()

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