Merge remote-tracking branch 'origin/master' into net8-rollup

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/IGameConfig.cs

@@ -1,14 +1,23 @@
-using System;
-using System.Diagnostics;
+using System.Diagnostics;
+using System.Threading.Tasks;
 
 using Dalamud.Game.Config;
-using FFXIVClientStructs.FFXIV.Common.Configuration;
+using Dalamud.Plugin.Internal.Types;
 
 namespace Dalamud.Plugin.Services;
 
 /// <summary>
 /// This class represents the game's configuration.
 /// </summary>
+/// <remarks>
+/// Accessing <see cref="GameConfigSection"/>-typed properties such as <see cref="System"/>, directly or indirectly
+/// via <see cref="TryGet(Game.Config.SystemConfigOption,out bool)"/>,
+/// <see cref="Set(Game.Config.SystemConfigOption,bool)"/>, or alike will block, if the game is not done loading.<br />
+/// Therefore, avoid accessing configuration from your plugin constructor, especially if your plugin sets
+/// <see cref="PluginManifest.LoadRequiredState"/> to <c>2</c> and <see cref="PluginManifest.LoadSync"/> to <c>true</c>.
+/// If property access from the plugin constructor is desired, do the value retrieval asynchronously via
+/// <see cref="IFramework.RunOnFrameworkThread{T}(Func{T})"/>; do not wait for the result right away.
+/// </remarks>
 public interface IGameConfig
 {
     /// <summary>