Skip to content
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
93 lines (62 sloc) 3.38 KB


Inherits: :ref:`InputEventMouse<class_InputEventMouse>` < :ref:`InputEventWithModifiers<class_InputEventWithModifiers>` < :ref:`InputEvent<class_InputEvent>` < :ref:`Resource<class_Resource>` < :ref:`Reference<class_Reference>` < :ref:`Object<class_Object>`

Category: Core

Brief Description

Input event type for mouse button events.


:ref:`int<class_int>` :ref:`button_index<class_InputEventMouseButton_property_button_index>`
:ref:`bool<class_bool>` :ref:`doubleclick<class_InputEventMouseButton_property_doubleclick>`
:ref:`float<class_float>` :ref:`factor<class_InputEventMouseButton_property_factor>`
:ref:`bool<class_bool>` :ref:`pressed<class_InputEventMouseButton_property_pressed>`


Contains mouse click information. See :ref:`Node._input<class_Node_method__input>`.


Property Descriptions

Setter set_button_index(value)
Getter get_button_index()

Mouse button identifier, one of the :ref:`ButtonList<enum_@GlobalScope_ButtonList>` button or button wheel constants.

Setter set_doubleclick(value)
Getter is_doubleclick()

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

Setter set_factor(value)
Getter get_factor()

Magnitude. Amount (or delta) of the event. Used for scroll events, indicates scroll amount (vertically or horizontally). Only supported on some platforms, sensitivity varies by platform. May be 0 if not supported.

Setter set_pressed(value)
Getter is_pressed()

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

You can’t perform that action at this time.