Table of Contents

Class InputEventMouse

Namespace
Godot
Assembly
GodotSharp.dll

Stores general information about mouse events.

public class InputEventMouse : InputEventWithModifiers, IDisposable
Inheritance
InputEventMouse
Implements
Derived
Inherited Members

Properties

ButtonMask

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

public MouseButtonMask ButtonMask { get; set; }

Property Value

MouseButtonMask

GlobalPosition

When received in _Input(InputEvent) or _UnhandledInput(InputEvent), returns the mouse's position in the root Viewport using the coordinate system of the root Viewport.

When received in _GuiInput(InputEvent), returns the mouse's position in the CanvasLayer that the Control is in using the coordinate system of the CanvasLayer.

public Vector2 GlobalPosition { get; set; }

Property Value

Vector2

Position

When received in _Input(InputEvent) or _UnhandledInput(InputEvent), returns the mouse's position in the Viewport this Node is in using the coordinate system of this Viewport.

When received in _GuiInput(InputEvent), returns the mouse's position in the Control using the local coordinate system of the Control.

public Vector2 Position { get; set; }

Property Value

Vector2

Methods

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool
Edit this page