Add IFlyTextGui (v9) (#1278)

Dalamud/Game/Gui/FlyText/FlyTextGui.cs

@@ -7,6 +7,7 @@ using Dalamud.Hooking;
 using Dalamud.IoC;
 using Dalamud.IoC.Internal;
 using Dalamud.Memory;
+using Dalamud.Plugin.Services;
 using Serilog;
 
 namespace Dalamud.Game.Gui.FlyText;
@@ -14,10 +15,9 @@ namespace Dalamud.Game.Gui.FlyText;
 /// <summary>
 /// This class facilitates interacting with and creating native in-game "fly text".
 /// </summary>
-[PluginInterface]
 [InterfaceVersion("1.0")]
 [ServiceManager.BlockingEarlyLoadedService]
-public sealed class FlyTextGui : IDisposable, IServiceType
+internal sealed class FlyTextGui : IDisposable, IServiceType, IFlyTextGui
 {
     /// <summary>
     /// The native function responsible for adding fly text to the UI. See <see cref="FlyTextGuiAddressResolver.AddFlyText"/>.
@@ -39,32 +39,6 @@ public sealed class FlyTextGui : IDisposable, IServiceType
         this.createFlyTextHook = Hook<CreateFlyTextDelegate>.FromAddress(this.Address.CreateFlyText, this.CreateFlyTextDetour);
     }
 
-    /// <summary>
-    /// The delegate defining the type for the FlyText event.
-    /// </summary>
-    /// <param name="kind">The FlyTextKind. See <see cref="FlyTextKind"/>.</param>
-    /// <param name="val1">Value1 passed to the native flytext function.</param>
-    /// <param name="val2">Value2 passed to the native flytext function. Seems unused.</param>
-    /// <param name="text1">Text1 passed to the native flytext function.</param>
-    /// <param name="text2">Text2 passed to the native flytext function.</param>
-    /// <param name="color">Color passed to the native flytext function. Changes flytext color.</param>
-    /// <param name="icon">Icon ID passed to the native flytext function. Only displays with select FlyTextKind.</param>
-    /// <param name="damageTypeIcon">Damage Type Icon ID passed to the native flytext function. Displayed next to damage values to denote damage type.</param>
-    /// <param name="yOffset">The vertical offset to place the flytext at. 0 is default. Negative values result
-    /// in text appearing higher on the screen. This does not change where the element begins to fade.</param>
-    /// <param name="handled">Whether this flytext has been handled. If a subscriber sets this to true, the FlyText will not appear.</param>
-    public delegate void OnFlyTextCreatedDelegate(
-        ref FlyTextKind kind,
-        ref int val1,
-        ref int val2,
-        ref SeString text1,
-        ref SeString text2,
-        ref uint color,
-        ref uint icon,
-        ref uint damageTypeIcon,
-        ref float yOffset,
-        ref bool handled);
-
     /// <summary>
     /// Private delegate for the native CreateFlyText function's hook.
     /// </summary>
@@ -95,12 +69,8 @@ public sealed class FlyTextGui : IDisposable, IServiceType
         uint offsetStrMax,
         int unknown);
 
-    /// <summary>
+    /// <inheritdoc/>
-    /// The FlyText event that can be subscribed to.
+    public event IFlyTextGui.OnFlyTextCreatedDelegate? FlyTextCreated;
-    /// </summary>
-    public event OnFlyTextCreatedDelegate? FlyTextCreated;
-
-    private Dalamud Dalamud { get; }
 
     private FlyTextGuiAddressResolver Address { get; }
 
@@ -112,18 +82,7 @@ public sealed class FlyTextGui : IDisposable, IServiceType
         this.createFlyTextHook.Dispose();
     }
 
-    /// <summary>
+    /// <inheritdoc/>
-    /// Displays a fly text in-game on the local player.
-    /// </summary>
-    /// <param name="kind">The FlyTextKind. See <see cref="FlyTextKind"/>.</param>
-    /// <param name="actorIndex">The index of the actor to place flytext on. Indexing unknown. 1 places flytext on local player.</param>
-    /// <param name="val1">Value1 passed to the native flytext function.</param>
-    /// <param name="val2">Value2 passed to the native flytext function. Seems unused.</param>
-    /// <param name="text1">Text1 passed to the native flytext function.</param>
-    /// <param name="text2">Text2 passed to the native flytext function.</param>
-    /// <param name="color">Color passed to the native flytext function. Changes flytext color.</param>
-    /// <param name="icon">Icon ID passed to the native flytext function. Only displays with select FlyTextKind.</param>
-    /// <param name="damageTypeIcon">Damage Type Icon ID passed to the native flytext function. Displayed next to damage values to denote damage type.</param>
     public unsafe void AddFlyText(FlyTextKind kind, uint actorIndex, uint val1, uint val2, SeString text1, SeString text2, uint color, uint icon, uint damageTypeIcon)
     {
         // Known valid flytext region within the atk arrays
@@ -318,3 +277,44 @@ public sealed class FlyTextGui : IDisposable, IServiceType
         return retVal;
     }
 }
+
+/// <summary>
+/// Plugin scoped version of FlyTextGui.
+/// </summary>
+[PluginInterface]
+[InterfaceVersion("1.0")]
+[ServiceManager.ScopedService]
+#pragma warning disable SA1015
+[ResolveVia<IFlyTextGui>]
+#pragma warning restore SA1015
+internal class FlyTextGuiPluginScoped : IDisposable, IServiceType, IFlyTextGui
+{
+    [ServiceManager.ServiceDependency]
+    private readonly FlyTextGui flyTextGuiService = Service<FlyTextGui>.Get();
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="FlyTextGuiPluginScoped"/> class.
+    /// </summary>
+    internal FlyTextGuiPluginScoped()
+    {
+        this.flyTextGuiService.FlyTextCreated += this.FlyTextCreatedForward;
+    }
+        
+    /// <inheritdoc/>
+    public event IFlyTextGui.OnFlyTextCreatedDelegate? FlyTextCreated;
+    
+    /// <inheritdoc/>
+    public void Dispose()
+    {
+        this.flyTextGuiService.FlyTextCreated -= this.FlyTextCreatedForward;
+    }
+
+    /// <inheritdoc/>
+    public void AddFlyText(FlyTextKind kind, uint actorIndex, uint val1, uint val2, SeString text1, SeString text2, uint color, uint icon, uint damageTypeIcon)
+    {
+        this.flyTextGuiService.AddFlyText(kind, actorIndex, val1, val2, text1, text2, color, icon, damageTypeIcon);
+    }
+
+    private void FlyTextCreatedForward(ref FlyTextKind kind, ref int val1, ref int val2, ref SeString text1, ref SeString text2, ref uint color, ref uint icon, ref uint damageTypeIcon, ref float yOffset, ref bool handled)
+        => this.FlyTextCreated?.Invoke(ref kind, ref val1, ref val2, ref text1, ref text2, ref color, ref icon, ref damageTypeIcon, ref yOffset, ref handled);
+}

Dalamud/Plugin/Services/IFlyTextGui.cs

@@ -0,0 +1,55 @@
+using Dalamud.Game.Gui.FlyText;
+using Dalamud.Game.Text.SeStringHandling;
+
+namespace Dalamud.Plugin.Services;
+
+/// <summary>
+/// This class facilitates interacting with and creating native in-game "fly text".
+/// </summary>
+public interface IFlyTextGui
+{
+    /// <summary>
+    /// The delegate defining the type for the FlyText event.
+    /// </summary>
+    /// <param name="kind">The FlyTextKind. See <see cref="FlyTextKind"/>.</param>
+    /// <param name="val1">Value1 passed to the native flytext function.</param>
+    /// <param name="val2">Value2 passed to the native flytext function. Seems unused.</param>
+    /// <param name="text1">Text1 passed to the native flytext function.</param>
+    /// <param name="text2">Text2 passed to the native flytext function.</param>
+    /// <param name="color">Color passed to the native flytext function. Changes flytext color.</param>
+    /// <param name="icon">Icon ID passed to the native flytext function. Only displays with select FlyTextKind.</param>
+    /// <param name="damageTypeIcon">Damage Type Icon ID passed to the native flytext function. Displayed next to damage values to denote damage type.</param>
+    /// <param name="yOffset">The vertical offset to place the flytext at. 0 is default. Negative values result
+    /// in text appearing higher on the screen. This does not change where the element begins to fade.</param>
+    /// <param name="handled">Whether this flytext has been handled. If a subscriber sets this to true, the FlyText will not appear.</param>
+    public delegate void OnFlyTextCreatedDelegate(
+        ref FlyTextKind kind,
+        ref int val1,
+        ref int val2,
+        ref SeString text1,
+        ref SeString text2,
+        ref uint color,
+        ref uint icon,
+        ref uint damageTypeIcon,
+        ref float yOffset,
+        ref bool handled);
+    
+    /// <summary>
+    /// The FlyText event that can be subscribed to.
+    /// </summary>
+    public event OnFlyTextCreatedDelegate? FlyTextCreated;
+
+    /// <summary>
+    /// Displays a fly text in-game on the local player.
+    /// </summary>
+    /// <param name="kind">The FlyTextKind. See <see cref="FlyTextKind"/>.</param>
+    /// <param name="actorIndex">The index of the actor to place flytext on. Indexing unknown. 1 places flytext on local player.</param>
+    /// <param name="val1">Value1 passed to the native flytext function.</param>
+    /// <param name="val2">Value2 passed to the native flytext function. Seems unused.</param>
+    /// <param name="text1">Text1 passed to the native flytext function.</param>
+    /// <param name="text2">Text2 passed to the native flytext function.</param>
+    /// <param name="color">Color passed to the native flytext function. Changes flytext color.</param>
+    /// <param name="icon">Icon ID passed to the native flytext function. Only displays with select FlyTextKind.</param>
+    /// <param name="damageTypeIcon">Damage Type Icon ID passed to the native flytext function. Displayed next to damage values to denote damage type.</param>
+    public void AddFlyText(FlyTextKind kind, uint actorIndex, uint val1, uint val2, SeString text1, SeString text2, uint color, uint icon, uint damageTypeIcon);
+}