Attention: Here be dragons (unstable version)

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Redot.

Checking the stable version of the documentation...

InputEventMouse

Inherits: InputEventWithModifiers < InputEventFromWindow < InputEvent < Resource < RefCounted < Object

Inherited By: InputEventMouseButton, InputEventMouseMotion

Base input event type for mouse events.

Description

Stores general information about mouse events.

Tutorials

Using InputEvent

Properties

BitField[MouseButtonMask]	button_mask	`0`
Vector2	global_position	`Vector2(0, 0)`
Vector2	position	`Vector2(0, 0)`

Property Descriptions

BitField[MouseButtonMask] button_mask = 0 🔗

void set_button_mask(value: BitField[MouseButtonMask])
BitField[MouseButtonMask] get_button_mask()

The mouse button mask identifier, one of or a bitwise combination of the MouseButton button masks.

Vector2 global_position = Vector2(0, 0) 🔗

void set_global_position(value: Vector2)
Vector2 get_global_position()

When received in Node._input or Node._unhandled_input, returns the mouse's position in the root Viewport using the coordinate system of the root Viewport.

When received in Control._gui_input, returns the mouse's position in the CanvasLayer that the Control is in using the coordinate system of the CanvasLayer.

Vector2 position = Vector2(0, 0) 🔗

void set_position(value: Vector2)
Vector2 get_position()

When received in Node._input or Node._unhandled_input, returns the mouse's position in the Viewport this Node is in using the coordinate system of this Viewport.

When received in Control._gui_input, returns the mouse's position in the Control using the local coordinate system of the Control.