Add default pagination methods to core package with defaults controlled by ML config

Author: Banane9

MonkeyLoader.Resonite.Core/UI/ContextMenuPaginationExtensions.cs

@@ -14,6 +14,27 @@ public static class ContextMenuPaginationExtensions
     {
         private static readonly ConditionalWeakTable<ContextMenu, PaginationInfo> _paginationInfosByContextMenu = [];
 
+        internal static Func<int> GetDefaultMaxItems { get; set; } = static () => 14;
+
+        internal static Func<bool> GetLimitContextMenuItems { get; set; } = static () => true;
+
+        /// <summary>
+        /// Gets the current default maximum number of non-pagination items to show per page, not including the paging buttons.<br/>
+        /// This means that up to <c>value + 2</c> non-pagination items will be displayed without pagination.
+        /// </summary>
+        /// <remarks>
+        /// This value may change between calls.
+        /// </remarks>
+        public static int DefaultMaxItems => GetDefaultMaxItems();
+
+        /// <summary>
+        /// Gets whether the number of items in the context menu should be limited and pagination buttons added for anything beyond that.
+        /// </summary>
+        /// <remarks>
+        /// This value may change between calls.
+        /// </remarks>
+        public static bool LimitContextMenuItems => GetLimitContextMenuItems();
+
         /// <inheritdoc cref="AddPagination(ContextMenu, int, int, out ContextMenuItem, out ContextMenuItem)"/>
         public static void AddPagination(this ContextMenu contextMenu, int maxItems, int currentPage = 0)
             => contextMenu.AddPagination(maxItems, currentPage, out _, out _);
@@ -43,6 +64,75 @@ public static void AddPagination(this ContextMenu contextMenu, int maxItems, int
                 throw new InvalidOperationException("Failed to add pagination!");
         }
 
+        /// <remarks>
+        /// This version automatically uses the <see cref="DefaultMaxItems">DefaultMaxItems</see> for pagination, if wanted by the user.
+        /// </remarks>
+        /// <inheritdoc cref="AddPagination(ContextMenu, int, int, out ContextMenuItem, out ContextMenuItem)"/>
+        public static void AddDefaultPagination(this ContextMenu contextMenu, int currentPage = 0)
+        {
+            if (LimitContextMenuItems)
+                contextMenu.AddPagination(DefaultMaxItems, currentPage, out _, out _);
+        }
+
+        /// <remarks>
+        /// This version automatically uses the <see cref="DefaultMaxItems">DefaultMaxItems</see> for pagination, if wanted by the user.
+        /// </remarks>
+        /// <inheritdoc cref="AddPagination(ContextMenu, int, int, out ContextMenuItem, out ContextMenuItem)"/>
+        public static void AddDefaultPagination(this ContextMenu contextMenu, int currentPage,
+            out ContextMenuItem? back, out ContextMenuItem? forward)
+        {
+            back = null;
+            forward = null;
+
+            if (LimitContextMenuItems)
+                contextMenu.AddPagination(DefaultMaxItems, currentPage, out back, out forward);
+        }
+
+        /// <remarks>
+        /// This version automatically uses the <see cref="DefaultMaxItems">DefaultMaxItems</see> for pagination, if wanted by the user.
+        /// </remarks>
+        /// <inheritdoc cref="TryAddPagination(ContextMenu, int, int)"/>
+        public static bool TryAddDefaultPagination(this ContextMenu contextMenu, int currentPage = 0)
+        {
+            if (!LimitContextMenuItems)
+                return false;
+
+            return contextMenu.TryAddPagination(DefaultMaxItems, currentPage);
+        }
+
+        /// <remarks>
+        /// This version automatically uses the <see cref="DefaultMaxItems">DefaultMaxItems</see> for pagination, if wanted by the user.
+        /// </remarks>
+        /// <inheritdoc cref="TryAddPagination(ContextMenu, int, int, out ContextMenuItem?, out ContextMenuItem?)"/>
+        public static bool TryAddDefaultPagination(this ContextMenu contextMenu, int currentPage,
+                [NotNullWhen(true)] out ContextMenuItem? back, [NotNullWhen(true)] out ContextMenuItem? forward)
+        {
+            back = null;
+            forward = null;
+
+            if (!LimitContextMenuItems)
+                return false;
+
+            return contextMenu.TryAddPagination(DefaultMaxItems, currentPage, out back, out forward);
+        }
+
+        /// <remarks>
+        /// This version automatically uses the <see cref="DefaultMaxItems">DefaultMaxItems</see> for pagination, if wanted by the user.
+        /// </remarks>
+        /// <inheritdoc cref="TryAddPagination(ContextMenu, ref int, ref int, bool, out ContextMenuItem?, out ContextMenuItem?)"/>
+        public static bool TryAddDefaultPagination(this ContextMenu contextMenu, out int maxItems, ref int currentPage, bool forceNew,
+            [NotNullWhen(true)] out ContextMenuItem? back, [NotNullWhen(true)] out ContextMenuItem? forward)
+        {
+            back = null;
+            forward = null;
+            maxItems = DefaultMaxItems;
+
+            if (!LimitContextMenuItems)
+                return false;
+
+            return contextMenu.TryAddPagination(ref maxItems, ref currentPage, forceNew, out back, out forward);
+        }
+
         /// <summary>
         /// Tries to add pagination with the given configuration to this context menu.<br/>
         /// If there already is pagination, nothing happens.
@@ -60,7 +150,7 @@ public static bool TryAddPagination(this ContextMenu contextMenu, int maxItems,
         /// <param name="currentPage">The page that should be shown from the start. Can be any integer value, even negative.</param>
         /// <inheritdoc cref="TryAddPagination(ContextMenu, ref int, ref int, bool, out ContextMenuItem?, out ContextMenuItem?)"/>
         public static bool TryAddPagination(this ContextMenu contextMenu, int maxItems, int currentPage,
-            [NotNullWhen(true)] out ContextMenuItem? back, [NotNullWhen(true)] out ContextMenuItem? forward)
+                [NotNullWhen(true)] out ContextMenuItem? back, [NotNullWhen(true)] out ContextMenuItem? forward)
             => contextMenu.TryAddPagination(ref maxItems, ref currentPage, false, out back, out forward);
 
         /// <summary>

MonkeyLoader.Resonite.Integration/UI/ContextMenus/ContextMenuInjector.cs

@@ -11,6 +11,9 @@ internal sealed class ContextMenuInjector : ResoniteAsyncEventSourceMonkey<Conte
     {
         protected override bool OnLoaded()
         {
+            ContextMenuPaginationExtensions.GetDefaultMaxItems = static () => ContextMenusConfig.Instance.ContextMenuItemLimit;
+            ContextMenuPaginationExtensions.GetLimitContextMenuItems = static () => ContextMenusConfig.Instance.LimitContextMenuItems;
+
             ContextMenuItemsGenerationEvent.AddConcreteEvent<InspectorMemberActions>(static contextMenu => new InspectorMemberActionsMenuItemsGenerationEvent(contextMenu), true);
 
             ContextMenuItemsGenerationEvent.AddConcreteEvent(typeof(FieldDriveReceiver<>), DriveReceiverMenuItemsGenerationEvent.CreateForDriveReceiver);

MonkeyLoader.Resonite.Integration/UI/ContextMenus/ContextMenuItemsGenerationEvent.cs

@@ -188,7 +188,10 @@ public void CloseContextMenu()
         /// </summary>
         /// <remarks>
         /// If <paramref name="options"/>.<see cref="ContextMenuOptions.keepPosition">keepPosition</see>
-        /// is <c>true</c> the last position will be kept instead.
+        /// is <c>true</c> the last position will be kept instead.<br/>
+        /// This will automatically <see cref="ContextMenuPaginationExtensions.TryAddPagination(ContextMenu, int, int)">
+        /// add pagination</see> to the opened ContextMenu if the user's
+        /// <see cref="ContextMenusConfig.LimitContextMenuItems">settings</see> call for it.
         /// </remarks>
         /// <param name="pointer">
         /// The slot that the <see cref="FrooxEngine.ContextMenu"/> will be centered at.<br/>
@@ -197,7 +200,15 @@ public void CloseContextMenu()
         /// <param name="options">The additional options for opening the menu.</param>
         /// <returns>The opened <see cref="FrooxEngine.ContextMenu"/>, or <see langword="null"/> if it failed to open.</returns>
         public async Task<ContextMenu?> OpenContextMenuAsync(Slot pointer, ContextMenuOptions options = default)
-            => await ContextMenu.OpenMenu(Summoner, pointer, options) ? ContextMenu : null;
+        {
+            if (!await ContextMenu.OpenMenu(Summoner, pointer, options))
+                return null;
+
+            if (ContextMenusConfig.Instance.LimitContextMenuItems)
+                ContextMenu.TryAddPagination(ContextMenusConfig.Instance.ContextMenuItemLimit);
+
+            return ContextMenu;
+        }
 
         /// <summary>
         /// Opens the <see cref="SummoningUser">SummoningUser</see>'s <see cref="FrooxEngine.ContextMenu"/>

MonkeyLoader.Resonite.Integration/UI/ContextMenus/ContextMenusConfig.cs

@@ -1,7 +1,5 @@
-using FrooxEngine;
-using MonkeyLoader.Configuration;
+using MonkeyLoader.Configuration;
 using MonkeyLoader.Resonite.Configuration;
-using MonkeyLoader.Resonite.DataFeeds.Settings;
 
 namespace MonkeyLoader.Resonite.UI.ContextMenus
 {

MonkeyLoader.Resonite.Integration/UI/ContextMenus/InteractionHandlerContextMenuInjector.cs

@@ -5,7 +5,6 @@
 using HarmonyLib;
 using MonkeyLoader.Logging;
 using MonkeyLoader.Resonite.Events;
-using System.Collections.Immutable;
 using System.Runtime.CompilerServices;
 
 using static FrooxEngine.InteractionHandler;