Add config key enabled source component to sync the generated item(s)' enabled state with a config key

Author: Banane9

MonkeyLoader.Resonite.Integration/Configuration/ConfigKeyCustomDataFeedItems.cs

@@ -9,12 +9,18 @@ namespace MonkeyLoader.Resonite.Configuration
     /// Represents a basic config key component which generate <see cref="DataFeedItem"/>s
     /// for the config key to represent themselves, rather than requiring default handling.
     /// </summary>
+    /// <inheritdoc cref="IConfigKeyCustomDataFeedItems{T}"/>
     public abstract class ConfigKeyCustomDataFeedItems<T> : IConfigKeyCustomDataFeedItems<T>
     {
+        /// <inheritdoc/>
+        public IDefiningConfigKey<T> ConfigKey { get; private set; } = null!;
+
         /// <summary>
-        /// Gets the config item that <see cref="DataFeedItem"/>s will be generated for.
+        /// Creates a new instance of this component in derived classes.
         /// </summary>
-        public IDefiningConfigKey<T> ConfigKey { get; private set; } = null!;
+        /// <inheritdoc cref="ConfigKeyCustomDataFeedItems{T}"/>
+        protected ConfigKeyCustomDataFeedItems()
+        { }
 
         /// <inheritdoc/>
         public abstract IAsyncEnumerable<DataFeedItem> Enumerate(IReadOnlyList<string> path, IReadOnlyList<string> groupKeys, string? searchPhrase, object? viewData);
@@ -44,6 +50,17 @@ protected virtual void OnInitialize(IDefiningConfigKey<T> entity)
     /// Defines the interface for config key components which generate <see cref="DataFeedItem"/>s
     /// for the config key to represent themselves, rather than requiring default handling.
     /// </summary>
+    /// <remarks>
+    /// Beware, that only the first of these components will be used,
+    /// should a <see cref="IDefiningConfigKey{T}">config key</see> have multiple.
+    /// </remarks>
+    /// <typeparam name="T">The type of the config item's value.</typeparam>
     public interface IConfigKeyCustomDataFeedItems<T> : IConfigKeyComponent<IDefiningConfigKey<T>>, ICustomDataFeedItems
-    { }
+    {
+        /// <summary>
+        /// Gets the config item that <see cref="DataFeedItem"/>s will be
+        /// <see cref="ICustomDataFeedItems.Enumerate">enumerated</see> for.
+        /// </summary>
+        public IDefiningConfigKey<T> ConfigKey { get; }
+    }
 }

MonkeyLoader.Resonite.Integration/Configuration/ConfigKeyEnabledSource.cs

@@ -0,0 +1,43 @@
+using FrooxEngine;
+using MonkeyLoader.Configuration;
+using MonkeyLoader.Resonite.DataFeeds.Settings;
+
+namespace MonkeyLoader.Resonite.Configuration
+{
+    /// <summary>
+    /// Implements a <see cref="IConfigKeyCustomDataFeedItems{T}">custom data feed items component</see>
+    /// that will use another config key as the <see cref="ConfigToSettingsExtensions.WithEnabledSource">enabled source</see>
+    /// for the default items generated for the <see cref="ConfigKeyCustomDataFeedItems{T}.ConfigKey">ConfigKey</see>.
+    /// </summary>
+    /// <typeparam name="T">The type of the config key </typeparam>
+    /// <inheritdoc/>
+    public sealed class ConfigKeyEnabledSource<T> : ConfigKeyCustomDataFeedItems<T>
+    {
+        /// <summary>
+        /// Gets the config item that will be used as the
+        /// <see cref="ConfigToSettingsExtensions.WithEnabledSource{TDataFeedItem}(TDataFeedItem, IDefiningConfigKey{bool})">enabled source</see>
+        /// for the default items generated for the <see cref="ConfigKeyCustomDataFeedItems{T}.ConfigKey">ConfigKey</see>.
+        /// </summary>
+        public IDefiningConfigKey<bool> EnabledSource { get; }
+
+        /// <summary>
+        /// Creates a new instance of this <see cref="IConfigKeyCustomDataFeedItems{T}">custom data feed items component</see>
+        /// that will use the given <see cref="IDefiningConfigKey{T}">config key</see> as the
+        /// <see cref="ConfigToSettingsExtensions.WithEnabledSource{TDataFeedItem}(TDataFeedItem, IDefiningConfigKey{bool})">enabled source</see>
+        /// for the default items generated for the <see cref="ConfigKeyCustomDataFeedItems{T}.ConfigKey">ConfigKey</see>.
+        /// </summary>
+        /// <param name="enabledSource"></param>
+        /// <inheritdoc cref="ConfigKeyCustomDataFeedItems{T}"/>
+        public ConfigKeyEnabledSource(IDefiningConfigKey<bool> enabledSource)
+        {
+            EnabledSource = enabledSource;
+        }
+
+        /// <inheritdoc/>
+        public override async IAsyncEnumerable<DataFeedItem> Enumerate(IReadOnlyList<string> path, IReadOnlyList<string> groupKeys, string? searchPhrase, object? viewData)
+        {
+            await foreach (var feedItem in ConfigKey.EnumerateDefaultItemsAsync(path, groupKeys))
+                yield return feedItem.WithEnabledSource(EnabledSource);
+        }
+    }
+}

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

@@ -34,8 +34,7 @@ public sealed class ContextMenusConfig : SingletonConfigSection<ContextMenusConf
         {
             _itemLimitSubgroup,
             new ConfigKeyPriority(8),
-            new ConfigKeyRange<int>(3, 32),
-            new LimitContextMenuItemsToggleLink()
+            new ConfigKeyRange<int>(3, 32)
         };
 
         private readonly DefiningConfigKey<bool> _limitContextMenuItems = new("LimitContextMenuItems", "Limit the number of items shown in the context menu. If the configured number is exceeded, the menu will get paginated.", () => true)
@@ -47,8 +46,7 @@ public sealed class ContextMenusConfig : SingletonConfigSection<ContextMenusConf
         private readonly DefiningConfigKey<bool> _showResetScaleWithToggle = new("ShowResetScaleWithToggle", "Show the reset scale action alongside the scaling toggle when it is always allowed.", () => true)
         {
             _scalingSubgroup,
-            new ConfigKeyPriority(6),
-            new AlwaysAllowScaleToggleLink()
+            new ConfigKeyPriority(6)
         };
 
         private readonly DefiningConfigKey<bool> _showSaveLocation = new("ShowSaveLocation", "Show the current inventory path when trying to save something.", () => true)
@@ -108,28 +106,11 @@ public sealed class ContextMenusConfig : SingletonConfigSection<ContextMenusConf
         /// <inheritdoc/>
         public override Version Version { get; } = new(1, 1, 0);
 
-        private sealed class AlwaysAllowScaleToggleLink : ConfigKeyCustomDataFeedItems<bool>
-        {
-            public override async IAsyncEnumerable<DataFeedItem> Enumerate(IReadOnlyList<string> path, IReadOnlyList<string> groupKeys, string? searchPhrase, object? viewData)
-            {
-                await foreach (var item in ConfigKey.EnumerateDefaultItemsAsync(path, [.. groupKeys]))
-                {
-                    item.InitEnabled(field => field.SetupConfigKeyField(Instance._alwaysAllowScaleToggle));
-                    yield return item;
-                }
-            }
-        }
-
-        private sealed class LimitContextMenuItemsToggleLink : ConfigKeyCustomDataFeedItems<int>
+        /// <inheritdoc/>
+        public ContextMenusConfig()
         {
-            public override async IAsyncEnumerable<DataFeedItem> Enumerate(IReadOnlyList<string> path, IReadOnlyList<string> groupKeys, string? searchPhrase, object? viewData)
-            {
-                await foreach (var item in ConfigKey.EnumerateDefaultItemsAsync(path, groupKeys))
-                {
-                    item.InitEnabled(field => field.SetupConfigKeyField(Instance._limitContextMenuItems));
-                    yield return item;
-                }
-            }
+            _contextMenuItemLimit.Components.Add(new ConfigKeyEnabledSource<int>(_limitContextMenuItems));
+            _showResetScaleWithToggle.Components.Add(new ConfigKeyEnabledSource<bool>(_alwaysAllowScaleToggle));
         }
     }
 }

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

@@ -3,6 +3,7 @@
 using FrooxEngine.CommonAvatar;
 using FrooxEngine.UIX;
 using HarmonyLib;
+
 using static FrooxEngine.InteractionHandler;
 
 namespace MonkeyLoader.Resonite.UI.ContextMenus