Table of Contents

Class InputEventMouseButton

Namespace
Godot
Assembly
GodotSharp.dll

Stores information about mouse click events. See _Input(InputEvent).

public class InputEventMouseButton : InputEventMouse, IDisposable
Inheritance
InputEventMouseButton
Implements
Inherited Members

Constructors

InputEventMouseButton() 

public InputEventMouseButton()

Properties

ButtonIndex

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

public MouseButton ButtonIndex { get; set; }

Property Value

MouseButton

Canceled

If true, the mouse button event has been canceled.

public bool Canceled { get; set; }

Property Value

bool

DoubleClick

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

public bool DoubleClick { get; set; }

Property Value

bool

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.

public float Factor { get; set; }

Property Value

float

Pressed

If true, the mouse button's state is pressed. If false, the mouse button's state is released.

public bool Pressed { get; set; }

Property Value

bool

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