Merge remote-tracking branch 'upstream/master' into feature/inotificationmanager

Dalamud/Plugin/Services/IContextMenu.cs

@@ -0,0 +1,37 @@
+using Dalamud.Game.Gui.ContextMenu;
+using Dalamud.Game.Text;
+using Dalamud.Game.Text.SeStringHandling;
+
+namespace Dalamud.Plugin.Services;
+
+/// <summary>
+/// This class provides methods for interacting with the game's context menu.
+/// </summary>
+public interface IContextMenu
+{
+    /// <summary>
+    /// A delegate type used for the <see cref="OnMenuOpened"/> event.
+    /// </summary>
+    /// <param name="args">Information about the currently opening menu.</param>
+    public delegate void OnMenuOpenedDelegate(MenuOpenedArgs args);
+
+    /// <summary>
+    /// Event that gets fired every time the game framework updates.
+    /// </summary>
+    event OnMenuOpenedDelegate OnMenuOpened;
+
+    /// <summary>
+    /// Adds a menu item to a context menu.
+    /// </summary>
+    /// <param name="menuType">The type of context menu to add the item to.</param>
+    /// <param name="item">The item to add.</param>
+    void AddMenuItem(ContextMenuType menuType, MenuItem item);
+
+    /// <summary>
+    /// Removes a menu item from a context menu.
+    /// </summary>
+    /// <param name="menuType">The type of context menu to remove the item from.</param>
+    /// <param name="item">The item to add.</param>
+    /// <returns><see langword="true"/> if the item was removed, <see langword="false"/> if it was not found.</returns>
+    bool RemoveMenuItem(ContextMenuType menuType, MenuItem item);
+}

Dalamud/Plugin/Services/IFramework.cs

@@ -29,6 +29,11 @@ public interface IFramework
     /// </summary>
     public DateTime LastUpdateUTC { get; }
 
+    /// <summary>
+    /// Gets a <see cref="TaskFactory"/> that runs tasks during Framework Update event.
+    /// </summary>
+    public TaskFactory FrameworkThreadTaskFactory { get; }
+
     /// <summary>
     /// Gets the delta between the last Framework Update and the currently executing one.
     /// </summary>
@@ -44,6 +49,14 @@ public interface IFramework
     /// </summary>
     public bool IsFrameworkUnloading { get; }
 
+    /// <summary>
+    /// Returns a task that completes after the given number of ticks. 
+    /// </summary>
+    /// <param name="numTicks">Number of ticks to delay.</param>
+    /// <param name="cancellationToken">The cancellation token.</param>
+    /// <returns>A new <see cref="Task"/> that gets resolved after specified number of ticks happen.</returns>
+    public Task DelayTicks(long numTicks, CancellationToken cancellationToken = default);
+
     /// <summary>
     /// Run given function right away if this function has been called from game's Framework.Update thread, or otherwise run on next Framework.Update call.
     /// </summary>
@@ -65,6 +78,7 @@ public interface IFramework
     /// <typeparam name="T">Return type.</typeparam>
     /// <param name="func">Function to call.</param>
     /// <returns>Task representing the pending or already completed function.</returns>
+    [Obsolete($"Use {nameof(RunOnTick)} instead.")]
     public Task<T> RunOnFrameworkThread<T>(Func<Task<T>> func);
 
     /// <summary>
@@ -72,6 +86,7 @@ public interface IFramework
     /// </summary>
     /// <param name="func">Function to call.</param>
     /// <returns>Task representing the pending or already completed function.</returns>
+    [Obsolete($"Use {nameof(RunOnTick)} instead.")]
     public Task RunOnFrameworkThread(Func<Task> func);
 
     /// <summary>