Simplify addressable scene loader contracts

Author: joaoborks

Runtime/Interfaces/IAddressableLoadSceneInfo.cs

@@ -1,29 +1,18 @@
 #if ENABLE_ADDRESSABLES
 /**
- * AddressableSceneLoader.cs
+ * IAddressableUnloadSceneInfo.cs
  * Created by: João Borks [joao.borks@gmail.com]
  * Created on: 8/24/2022 (en-US)
  */
 
-using UnityEngine.AddressableAssets;
 using UnityEngine.ResourceManagement.AsyncOperations;
 using UnityEngine.ResourceManagement.ResourceProviders;
-using UnityEngine.SceneManagement;
 
 namespace MyUnityTools.SceneLoading.AddressablesSupport
 {
-    /// <summary>
-    /// Interface to standardize addressable scene information.
-    /// Can be created with either the target scene's <see cref="AssetReference"/> (<see cref="AddressableLoadSceneInfoAsset"/>) or the scene's runtime key (<see cref="AddressableLoadSceneInfoKey"/>).
-    /// </summary>
     public interface IAddressableLoadSceneInfo
     {
-        /// <summary>
-        /// Loads the provided scene asynchronously.
-        /// Internally calls <see cref="Addressables.LoadSceneAsync(object, LoadSceneMode, bool, int)"/>.
-        /// </summary>
-        /// <returns>The load <see cref="AsyncOperationHandle{TObject}"/>.</returns>
-        AsyncOperationHandle<SceneInstance> LoadSceneAsync();
+        AsyncOperationHandle<SceneInstance> UnloadSceneAsync(IAddressableSceneManager sceneManager);
     }
 }
 #endif

Runtime/Interfaces/IAddressableLoadSceneInfo.cs.meta

@@ -0,0 +1,29 @@
+#if ENABLE_ADDRESSABLES
+/**
+ * IAddressableLoadSceneReference.cs
+ * Created by: João Borks [joao.borks@gmail.com]
+ * Created on: 8/24/2022 (en-US)
+ */
+
+using UnityEngine.AddressableAssets;
+using UnityEngine.ResourceManagement.AsyncOperations;
+using UnityEngine.ResourceManagement.ResourceProviders;
+using UnityEngine.SceneManagement;
+
+namespace MyUnityTools.SceneLoading.AddressablesSupport
+{
+    /// <summary>
+    /// Interface to standardize addressable scene information.
+    /// Can be created with either the target scene's <see cref="AssetReference"/> (<see cref="AddressableLoadSceneReferenceAsset"/>) or the scene's runtime key (<see cref="AddressableLoadSceneReferenceKey"/>).
+    /// </summary>
+    public interface IAddressableLoadSceneReference
+    {
+        /// <summary>
+        /// Loads the provided scene asynchronously.
+        /// Internally calls <see cref="Addressables.LoadSceneAsync(object, LoadSceneMode, bool, int)"/>.
+        /// </summary>
+        /// <returns>The load <see cref="AsyncOperationHandle{TObject}"/>.</returns>
+        AsyncOperationHandle<SceneInstance> LoadSceneAsync(IAddressableSceneManager sceneManager);
+    }
+}
+#endif

Runtime/Interfaces/IAddressableLoadSceneReference.cs

@@ -5,25 +5,17 @@
  * Created on: 8/23/2022 (en-US)
  */
 
-using UnityEngine.ResourceManagement.AsyncOperations;
-using UnityEngine.ResourceManagement.ResourceProviders;
-
 namespace MyUnityTools.SceneLoading.AddressablesSupport
 {
     public interface IAddressableSceneLoader
     {
-        void TransitionToScene(IAddressableLoadSceneInfo sceneInfo);
+        IAddressableSceneManager SceneManager { get; }
 
-        void SwitchToScene(IAddressableLoadSceneInfo sceneInfo);
+        void TransitionToScene(IAddressableLoadSceneReference targetSceneReference, IAddressableLoadSceneReference intermediateSceneReference = null);
 
-        void LoadScene(IAddressableLoadSceneInfo sceneInfo, bool setActive = false); 
+        void LoadScene(IAddressableLoadSceneReference sceneReference, bool setActive = false); 
 
-        void UnloadScene(AsyncOperationHandle<SceneInstance> sceneHandle);
-        void UnloadScene(SceneInstance scene);
-        void UnloadScene(string sceneName);
-
-        AsyncOperationHandle<SceneInstance> GetLoadedSceneHandle(SceneInstance sceneInstance);
-        AsyncOperationHandle<SceneInstance> GetLoadedSceneHandle(string sceneName);
+        void UnloadScene(IAddressableLoadSceneInfo sceneInfo);
     }
 }
 #endif

Runtime/Interfaces/IAddressableLoadSceneReference.cs.meta

@@ -6,22 +6,17 @@
  */
 
 using System.Threading.Tasks;
-using UnityEngine.ResourceManagement.AsyncOperations;
 using UnityEngine.ResourceManagement.ResourceProviders;
 
 namespace MyUnityTools.SceneLoading.AddressablesSupport
 {
     public interface IAddressableSceneLoaderAsync : IAddressableSceneLoader
     {
-        Task<SceneInstance> TransitionToSceneAsync(IAddressableLoadSceneInfo sceneInfo);
-        
-        Task<SceneInstance> SwitchToSceneAsync(IAddressableLoadSceneInfo sceneInfo);
+        Task<SceneInstance> TransitionToSceneAsync(IAddressableLoadSceneReference targetSceneReference, IAddressableLoadSceneReference intermediateSceneReference = null);
 
-        Task<SceneInstance> LoadSceneAsync(IAddressableLoadSceneInfo sceneInfo, bool setActive = false);
+        Task<SceneInstance> LoadSceneAsync(IAddressableLoadSceneReference sceneReference, bool setActive = false);
 
-        Task UnloadSceneAsync(AsyncOperationHandle<SceneInstance> sceneHandle);
-        Task UnloadSceneAsync(SceneInstance scene);
-        Task UnloadSceneAsync(string sceneName);
+        Task UnloadSceneAsync(IAddressableLoadSceneInfo sceneInfo);
     }
 }
 #endif

Runtime/Interfaces/IAddressableSceneLoader.cs

@@ -6,22 +6,17 @@
  */
 
 using Cysharp.Threading.Tasks;
-using UnityEngine.ResourceManagement.AsyncOperations;
 using UnityEngine.ResourceManagement.ResourceProviders;
 
 namespace MyUnityTools.SceneLoading.AddressablesSupport.UniTaskSupport
 {
     public interface IAddressableSceneLoaderUniTask : IAddressableSceneLoader
     {
-        UniTask<SceneInstance> TransitionToSceneAsync(IAddressableLoadSceneInfo sceneInfo);
+        UniTask<SceneInstance> TransitionToSceneAsync(IAddressableLoadSceneReference targetSceneReference, IAddressableLoadSceneReference intermediateSceneReference = null);
 
-        UniTask<SceneInstance> SwitchToSceneAsync(IAddressableLoadSceneInfo sceneInfo);
+        UniTask<SceneInstance> LoadSceneAsync(IAddressableLoadSceneReference sceneReference, bool setActive = false);
 
-        UniTask<SceneInstance> LoadSceneAsync(IAddressableLoadSceneInfo sceneInfo, bool setActive = false);
-
-        UniTask UnloadSceneAsync(AsyncOperationHandle<SceneInstance> sceneHandle);
-        UniTask UnloadSceneAsync(SceneInstance scene);
-        UniTask UnloadSceneAsync(string sceneName);
+        UniTask UnloadSceneAsync(IAddressableLoadSceneInfo sceneInfo);
     }
 }
 #endif

Runtime/Interfaces/IAddressableSceneLoaderAsync.cs

@@ -0,0 +1,31 @@
+#if ENABLE_ADDRESSABLES
+/**
+ * IAddressableSceneManager.cs
+ * Created by: João Borks [joao.borks@gmail.com]
+ * Created on: 8/29/2022 (en-US)
+ */
+
+using UnityEngine.AddressableAssets;
+using UnityEngine.ResourceManagement.AsyncOperations;
+using UnityEngine.ResourceManagement.ResourceProviders;
+
+namespace MyUnityTools.SceneLoading.AddressablesSupport
+{
+    public interface IAddressableSceneManager
+    {
+        void SetActiveSceneHandle(AsyncOperationHandle<SceneInstance> sceneHandle);
+
+        AsyncOperationHandle<SceneInstance> GetActiveSceneHandle();
+
+        AsyncOperationHandle<SceneInstance> LoadSceneAsync(AssetReference sceneReference);
+        AsyncOperationHandle<SceneInstance> LoadSceneAsync(string runtimeKey);
+
+        AsyncOperationHandle<SceneInstance> UnloadSceneAsync(AsyncOperationHandle<SceneInstance> sceneHandle);
+        AsyncOperationHandle<SceneInstance> UnloadSceneAsync(SceneInstance scene);
+        AsyncOperationHandle<SceneInstance> UnloadSceneAsync(string sceneName);
+
+        AsyncOperationHandle<SceneInstance> GetLoadedSceneHandle(SceneInstance sceneInstance);
+        AsyncOperationHandle<SceneInstance> GetLoadedSceneHandle(string sceneName);
+    }
+}
+#endif

Runtime/Interfaces/IAddressableSceneLoaderUniTask.cs

@@ -33,7 +33,7 @@ public interface ILoadSceneInfo
         /// Gets a runtime struct representing the loaded scene.
         /// Used to pass as a parameter when calling <see cref="SceneManager.SetActiveScene(Scene)"/>.
         /// </summary>
-        /// <returns>The loaded scene struct, or an invalid scene if it hasn't been loaded.</returns>
+        /// <returns>The loaded scene struct, or an invalid scene (<see cref="Scene.IsValid"/> returns false) if it hasn't been loaded.</returns>
         Scene GetScene();
     }
 }