IDtrBar Add Additional Click Events (#2325)

* Add additional dtr click events

* Let's just break things and make them really nice

* Add additional dtr click events

* Let's just break things and make them really nice

* Add additional dtr click events

* Let's just break things and make them really nice

* git is stupid

* Documentation fixing

Dalamud/Game/Addon/Events/EventDataTypes/AddonEventData.cs

@@ -1,10 +1,32 @@
-namespace Dalamud.Game.Addon.Events;
+namespace Dalamud.Game.Addon.Events.EventDataTypes;
 
 /// <summary>
 /// Object representing data that is relevant in handling native events.
 /// </summary>
 public class AddonEventData
 {
+    /// <summary>
+    /// Initializes a new instance of the <see cref="AddonEventData"/> class.
+    /// </summary>
+    internal AddonEventData()
+    {
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="AddonEventData"/> class.
+    /// </summary>
+    /// <param name="eventData">Other event data to copy.</param>
+    internal AddonEventData(AddonEventData eventData)
+    {
+        this.AtkEventType = eventData.AtkEventType;
+        this.Param = eventData.Param;
+        this.AtkEventPointer = eventData.AtkEventPointer;
+        this.AtkEventDataPointer = eventData.AtkEventDataPointer;
+        this.AddonPointer = eventData.AddonPointer;
+        this.NodeTargetPointer = eventData.NodeTargetPointer;
+        this.AtkEventListener = eventData.AtkEventListener;
+    }
+
     /// <summary>
     /// Gets the AtkEventType for this event.
     /// </summary>
@@ -18,8 +40,8 @@ public class AddonEventData
     /// <summary>
     /// Gets the pointer to the AtkEvent object for this event.
     /// </summary>
-    /// <remarks>Note: This is not a pointer to the AtkEventData object.<br/><br/></remarks>
-    /// <remarks>Warning: AtkEvent->Node has been modified to be the AtkUnitBase*, and AtkEvent->Target has been modified to be the AtkResNode* that triggered this event.</remarks>
+    /// <remarks>Note: This is not a pointer to the AtkEventData object.<br/><br/>
+    /// Warning: AtkEvent->Node has been modified to be the AtkUnitBase*, and AtkEvent->Target has been modified to be the AtkResNode* that triggered this event.</remarks>
     public nint AtkEventPointer { get; internal set; }
 
     /// <summary>

Dalamud/Game/Addon/Events/EventDataTypes/AddonMouseEventData.cs

@@ -0,0 +1,82 @@
+using System.Numerics;
+
+using FFXIVClientStructs.FFXIV.Component.GUI;
+
+using AtkMouseData = FFXIVClientStructs.FFXIV.Component.GUI.AtkEventData.AtkMouseData;
+using ModifierFlag = FFXIVClientStructs.FFXIV.Component.GUI.AtkEventData.AtkMouseData.ModifierFlag;
+
+namespace Dalamud.Game.Addon.Events.EventDataTypes;
+
+/// <inheritdoc />
+public unsafe class AddonMouseEventData : AddonEventData
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="AddonMouseEventData"/> class.
+    /// </summary>
+    internal AddonMouseEventData()
+    {
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="AddonMouseEventData"/> class.
+    /// </summary>
+    /// <param name="eventData">Other event data to copy.</param>
+    internal AddonMouseEventData(AddonEventData eventData)
+        : base(eventData)
+    {
+    }
+
+    /// <summary>
+    /// Gets a value indicating whether the event was a Left Mouse Click.
+    /// </summary>
+    public bool IsLeftClick => this.MouseData.ButtonId is 0;
+
+    /// <summary>
+    /// Gets a value indicating whether the event was a Right Mouse Click.
+    /// </summary>
+    public bool IsRightClick => this.MouseData.ButtonId is 1;
+
+    /// <summary>
+    /// Gets a value indicating whether there are any modifiers set such as alt, control, shift, or dragging.
+    /// </summary>
+    public bool IsNoModifier => this.MouseData.Modifier is 0;
+
+    /// <summary>
+    /// Gets a value indicating whether alt was being held when this event triggered.
+    /// </summary>
+    public bool IsAltHeld => this.MouseData.Modifier.HasFlag(ModifierFlag.Alt);
+
+    /// <summary>
+    /// Gets a value indicating whether control was being held when this event triggered.
+    /// </summary>
+    public bool IsControlHeld => this.MouseData.Modifier.HasFlag(ModifierFlag.Ctrl);
+
+    /// <summary>
+    /// Gets a value indicating whether shift was being held when this event triggered.
+    /// </summary>
+    public bool IsShiftHeld => this.MouseData.Modifier.HasFlag(ModifierFlag.Shift);
+
+    /// <summary>
+    /// Gets a value indicating whether this event is a mouse drag or not.
+    /// </summary>
+    public bool IsDragging => this.MouseData.Modifier.HasFlag(ModifierFlag.Dragging);
+
+    /// <summary>
+    /// Gets a value indicating whether the event was a scroll up.
+    /// </summary>
+    public bool IsScrollUp => this.MouseData.WheelDirection is 1;
+
+    /// <summary>
+    /// Gets a value indicating whether the event was a scroll down.
+    /// </summary>
+    public bool IsScrollDown => this.MouseData.WheelDirection is -1;
+
+    /// <summary>
+    /// Gets the position of the mouse when this event was triggered.
+    /// </summary>
+    public Vector2 Position => new(this.MouseData.PosX, this.MouseData.PosY);
+
+    private AtkEventData* AtkEventData => (AtkEventData*)this.AtkEventDataPointer;
+
+    private AtkMouseData MouseData => this.AtkEventData->MouseData;
+}

Dalamud/Game/Addon/Events/PluginEventController.cs

@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using System.Linq;
 
+using Dalamud.Game.Addon.Events.EventDataTypes;
 using Dalamud.Game.Gui;
 using Dalamud.Logging.Internal;
 using Dalamud.Plugin.Services;

Dalamud/Game/Gui/Dtr/DtrBar.cs

@@ -5,6 +5,7 @@ using System.Threading;
 
 using Dalamud.Configuration.Internal;
 using Dalamud.Game.Addon.Events;
+using Dalamud.Game.Addon.Events.EventDataTypes;
 using Dalamud.Game.Addon.Lifecycle;
 using Dalamud.Game.Addon.Lifecycle.AddonArgTypes;
 using Dalamud.Game.Text.SeStringHandling;
@@ -596,24 +597,13 @@ internal sealed unsafe class DtrBar : IInternalDisposableService, IDtrBar
         newTextNode->TextColor = new ByteColor { R = 255, G = 255, B = 255, A = 255 };
         newTextNode->EdgeColor = new ByteColor { R = 142, G = 106, B = 12, A = 255 };
 
-        // ICreatable was restored, this may be necessary if AtkUldManager.CreateAtkTextNode(); is used instead of Create<T>
-        // // Memory is filled with random data after being created, zero out some things to avoid issues.
-        // newTextNode->UnkPtr_1 = null;
-        // newTextNode->SelectStart = 0;
-        // newTextNode->SelectEnd = 0;
-        // newTextNode->FontCacheHandle = 0;
-        // newTextNode->CharSpacing = 0;
-        // newTextNode->BackgroundColor = new ByteColor { R = 0, G = 0, B = 0, A = 0 };
-        // newTextNode->TextId = 0;
-        // newTextNode->SheetType = 0;
-
         return newTextNode;
     }
 
-    private void DtrEventHandler(AddonEventType atkEventType, AddonEventData data)
+    private void DtrEventHandler(AddonEventType atkEventType, AddonEventData eventData)
     {
-        var addon = (AtkUnitBase*)data.AddonPointer;
-        var node = (AtkResNode*)data.NodeTargetPointer;
+        var addon = (AtkUnitBase*)eventData.AddonPointer;
+        var node = (AtkResNode*)eventData.NodeTargetPointer;
 
         DtrBarEntry? dtrBarEntry = null;
         this.entriesLock.EnterReadLock();
@@ -652,7 +642,7 @@ internal sealed unsafe class DtrBar : IInternalDisposableService, IDtrBar
                     break;
 
                 case AddonEventType.MouseClick:
-                    dtrBarEntry.OnClick.Invoke();
+                    dtrBarEntry.OnClick?.Invoke(new AddonMouseEventData(eventData));
                     break;
             }
         }

Dalamud/Game/Gui/Dtr/DtrBarEntry.cs

@@ -1,4 +1,5 @@
 using Dalamud.Configuration.Internal;
+using Dalamud.Game.Addon.Events.EventDataTypes;
 using Dalamud.Game.Text.SeStringHandling;
 using Dalamud.Plugin.Internal.Types;
 using Dalamud.Utility;
@@ -42,12 +43,6 @@ public interface IReadOnlyDtrBarEntry
     /// Gets a value indicating whether the user has hidden this entry from view through the Dalamud settings.
     /// </summary>
     public bool UserHidden { get; }
-
-    /// <summary>
-    /// Triggers the click action of this entry.
-    /// </summary>
-    /// <returns>True, if a click action was registered and executed.</returns>
-    public bool TriggerClickAction();
 }
 
 /// <summary>
@@ -71,9 +66,9 @@ public interface IDtrBarEntry : IReadOnlyDtrBarEntry
     public new bool Shown { get; set; }
 
     /// <summary>
-    /// Gets or sets a action to be invoked when the user clicks on the dtr entry.
+    /// Gets or sets an action to be invoked when the user clicks on the dtr entry.
     /// </summary>
-    public Action? OnClick { get; set; }
+    public Action<AddonMouseEventData>? OnClick { get; set; }
 
     /// <summary>
     /// Remove this entry from the bar.
@@ -122,10 +117,8 @@ internal sealed unsafe class DtrBarEntry : IDisposable, IDtrBarEntry
     /// <inheritdoc cref="IDtrBarEntry.Tooltip" />
     public SeString? Tooltip { get; set; }
 
-    /// <summary>
-    /// Gets or sets a action to be invoked when the user clicks on the dtr entry.
-    /// </summary>
-    public Action? OnClick { get; set; }
+    /// <inheritdoc/>
+    public Action<AddonMouseEventData>? OnClick { get; set; }
 
     /// <inheritdoc/>
     public bool HasClickAction => this.OnClick != null;
@@ -145,7 +138,7 @@ internal sealed unsafe class DtrBarEntry : IDisposable, IDtrBarEntry
     }
 
     /// <inheritdoc/>
-    [Api13ToDo("Maybe make this config scoped to internalname?")]
+    [Api13ToDo("Maybe make this config scoped to internal name?")]
     public bool UserHidden => this.configuration.DtrIgnore?.Contains(this.Title) ?? false;
 
     /// <summary>
@@ -178,16 +171,6 @@ internal sealed unsafe class DtrBarEntry : IDisposable, IDtrBarEntry
     /// </summary>
     internal LocalPlugin? OwnerPlugin { get; set; }
 
-    /// <inheritdoc/>
-    public bool TriggerClickAction()
-    {
-        if (this.OnClick == null)
-            return false;
-
-        this.OnClick.Invoke();
-        return true;
-    }
-
     /// <summary>
     /// Remove this entry from the bar.
     /// You will need to re-acquire it from DtrBar to reuse it.

Dalamud/Plugin/Services/IAddonEventManager.cs

@@ -1,4 +1,5 @@
-using Dalamud.Game.Addon.Events;
+using Dalamud.Game.Addon.Events;
+using Dalamud.Game.Addon.Events.EventDataTypes;
 
 namespace Dalamud.Plugin.Services;