UPM release 3.1.1

Author: git-upm-publisher

CHANGELOG.md

@@ -19,6 +19,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 
 
+## [3.1.1] - 2023-07-22
+
+### Fixed
+- Implemented workaround for a Unity bug that caused our settings page to throw exceptions and not display in Unity `2022.3.4f1`.
+
+
+
 ## [3.1.0] - 2023-07-08
 
 ### Added

Editor/AssemblyInfo.cs

@@ -1,4 +1,7 @@
-using UnityEngine.Scripting;
+using System.Runtime.CompilerServices;
+using UnityEngine.Scripting;
+
+[assembly: InternalsVisibleTo("Eflatun.SceneReference.DevelopmentUtils.Editor")]
 
 // Always link to make sure InitializeOnLoad methods don't get stripped away
 [assembly: AlwaysLinkAssembly]

Editor/SceneDataMapsGeneratorTriggers.cs

@@ -3,6 +3,8 @@
 
 namespace Eflatun.SceneReference.Editor
 {
+    // IMPORTANT: Keep SceneDataMapsGeneratorTriggers and InternalSceneDataMapsGeneratorTriggers in sync at all times.
+    
     /// <summary>
     /// Identifiers for places that trigger <see cref="SceneDataMapsGenerator"/>.
     /// </summary>
@@ -19,4 +21,17 @@ public enum SceneDataMapsGeneratorTriggers
         AfterPackagesResolve = 1 << 3,
         AfterAddressablesChange = 1 << 4,
     }
+    
+    /// <summary>
+    /// Same as <see cref="SceneDataMapsGeneratorTriggers"/>, but without the <c>All</c> and <c>None</c> values.
+    /// </summary>
+    [Flags]
+    internal enum InternalSceneDataMapsGeneratorTriggers
+    {
+        AfterSceneAssetChange = 1 << 0,
+        BeforeEnterPlayMode = 1 << 1,
+        BeforeBuild = 1 << 2,
+        AfterPackagesResolve = 1 << 3,
+        AfterAddressablesChange = 1 << 4,
+    }
 }

Editor/SettingsManager.cs

@@ -5,6 +5,7 @@
 using UnityEditor;
 using UnityEditor.SettingsManagement;
 using Newtonsoft.Json;
+using UnityEngine;
 
 namespace Eflatun.SceneReference.Editor
 {
@@ -60,7 +61,7 @@ public static class SceneDataMaps
             /// <inheritdoc cref="SettingsManager"/>
             /// </remarks>
             /// <seealso cref="IsGenerationTriggerEnabled"/>
-            [field: UserSetting(CategoryName, "Generation Triggers", "Controls when the scene data maps get regenerated.\n\n• AAfter Scene Asset Change: Regenerate the maps every time a scene asset changes (delete, create, move, rename).\n\n• Before Enter Play Mode: Regenerate the maps before entering play mode in the editor.\n\n• Before Build: Regenerate the maps before a build.\n\n• After Packages Resolve: Regenerate the maps after UPM packages are resolved.\n\n• After Addressables Change: Regenerate the maps after addressable group entries change. Only relevant if you have addressables support enabled.\n\nIt is recommended that you leave this option at 'All' unless you are debugging something. Failure to generate the maps when needed can result in broken scene references in runtime.\n\nNote: 'All' and 'Everything' are the same thing. They both represent all triggers.")]
+            [field: UserSetting]
             public static ProjectSetting<SceneDataMapsGeneratorTriggers> GenerationTriggers { get; }
                 = new ProjectSetting<SceneDataMapsGeneratorTriggers>("SceneDataMaps.GenerationTriggers", SceneDataMapsGeneratorTriggers.All);
 
@@ -90,6 +91,24 @@ public static class SceneDataMaps
             /// <seealso cref="GenerationTriggers"/>
             public static bool IsGenerationTriggerEnabled(SceneDataMapsGeneratorTriggers trigger) =>
                 GenerationTriggers.value.IncludesFlag(trigger);
+            
+            [UserSettingBlock(CategoryName)]
+            private static void Draw(string searchContext)
+            {
+                // Draw GenerationTriggers field.
+                {
+                    var oldPublic = GenerationTriggers.value;
+                    var oldInternal = (InternalSceneDataMapsGeneratorTriggers)oldPublic;
+                    var label = new GUIContent("Generation Triggers", "Controls when the scene data maps get regenerated.\n\n• After Scene Asset Change: Regenerate the maps every time a scene asset changes (delete, create, move, rename).\n\n• Before Enter Play Mode: Regenerate the maps before entering play mode in the editor.\n\n• Before Build: Regenerate the maps before a build.\n\n• After Packages Resolve: Regenerate the maps after UPM packages are resolved.\n\n• After Addressables Change: Regenerate the maps after addressable group entries change. Only relevant if you have addressables support enabled.\n\nIt is recommended that you leave this option at 'All' unless you are debugging something. Failure to generate the maps when needed can result in broken scene references in runtime.\n\nNote: 'All' and 'Everything' are the same thing. They both represent all triggers.");
+                    var newInternal = EditorGUILayout.EnumFlagsField(label, oldInternal);
+                    SettingsGUILayout.DoResetContextMenuForLastRect(GenerationTriggers);
+                    var newPublic = (SceneDataMapsGeneratorTriggers)newInternal;
+                    if (newPublic != oldPublic)
+                    {
+                        GenerationTriggers.value = newPublic;
+                    }
+                }
+            }
         }
 
         /// <summary>

README.md

@@ -20,9 +20,11 @@
 <br>
 
 <p align="center">
-  <a href="https://github.com/starikcetin/Eflatun.SceneReference/"><img src="https://img.shields.io/static/v1?label=GitHub&logo=github&message=Eflatun.SceneReference&color=blueviolet" alt="GitHub badge"/></a>
+  <a href="https://github.com/starikcetin/Eflatun.SceneReference/"><img src="https://img.shields.io/static/v1?color=6243c4&label=GitHub&message=Eflatun.SceneReference" alt="GitHub badge"/></a>
   &nbsp;
-  <a href="https://openupm.com/packages/com.eflatun.scenereference/"><img src="https://img.shields.io/npm/v/com.eflatun.scenereference?label=OpenUPM&logo=unity&registry_uri=https://package.openupm.com" alt="OpenUPM badge"/></a>
+  <a href="https://openupm.com/packages/com.eflatun.scenereference/"><img src="https://img.shields.io/npm/v/com.eflatun.scenereference?color=6243c4&label=OpenUPM&registry_uri=https://package.openupm.com" alt="OpenUPM badge"/></a>
+  &nbsp;
+  <a href="https://openupm.com/packages/com.eflatun.scenereference/"><img src="https://img.shields.io/badge/dynamic/json?color=6243c4&label=Downloads&suffix=/month&query=$.downloads&url=https://package.openupm.com/Downloads/point/last-month/com.eflatun.scenereference" alt="Monthly downloads badge"/></a>
 </p>
 <br>
 
@@ -46,13 +48,13 @@ openupm add com.eflatun.scenereference
 
 ### With Git URL
 
-Add the following line to the `dependencies` section of your project's `manifest.json` file. Replace `3.1.0` with the version you want to install.
+Add the following line to the `dependencies` section of your project's `manifest.json` file. Replace `3.1.1` with the version you want to install.
 
 ```json
-"com.eflatun.scenereference": "git+https://github.com/starikcetin/Eflatun.SceneReference.git#3.1.0"
+"com.eflatun.scenereference": "git+https://github.com/starikcetin/Eflatun.SceneReference.git#3.1.1"
 ```
 
-_Although it is highly discouraged, you can replace `3.1.0` with `upm` to get the latest version instead of a specific one._
+_Although it is highly discouraged, you can replace `3.1.1` with `upm` to get the latest version instead of a specific one._
 
 ## Ignore Auto-Generated Map Files in Version Control
 

Runtime/AssemblyInfo.cs

@@ -1,11 +1,9 @@
 using System.Runtime.CompilerServices;
 using UnityEngine.Scripting;
 
-// Make internals visible to the Editor assembly
 [assembly: InternalsVisibleTo("Eflatun.SceneReference.Editor")]
-
-// Make internals visible to the runtime tests assembly
 [assembly: InternalsVisibleTo("Eflatun.SceneReference.Tests.Runtime")]
+[assembly: InternalsVisibleTo("Eflatun.SceneReference.DevelopmentUtils.Editor")]
 
 // Always link to make sure RuntimeInitializeOnLoadMethod methods don't get stripped away
 [assembly: AlwaysLinkAssembly]

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "com.eflatun.scenereference",
-	"version": "3.1.0",
+	"version": "3.1.1",
 	"displayName": "Eflatun.SceneReference",
 	"description": "Scene References for Runtime and Editor. Strongly typed, robust, and reliable. Provides Asset GUID, Scene Path, Build Index, and Scene Name.\nhttps://github.com/starikcetin/Eflatun.SceneReference",
 	"documentationUrl": "https://github.com/starikcetin/Eflatun.SceneReference/blob/main/README.md",