InputEventMouseButton

InputEventMouseButton

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

Input event type for mouse button events.

Description

Contains mouse click information. See Node._input.

Tutorials

Mouse and input coordinates

Properties

int	button_index	`0`
bool	doubleclick	`false`
float	factor	`1.0`
bool	pressed	`false`

Property Descriptions

int button_index

Default	`0`
Setter	set_button_index(value)
Getter	get_button_index()

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

bool doubleclick

Default	`false`
Setter	set_doubleclick(value)
Getter	is_doubleclick()

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

float factor

Default	`1.0`
Setter	set_factor(value)
Getter	get_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.

bool pressed

Default	`false`
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.