Merge pull request #1369 from MidoriKami/DTRBarEnhancements

Dalamud/Plugin/Services/IAddonEventManager.cs

@@ -0,0 +1,46 @@
+using Dalamud.Game.AddonEventManager;
+
+namespace Dalamud.Plugin.Services;
+
+/// <summary>
+/// Service provider for addon event management.
+/// </summary>
+public interface IAddonEventManager
+{
+    /// <summary>
+    /// Delegate to be called when an event is received.
+    /// </summary>
+    /// <param name="atkEventType">Event type for this event handler.</param>
+    /// <param name="atkUnitBase">The parent addon for this event handler.</param>
+    /// <param name="atkResNode">The specific node that will trigger this event handler.</param>
+    public delegate void AddonEventHandler(AddonEventType atkEventType, nint atkUnitBase, nint atkResNode);
+
+    /// <summary>
+    /// Registers an event handler for the specified addon, node, and type.
+    /// </summary>
+    /// <param name="eventId">Unique Id for this event, maximum 0x10000.</param>
+    /// <param name="atkUnitBase">The parent addon for this event.</param>
+    /// <param name="atkResNode">The node that will trigger this event.</param>
+    /// <param name="eventType">The event type for this event.</param>
+    /// <param name="eventHandler">The handler to call when event is triggered.</param>
+    void AddEvent(uint eventId, nint atkUnitBase, nint atkResNode, AddonEventType eventType, AddonEventHandler eventHandler);
+
+    /// <summary>
+    /// Unregisters an event handler with the specified event id and event type.
+    /// </summary>
+    /// <param name="eventId">The Unique Id for this event.</param>
+    /// <param name="atkResNode">The node for this event.</param>
+    /// <param name="eventType">The event type for this event.</param>
+    void RemoveEvent(uint eventId, nint atkResNode, AddonEventType eventType);
+
+    /// <summary>
+    /// Force the game cursor to be the specified cursor.
+    /// </summary>
+    /// <param name="cursor">Which cursor to use.</param>
+    void SetCursor(AddonCursorType cursor);
+
+    /// <summary>
+    /// Un-forces the game cursor.
+    /// </summary>
+    void ResetCursor();
+}

Dalamud/Plugin/Services/IDtrBar.cs

@@ -19,4 +19,10 @@ public interface IDtrBar
     /// <returns>The entry object used to update, hide and remove the entry.</returns>
     /// <exception cref="ArgumentException">Thrown when an entry with the specified title exists.</exception>
     public DtrBarEntry Get(string title, SeString? text = null);
+
+    /// <summary>
+    /// Removes a DTR bar entry from the system.
+    /// </summary>
+    /// <param name="title">Title of the entry to remove.</param>
+    public void Remove(string title);
 }