fix: more tweaks

Author: brunomikoski

CHANGELOG.MD

@@ -6,6 +6,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.3.1]
+### Added
+- Added Addressables support again, now you if addressables is available on your project and the collection is set to non auto loaded, and the collection is set to use addressables, will write some helper code on the static file to load the collectiom from the addressables.
+- Added a Addressables Sample project as well
+- Added Reset Settings context menu option
+- Added the Write Addressable Loading Methods toggle for the collection~~~~
+
+### Changed
+- Updated the visuals of the CollectionEditor again, make it a bit tighter and more readable
+- Refactored the settings again (sorry, some settings will be lost again) to make the system more extensible and easier to maintain
+
+
 ## [2.3.0]
 ### Changed
 - Refactored CollectionCustomEditor to use UI Elements, getting rid of multiple hacks to make it work with the IMGUI and Reorderable list
@@ -541,6 +553,7 @@ public bool IsValidConsumable(Consumable consumable)
 ### Added 
  - First initial working version 
 
+[2.3.1]: https://github.com/badawe/ScriptableObjectCollection/releases/tag/v2.3.1
 [2.3.0]: https://github.com/badawe/ScriptableObjectCollection/releases/tag/v2.3.0
 [2.2.4]: https://github.com/badawe/ScriptableObjectCollection/releases/tag/v2.2.4
 [2.2.3]: https://github.com/badawe/ScriptableObjectCollection/releases/tag/v2.2.3

Editor/UXML/CollectionCustomEditorTreeAsset.uxml

@@ -15,14 +15,15 @@
     </ui:VisualElement>
     <ui:VisualElement name="BottonGroup">
         <ui:Instance template="GroupBoxVisualElement" name="GroupBoxVisualElement">
-            <ui:VisualElement style="flex-grow: 1; border-top-left-radius: 0; border-top-right-radius: 0; border-bottom-right-radius: 0; border-bottom-left-radius: 0; padding-top: 10px; padding-right: 10px; padding-bottom: 10px; padding-left: 10px;">
+            <ui:VisualElement name="advanced-options-visual-element" style="flex-grow: 1; border-top-left-radius: 0; border-top-right-radius: 0; border-bottom-right-radius: 0; border-bottom-left-radius: 0; padding-top: 10px; padding-right: 10px; padding-bottom: 10px; padding-left: 10px;">
                 <ui:Toggle label="Automaticaly Loaded" name="automatic-loaded-toggle" binding-path="automaticallyLoaded" tooltip="When enabled, this is automatically loaded by the system when the registry loads from Resources/Addressables. If disabled, it is removed prior to playtime and the reference is deleted from the registry at build time." class="unity-base-field__aligned" style="flex-grow: 0; -unity-font-style: normal;" />
                 <ui:Toggle label="Write as Partial Class" name="write-partial-class-toggle" tooltip="If enabled, attempts to declare the new static class as partial, allowing direct usage from the same type. This option is disabled when the class or generated file resides in a different assembly." class="unity-base-field__aligned" />
                 <ui:Toggle label="Use Base Class for Items" name="base-class-for-items-toggle" tooltip="If enabled, this will enforce the use of the base type in the static file declaration, regardless of any objects extending it to a child type." class="unity-base-field__aligned" />
                 <ui:Toggle label="Enforce Indirect Access" name="enforce-indirect-access" tooltip="Useful if the collection is not auto-loaded, loaded through addressables, or if better memory management is desired. This setting ensures that there are no direct references to the scriptable object." class="unity-base-field__aligned" />
                 <uie:ObjectField label="Generated Scripts Folde" type="UnityEditor.DefaultAsset, UnityEditor.CoreModule" allow-scene-objects="false" name="generated-scripts-parent-folder" tooltip="Specifies the target folder for generating the static file access. If left null, the file will be generated in the same location as the original file." class="unity-base-field__aligned" />
                 <ui:TextField picking-mode="Ignore" label="Static Filename" value="filler text" name="static-filename-textfield" is-delayed="true" class="unity-base-field__aligned" />
                 <ui:TextField picking-mode="Ignore" label="Namespace" value="filler text" name="namespace-textfield" is-delayed="true" class="unity-base-field__aligned" />
+                <ui:Toggle label="Generate Addressables Loading Methods" name="write-addressables-load-toggle" class="unity-base-field__aligned" />
             </ui:VisualElement>
             <ui:VisualElement style="flex-grow: 1; flex-direction: row; height: 26px; border-top-left-radius: 0; border-top-right-radius: 0; border-bottom-right-radius: 0; border-bottom-left-radius: 0;">
                 <ui:Button text="Generate Static File" parse-escape-sequences="true" display-tooltip-when-elided="true" tooltip="Uses Code Generation to generate the Static File to access collection items by code." name="generate-static-file-button" style="flex-grow: 1; padding-right: 0; padding-left: -2px; margin-top: 0; margin-right: 0; margin-bottom: 0; margin-left: 0; padding-top: 0; padding-bottom: 0; border-bottom-right-radius: 0; border-bottom-left-radius: 4px; border-top-left-radius: 0; border-top-right-radius: 0;" />

Scripts/Editor/Core/CodeGenerationUtility.cs

@@ -574,8 +574,12 @@ private static void WriteNonAutomaticallyLoadedCollectionItems(ScriptableObjectC
             AppendLine(writer, indentation, "}");
 
             AppendLine(writer, indentation);
-            
-            
+
+
+            if (!SOCSettings.Instance.GetWriteAddressableLoadingMethods(collection))
+            {
+                return;
+            }
 #if ADDRESSABLES_ENABLED
             string assetPath = AssetDatabase.GetAssetPath(collection);
             AddressableAssetSettings settings = AddressableAssetSettingsDefaultObject.Settings;

Scripts/Editor/Core/CollectionSettings.cs

@@ -15,6 +15,10 @@ public class CollectionSettings
         public bool UseBaseClassForItems;
         public bool EnforceIndirectAccess;
 
+        private bool writeAddressableLoadingMethods;
+        public bool WriteAddressableLoadingMethods => !CollectionsRegistry.Instance.GetCollectionByGUID(Guid).AutomaticallyLoaded && writeAddressableLoadingMethods;
+
+
         public CollectionSettings(ScriptableObjectCollection targetCollection)
         {
             Guid = targetCollection.GUID;
@@ -46,5 +50,10 @@ public CollectionSettings(ScriptableObjectCollection targetCollection)
             UseBaseClassForItems = false;
             EnforceIndirectAccess = false;
         }
+
+        public void SetWriteAddressableLoadingMethods(bool evtNewValue)
+        {
+            writeAddressableLoadingMethods = evtNewValue;
+        }
     }
 }

Scripts/Editor/Core/SOCSettings.cs

@@ -303,5 +303,17 @@ public void ResetSettings(ScriptableObjectCollection collection)
                 return;
             }
         }
+
+        public void SetWriteAddressableLoadingMethods(ScriptableObjectCollection collection, bool evtNewValue)
+        {
+            CollectionSettings settings = GetOrCreateCollectionSettings(collection);
+            settings.SetWriteAddressableLoadingMethods(evtNewValue);
+            Save();
+        }
+
+        public bool GetWriteAddressableLoadingMethods(ScriptableObjectCollection collection)
+        {
+            return GetOrCreateCollectionSettings(collection).WriteAddressableLoadingMethods;
+        }
     }
 }

Scripts/Editor/CustomEditors/CollectionCustomEditor.cs

@@ -1,9 +1,14 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Text;
 using System.Text.RegularExpressions;
 using JetBrains.Annotations;
 using UnityEditor;
+#if ADDRESSABLES_ENABLED
+using UnityEditor.AddressableAssets;
+using UnityEditor.AddressableAssets.Settings;
+#endif
 using UnityEditor.Compilation;
 using UnityEditor.UIElements;
 using UnityEngine;
@@ -43,6 +48,9 @@ public class CollectionCustomEditor : Editor
         private Button expandShrinkButton;
 
         private List<ScriptableObject> filteredItems = new();
+        
+        private HelpBox helpbox;
+        private Toggle writeAddressablesToggle;
 
         protected virtual bool CanBeReorderable
         {
@@ -158,7 +166,12 @@ public override VisualElement CreateInspectorGUI()
             generateItemsButton.RegisterCallback<MouseUpEvent>(OnClickGenerateItems);
             generateItemsButton.style.display = generatorType != null ? DisplayStyle.Flex : DisplayStyle.None;
 
-
+            Toggle automaticLoadToggle = root.Q<Toggle>("automatic-loaded-toggle");
+            automaticLoadToggle.RegisterValueChangedCallback(evt =>
+            {
+                UpdateHelpBox();
+            });
+            
             Toggle writeAsPartialClass = root.Q<Toggle>("write-partial-class-toggle");
             writeAsPartialClass.value = SOCSettings.Instance.GetWriteAsPartialClass(collection);
             writeAsPartialClass.SetEnabled(CodeGenerationUtility.CheckIfCanBePartial(collection));
@@ -198,6 +211,7 @@ public override VisualElement CreateInspectorGUI()
             enforceIndirectAccessToggle.RegisterValueChangedCallback(evt =>
             {
                 SOCSettings.Instance.SetEnforceIndirectAccess(collection, evt.newValue);
+                UpdateHelpBox();
             });
 
 
@@ -210,7 +224,27 @@ public override VisualElement CreateInspectorGUI()
             InspectorElement.FillDefaultInspector(imguiContainer, serializedObject, this);
 
 
+            VisualElement advancedOptionsVisualElement = root.Q<VisualElement>("advanced-options-visual-element");
+            helpbox = new HelpBox
+            {
+                style =
+                {
+                    display = DisplayStyle.None
+                }
+            };
+
+            advancedOptionsVisualElement.Add(helpbox);
 
+            writeAddressablesToggle = root.Q<Toggle>("write-addressables-load-toggle");
+            writeAddressablesToggle.style.display = IsAddressableAsset(collection) && !automaticLoadToggle.value ? DisplayStyle.Flex : DisplayStyle.None;
+            writeAddressablesToggle.SetValueWithoutNotify(SOCSettings.Instance.GetWriteAddressableLoadingMethods(collection));
+            writeAddressablesToggle.RegisterValueChangedCallback(evt =>
+            {
+                SOCSettings.Instance.SetWriteAddressableLoadingMethods(collection, evt.newValue);
+                UpdateHelpBox();
+            });
+            
+            
             expandShrinkButton = root.Q<Button>("expand-button");
 
             expandShrinkButton.clickable.activators.Clear();
@@ -219,6 +253,8 @@ public override VisualElement CreateInspectorGUI()
             ToolbarSearchField toolbarSearchField = root.Q<ToolbarSearchField>();
             toolbarSearchField.RegisterValueChangedCallback(OnSearchInputChanged);
 
+            UpdateHelpBox();
+
             return root;
         }
 
@@ -469,6 +505,60 @@ private void OnSearchValueChanged(string targetText)
 
             collectionItemListView.RefreshItems();
         }
+        
+        
+        private void UpdateHelpBox()
+        {
+            bool isAddressableAsset = IsAddressableAsset(collection);
+
+            HelpBoxMessageType helpBoxMessageType = HelpBoxMessageType.Warning;
+
+            StringBuilder finalMessage = new StringBuilder();
+            
+            if (isAddressableAsset && !collection.AutomaticallyLoaded && !SOCSettings.Instance.GetWriteAddressableLoadingMethods(collection))
+            {
+                finalMessage.AppendLine("You can use the Write Addressable Loading Methods to generate the loading methods for this collection.");
+                helpBoxMessageType = HelpBoxMessageType.Info;
+            }
+
+            if (isAddressableAsset && collection.AutomaticallyLoaded)
+            {
+                finalMessage.AppendLine(
+                    "This collection is set to be automatically loaded but it's also an Addressables asset, Maybe this should be set to be load manually ");
+                
+                helpBoxMessageType = HelpBoxMessageType.Warning;
+            }
+
+            if (isAddressableAsset && !collection.AutomaticallyLoaded && !SOCSettings.Instance.GetEnforceIndirectAccess(collection))
+            {
+                finalMessage.AppendLine("This collection is an not automatically loaded Addressables asset, you should consider enforcing indirect access to avoid loading all the items at once.");
+                
+                helpBoxMessageType = HelpBoxMessageType.Warning;
+            }
+
+            if (finalMessage.Length > 0)
+            {
+                helpbox.style.display = DisplayStyle.Flex;
+                helpbox.messageType = helpBoxMessageType;
+                helpbox.text = finalMessage.ToString();
+            }
+            else
+            {
+                helpbox.style.display = DisplayStyle.None;
+            }
+        }
+
+        private bool IsAddressableAsset(ScriptableObject target)
+        {
+#if ADDRESSABLES_ENABLED
+            string assetPath = AssetDatabase.GetAssetPath(target);
+            AddressableAssetSettings settings = AddressableAssetSettingsDefaultObject.Settings;
+            AddressableAssetEntry entry = settings.FindAssetEntry(AssetDatabase.AssetPathToGUID(assetPath));
+            return entry != null;
+#else
+            return false;
+#endif
+        }
 
         private ScriptableObject AddNewItemOfType(Type targetType, bool autoFocusForRename = true)
         {