Struct PluginHudInput

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

One pointer event delivered to an overlay.

public readonly record struct PluginHudInput : IEquatable<PluginHudInput>

Implements

IEquatable<PluginHudInput>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PluginHudInput(PluginHudInputKind, PluginPoint, PluginMouseButton, bool, bool, bool)

One pointer event delivered to an overlay.

public PluginHudInput(PluginHudInputKind Kind, PluginPoint Position, PluginMouseButton Button = PluginMouseButton.None, bool Shift = false, bool Control = false, bool Alt = false)

Parameters

Kind PluginHudInputKind

What the pointer did.

Position PluginPoint

Where the pointer was when it happened.

Button PluginMouseButton

The mouse button involved, or None for a move.

Shift bool

Whether Shift was held.

Control bool

Whether Control was held.

Alt bool

Whether Alt was held.

Properties

Alt

Whether Alt was held.

public bool Alt { get; init; }

Property Value

bool

Button

The mouse button involved, or None for a move.

public PluginMouseButton Button { get; init; }

Property Value

PluginMouseButton

Control

Whether Control was held.

public bool Control { get; init; }

Property Value

bool

Kind

What the pointer did.

public PluginHudInputKind Kind { get; init; }

Property Value

PluginHudInputKind

Position

Where the pointer was when it happened.

public PluginPoint Position { get; init; }

Property Value

PluginPoint

Shift

Whether Shift was held.

public bool Shift { get; init; }

Property Value

bool