docs: update in code documentation of transitions

Author: joaoborks

Packages/mygamedevtools-scene-loader/Runtime/Interfaces/ISceneLoader.cs

@@ -24,6 +24,8 @@ public interface ISceneLoader
         /// It will transition from the current active scene (<see cref="ISceneManager.GetActiveScene()"/>)
         /// to the target scene (<paramref name="targetSceneInfo"/>), with an optional intermediate loading scene (<paramref name="intermediateSceneInfo"/>).
         /// If the <paramref name="intermediateSceneInfo"/> is not set, the transition will have no intermediate loading scene and will instead simply load the target scene directly.
+        /// Also, you can provide a scene that wasn't loaded from this scene loader to transition from, as the <paramref name="externalOriginScene"/>,
+        /// instead of transitioning from the current active scene.
         /// The complete transition flow is:
         /// <br/><br/>
         /// 1. Load the intermediate scene (if provided).<br/>
@@ -38,6 +40,9 @@ public interface ISceneLoader
         /// A reference to the scene that's going to be loaded as the transition intermediate (as a loading scene).
         /// If null, the transition will not have an intermediate loading scene.
         /// </param>
+        /// <param name="externalOriginScene">
+        /// A reference to a scene loaded outside of this scene loader, instead of taking the current active scene as the origin scene.
+        /// </param>
         void TransitionToScene(ILoadSceneInfo targetSceneInfo, ILoadSceneInfo intermediateSceneInfo = null, Scene externalOriginScene = default);
 
         /// <summary>
@@ -50,12 +55,12 @@ public interface ISceneLoader
 
         /// <summary>
         /// Loads a scene additively on top of the current scene stack, optionally marking it as the active scene
-        /// (<see cref="ISceneManager.SetActiveScene(UnityEngine.SceneManagement.Scene)"/>).
+        /// (<see cref="ISceneManager.SetActiveScene(Scene)"/>).
         /// </summary>
         /// <param name="sceneInfo">
         /// Reference to the scene that's going to be loaded.
         /// </param>
-        /// <param name="setActive">Should the loaded scene be marked as active? Equivalent to calling <see cref="ISceneManager.SetActiveScene(UnityEngine.SceneManagement.Scene)"/>.</param>
+        /// <param name="setActive">Should the loaded scene be marked as active? Equivalent to calling <see cref="ISceneManager.SetActiveScene(Scene)"/>.</param>
         void LoadScene(ILoadSceneInfo sceneInfo, bool setActive = false);
     }
 }

Packages/mygamedevtools-scene-loader/Runtime/Interfaces/ISceneLoaderAsync.cs

@@ -17,7 +17,7 @@ namespace MyGameDevTools.SceneLoading
     public interface ISceneLoaderAsync<TAsync> : ISceneLoader
     {
         /// <summary>
-        /// Async version of the <see cref="ISceneLoader.TransitionToScene(ILoadSceneInfo, ILoadSceneInfo)"/>.
+        /// Async version of the <see cref="ISceneLoader.TransitionToScene(ILoadSceneInfo, ILoadSceneInfo, Scene)"/>.
         /// </summary>
         /// <param name="targetSceneReference">
         /// A reference to the scene that's going to be transitioned to.
@@ -26,6 +26,9 @@ public interface ISceneLoaderAsync<TAsync> : ISceneLoader
         /// A reference to the scene that's going to be loaded as the transition intermediate (as a loading scene).
         /// If null, the transition will not have an intermediate loading scene.
         /// </param>
+        /// <param name="externalOriginScene">
+        /// A reference to a scene loaded outside of this scene loader, instead of taking the current active scene as the origin scene.
+        /// </param>
         /// <returns>
         /// The loading operation.
         /// </returns>