Class InputEventMouse

Base input event type for mouse events.

Inheritance

InputEventWithModifiers

InputEventFromWindow

InputEvent

Resource

RefCounted

Object

InputEventMouse

Derived

InputEventMouseButton

InputEventMouseMotion

Remarks

Stores general information about mouse events.

See Also

Using InputEvent

Properties

button_mask

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

var button_mask : int = 0

Property Value

int

Remarks

• void set_button_mask(int value)
• int get_button_mask

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.

var global_position : Vector2 = Vector2(0, 0)

Property Value

Vector2

Remarks

• void set_global_position(Vector2 value)
• Vector2 get_global_position

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.

var position : Vector2 = Vector2(0, 0)

Property Value

Vector2

Remarks

• void set_position(Vector2 value)
• Vector2 get_position