Add ITargetManager (#1277)

Co-authored-by: goat <16760685+goaaats@users.noreply.github.com>

Dalamud/Game/ClientState/Objects/TargetManager.cs

@@ -12,7 +12,10 @@ namespace Dalamud.Game.ClientState.Objects;
 [PluginInterface]
 [InterfaceVersion("1.0")]
 [ServiceManager.BlockingEarlyLoadedService]
-public sealed unsafe class TargetManager : IServiceType
+#pragma warning disable SA1015
+[ResolveVia<ITargetManager>]
+#pragma warning restore SA1015
+public sealed unsafe class TargetManager : IServiceType, ITargetManager
 {
     [ServiceManager.ServiceDependency]
     private readonly ClientState clientState = Service<ClientState>.Get();
@@ -28,50 +31,38 @@ public sealed unsafe class TargetManager : IServiceType
         this.address = this.clientState.AddressResolver;
     }
 
-    /// <summary>
+    /// <inheritdoc/>
-    /// Gets the address of the target manager.
-    /// </summary>
     public IntPtr Address => this.address.TargetManager;
 
-    /// <summary>
+    /// <inheritdoc/>
-    /// Gets or sets the current target.
-    /// </summary>
     public GameObject? Target
     {
         get => this.objectTable.CreateObjectReference((IntPtr)Struct->Target);
         set => this.SetTarget(value);
     }
 
-    /// <summary>
+    /// <inheritdoc/>
-    /// Gets or sets the mouseover target.
-    /// </summary>
     public GameObject? MouseOverTarget
     {
         get => this.objectTable.CreateObjectReference((IntPtr)Struct->MouseOverTarget);
         set => this.SetMouseOverTarget(value);
     }
 
-    /// <summary>
+    /// <inheritdoc/>
-    /// Gets or sets the focus target.
-    /// </summary>
     public GameObject? FocusTarget
     {
         get => this.objectTable.CreateObjectReference((IntPtr)Struct->FocusTarget);
         set => this.SetFocusTarget(value);
     }
 
-    /// <summary>
+    /// <inheritdoc/>
-    /// Gets or sets the previous target.
-    /// </summary>
     public GameObject? PreviousTarget
     {
         get => this.objectTable.CreateObjectReference((IntPtr)Struct->PreviousTarget);
         set => this.SetPreviousTarget(value);
     }
 
-    /// <summary>
+    /// <inheritdoc/>
-    /// Gets or sets the soft target.
-    /// </summary>
     public GameObject? SoftTarget
     {
         get => this.objectTable.CreateObjectReference((IntPtr)Struct->SoftTarget);
@@ -84,84 +75,99 @@ public sealed unsafe class TargetManager : IServiceType
     /// Sets the current target.
     /// </summary>
     /// <param name="actor">Actor to target.</param>
+    [Obsolete("Use Target Property", false)]
     public void SetTarget(GameObject? actor) => this.SetTarget(actor?.Address ?? IntPtr.Zero);
 
     /// <summary>
     /// Sets the mouseover target.
     /// </summary>
     /// <param name="actor">Actor to target.</param>
+    [Obsolete("Use MouseOverTarget Property", false)]
     public void SetMouseOverTarget(GameObject? actor) => this.SetMouseOverTarget(actor?.Address ?? IntPtr.Zero);
 
     /// <summary>
     /// Sets the focus target.
     /// </summary>
     /// <param name="actor">Actor to target.</param>
+    [Obsolete("Use FocusTarget Property", false)]
     public void SetFocusTarget(GameObject? actor) => this.SetFocusTarget(actor?.Address ?? IntPtr.Zero);
 
     /// <summary>
     /// Sets the previous target.
     /// </summary>
     /// <param name="actor">Actor to target.</param>
+    [Obsolete("Use PreviousTarget Property", false)]
     public void SetPreviousTarget(GameObject? actor) => this.SetTarget(actor?.Address ?? IntPtr.Zero);
 
     /// <summary>
     /// Sets the soft target.
     /// </summary>
     /// <param name="actor">Actor to target.</param>
+    [Obsolete("Use SoftTarget Property", false)]
     public void SetSoftTarget(GameObject? actor) => this.SetTarget(actor?.Address ?? IntPtr.Zero);
 
     /// <summary>
     /// Sets the current target.
     /// </summary>
     /// <param name="actorAddress">Actor (address) to target.</param>
+    [Obsolete("Use Target Property", false)]
     public void SetTarget(IntPtr actorAddress) => Struct->Target = (FFXIVClientStructs.FFXIV.Client.Game.Object.GameObject*)actorAddress;
 
     /// <summary>
     /// Sets the mouseover target.
     /// </summary>
     /// <param name="actorAddress">Actor (address) to target.</param>
+    [Obsolete("Use MouseOverTarget Property", false)]
     public void SetMouseOverTarget(IntPtr actorAddress) => Struct->MouseOverTarget = (FFXIVClientStructs.FFXIV.Client.Game.Object.GameObject*)actorAddress;
 
     /// <summary>
     /// Sets the focus target.
     /// </summary>
     /// <param name="actorAddress">Actor (address) to target.</param>
+    [Obsolete("Use FocusTarget Property", false)]
     public void SetFocusTarget(IntPtr actorAddress) => Struct->FocusTarget = (FFXIVClientStructs.FFXIV.Client.Game.Object.GameObject*)actorAddress;
 
     /// <summary>
     /// Sets the previous target.
     /// </summary>
     /// <param name="actorAddress">Actor (address) to target.</param>
+    [Obsolete("Use PreviousTarget Property", false)]
     public void SetPreviousTarget(IntPtr actorAddress) => Struct->PreviousTarget = (FFXIVClientStructs.FFXIV.Client.Game.Object.GameObject*)actorAddress;
 
     /// <summary>
     /// Sets the soft target.
     /// </summary>
     /// <param name="actorAddress">Actor (address) to target.</param>
+    [Obsolete("Use SoftTarget Property", false)]
     public void SetSoftTarget(IntPtr actorAddress) => Struct->SoftTarget = (FFXIVClientStructs.FFXIV.Client.Game.Object.GameObject*)actorAddress;
 
     /// <summary>
     /// Clears the current target.
     /// </summary>
+    [Obsolete("Use Target Property", false)]
     public void ClearTarget() => this.SetTarget(IntPtr.Zero);
 
     /// <summary>
     /// Clears the mouseover target.
     /// </summary>
+    [Obsolete("Use MouseOverTarget Property", false)]
     public void ClearMouseOverTarget() => this.SetMouseOverTarget(IntPtr.Zero);
 
     /// <summary>
     /// Clears the focus target.
     /// </summary>
+    [Obsolete("Use FocusTarget Property", false)]
     public void ClearFocusTarget() => this.SetFocusTarget(IntPtr.Zero);
 
     /// <summary>
     /// Clears the previous target.
     /// </summary>
+    [Obsolete("Use PreviousTarget Property", false)]
     public void ClearPreviousTarget() => this.SetPreviousTarget(IntPtr.Zero);
 
     /// <summary>
     /// Clears the soft target.
     /// </summary>
+    [Obsolete("Use SoftTarget Property", false)]
     public void ClearSoftTarget() => this.SetSoftTarget(IntPtr.Zero);
 }

Dalamud/Plugin/Services/ITargetManager.cs

@@ -0,0 +1,44 @@
+using Dalamud.Game.ClientState.Objects.Types;
+
+namespace Dalamud.Game.ClientState.Objects;
+
+/// <summary>
+/// Get and set various kinds of targets for the player.
+/// </summary>
+public interface ITargetManager
+{
+    /// <summary>
+    /// Gets the address of the target manager.
+    /// </summary>
+    public nint Address { get; }
+
+    /// <summary>
+    /// Gets or sets the current target.
+    /// Set to null to clear the target.
+    /// </summary>
+    public GameObject? Target { get; set; }
+
+    /// <summary>
+    /// Gets or sets the mouseover target.
+    /// Set to null to clear the target.
+    /// </summary>
+    public GameObject? MouseOverTarget { get; set; }
+
+    /// <summary>
+    /// Gets or sets the focus target.
+    /// Set to null to clear the target.
+    /// </summary>
+    public GameObject? FocusTarget { get; set; }
+
+    /// <summary>
+    /// Gets or sets the previous target.
+    /// Set to null to clear the target.
+    /// </summary>
+    public GameObject? PreviousTarget { get; set; }
+
+    /// <summary>
+    /// Gets or sets the soft target.
+    /// Set to null to clear the target.
+    /// </summary>
+    public GameObject? SoftTarget { get; set; }
+}