Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

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

Properties

BitField<MouseButtonMask>

button_mask

0

Vector2

global_position

Vector2(0, 0)

Vector2

position

Vector2(0, 0)


Property Descriptions

BitField<MouseButtonMask> button_mask = 0

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 ( Vector2 value )

  • 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