Skip to main content

Class DtrInteractionEvent

Represents an interaction event from the DTR system.

Assembly: Dalamud.dll​
View Source​
Declaration
public class DtrInteractionEvent

Properties​

ClickType​

Gets the type of mouse click (left or right).

View Source​
Declaration
public MouseClickType ClickType { get; init; }

ModifierKeys​

Gets the modifier keys that were held during the click.

View Source​
Declaration
public ClickModifierKeys ModifierKeys { get; init; }

ScrollDirection​

Gets the scroll direction of the mouse wheel, if applicable.

View Source​
Declaration
public MouseScrollDirection ScrollDirection { get; init; }

AtkEventSource​

Gets lower-level mouse data, if this event came from native UI.

Can only be set by Dalamud. If null, this event was manually created.

View Source​
Declaration
public AddonMouseEventData? AtkEventSource { get; }

Position​

Gets the position of the mouse cursor when the event occurred.

View Source​
Declaration
public Vector2 Position { get; init; }

Methods​

FromMouseEvent(AddonMouseEventData)​

Helper to create a Dalamud.Game.Gui.Dtr.DtrInteractionEvent from an Dalamud.Game.Addon.Events.EventDataTypes.AddonMouseEventData.

View Source​
Declaration
public static DtrInteractionEvent FromMouseEvent(AddonMouseEventData ev)
Returns​

Dalamud.Game.Gui.Dtr.DtrInteractionEvent: A better event.

Parameters​
TypeNameDescription
Dalamud.Game.Addon.Events.EventDataTypes.AddonMouseEventDataevThe event.