Skip to content

feat: add new scene transition methods #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 27, 2024
Merged

feat: add new scene transition methods #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fe03993
update scene loader interface
joaoborks Aug 26, 2024
2f2fcf4
add new transitions to scene loaders
joaoborks Aug 26, 2024
18d959e
add transitiontoscenesfromscenes test
joaoborks Aug 27, 2024
4d67fb5
add transitiontoscenesfromall test
joaoborks Aug 27, 2024
e241521
add documentation for new transition methods
joaoborks Aug 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 101 additions & 2 deletions Packages/com.mygamedevtools.scene-loader/Runtime/Interfaces/ISceneLoader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ public interface ISceneLoader : IDisposable
ISceneManager Manager { get; }

/// <summary>
/// Triggers a transition to a group of scens.
/// Triggers a transition to a group of scenes from the active scene.
/// It will transition from the current active scene (<see cref="ISceneManager.GetActiveScene()"/>)
/// to a group of scenes (<paramref name="targetScenes"/>), 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.
Expand All @@ -39,7 +39,7 @@ public interface ISceneLoader : IDisposable
void TransitionToScenes(ILoadSceneInfo[] targetScenes, int setIndexActive, ILoadSceneInfo intermediateSceneInfo = null);

/// <summary>
/// Triggers a scene transition.
/// Triggers a transition to the target scene from the active scene.
/// 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.
Expand All @@ -59,6 +59,105 @@ public interface ISceneLoader : IDisposable
/// </param>
void TransitionToScene(ILoadSceneInfo targetSceneInfo, ILoadSceneInfo intermediateSceneInfo = null);

/// <summary>
/// Triggers a transition to a group of scenes from another group of scenes.
/// It will transition from the provided group of scenes (<paramref name="fromScenes"/>)
/// to a group of scenes (<paramref name="targetScenes"/>), 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.
/// The complete transition flow is:
/// <br/><br/>
/// 1. Load the intermediate scene (if provided).<br/>
/// 2. Unload all provided scenes.<br/>
/// 3. Load all target scenes.<br/>
/// 4. Unload the intermediate scene (if provided).<br/>
/// </summary>
/// <param name="targetScenes">
/// A reference to all scenes that will be transitioned to.
/// </param>
/// <param name="fromScenes">
/// A reference to all scenes that will be unloaded in the transition.
/// </param>
/// <param name="setIndexActive">
/// Index of the scene in the <paramref name="targetScenes"/> to be set as the active scene.
/// </param>
/// <param name="intermediateSceneInfo">
/// 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>
void TransitionToScenesFromScenes(ILoadSceneInfo[] targetScenes, ILoadSceneInfo[] fromScenes, int setIndexActive, ILoadSceneInfo intermediateSceneInfo = null);

/// <summary>
/// Triggers a transition to the target scene from a group of scens.
/// It will transition from the provided group of scenes (<paramref name="fromScenes"/>)
/// 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.
/// The complete transition flow is:
/// <br/><br/>
/// 1. Load the intermediate scene (if provided).<br/>
/// 2. Unload all provided scenes.<br/>
/// 3. Load the target scene.<br/>
/// 4. Unload the intermediate scene (if provided).<br/>
/// </summary>
/// <param name="targetSceneInfo">
/// A reference to the scene that's going to be transitioned to.
/// </param>
/// <param name="fromScenes">
/// A reference to all scenes that will be unloaded in the transition.
/// </param>
/// <param name="intermediateSceneInfo">
/// 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>
void TransitionToSceneFromScenes(ILoadSceneInfo targetSceneInfo, ILoadSceneInfo[] fromScenes, ILoadSceneInfo intermediateSceneInfo = null);

/// <summary>
/// Triggers a transition to a group of scenes from all loaded scenes.
/// It will transition from all loaded scenes
/// to a group of scenes (<paramref name="targetScenes"/>), 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.
/// The complete transition flow is:
/// <br/><br/>
/// 1. Load the intermediate scene (if provided).<br/>
/// 2. Unload all loaded scenes.<br/>
/// 3. Load all target scenes.<br/>
/// 4. Unload the intermediate scene (if provided).<br/>
/// </summary>
/// <param name="targetScenes">
/// A reference to all scenes that will be transitioned to.
/// </param>
/// <param name="setIndexActive">
/// Index of the scene in the <paramref name="targetScenes"/> to be set as the active scene.
/// </param>
/// <param name="intermediateSceneInfo">
/// 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>
void TransitionToScenesFromAll(ILoadSceneInfo[] targetScenes, int setIndexActive, ILoadSceneInfo intermediateSceneInfo = null);

/// <summary>
/// Triggers a transition to the target scene from all loaded scenes.
/// It will transition from the provided group of scenes (<paramref name="fromScenes"/>)
/// 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.
/// The complete transition flow is:
/// <br/><br/>
/// 1. Load the intermediate scene (if provided).<br/>
/// 2. Unload all provided scenes.<br/>
/// 3. Load the target scene.<br/>
/// 4. Unload the intermediate scene (if provided).<br/>
/// </summary>
/// <param name="targetSceneInfo">
/// A reference to the scene that's going to be transitioned to.
/// </param>
/// <param name="fromScenes">
/// A reference to all scenes that will be unloaded in the transition.
/// </param>
/// <param name="intermediateSceneInfo">
/// 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>
void TransitionToSceneFromAll(ILoadSceneInfo targetSceneInfo, ILoadSceneInfo intermediateSceneInfo = null);

/// <summary>
/// Unloads all the scenes from the current scene stack.
/// </summary>
Expand Down
72 changes: 72 additions & 0 deletions Packages/com.mygamedevtools.scene-loader/Runtime/Interfaces/ISceneLoaderAsync.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,78 @@ public interface ISceneLoaderAsync<TAsyncScene, TAsyncSceneArray> : ISceneLoader
/// </returns>
TAsyncScene TransitionToSceneAsync(ILoadSceneInfo targetSceneReference, ILoadSceneInfo intermediateSceneReference = default);

/// <summary>
/// Async version of the <see cref="ISceneLoader.TransitionToScenesFromScenes(ILoadSceneInfo[], ILoadSceneInfo[], int, ILoadSceneInfo)"/>
/// </summary>
/// <param name="targetScenes">
/// A reference to all scenes that will be transitioned to.
/// </param>
/// <param name="fromScenes">
/// A reference to all scenes that will be unloaded in the transition.
/// </param>
/// <param name="setIndexActive">
/// Index of the scene in the <paramref name="targetScenes"/> to be set as the active scene.
/// </param>
/// <param name="intermediateSceneReference">
/// 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>
/// <returns>
/// The transition operation.
/// </returns>
TAsyncSceneArray TransitionToScenesFromScenesAsync(ILoadSceneInfo[] targetScenes, ILoadSceneInfo[] fromScenes, int setIndexActive, ILoadSceneInfo intermediateSceneReference = default);

/// <summary>
/// Async version of the <see cref="ISceneLoader.TransitionToSceneFromScenes(ILoadSceneInfo, ILoadSceneInfo[], ILoadSceneInfo)"/>
/// </summary>
/// <param name="targetSceneReference">
/// A reference to the scene that's going to be transitioned to.
/// </param>
/// <param name="fromScenes">
/// A reference to all scenes that will be unloaded in the transition.
/// </param>
/// <param name="intermediateSceneReference">
/// 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>
/// <returns>
/// The transition operation.
/// </returns>
TAsyncScene TransitionToSceneFromScenesAsync(ILoadSceneInfo targetSceneReference, ILoadSceneInfo[] fromScenes, ILoadSceneInfo intermediateSceneReference = default);

/// <summary>
/// Async version of the <see cref="ISceneLoader.TransitionToScenesFromAll(ILoadSceneInfo[], int, ILoadSceneInfo)"/>
/// </summary>
/// <param name="targetScenes">
/// A reference to all scenes that will be transitioned to.
/// </param>
/// <param name="setIndexActive">
/// Index of the scene in the <paramref name="targetScenes"/> to be set as the active scene.
/// </param>
/// <param name="intermediateSceneReference">
/// 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>
/// <returns>
/// The transition operation.
/// </returns>
TAsyncSceneArray TransitionToScenesFromAllAsync(ILoadSceneInfo[] targetScenes, int setIndexActive, ILoadSceneInfo intermediateSceneReference = default);

/// <summary>
/// Async version of the <see cref="ISceneLoader.TransitionToSceneFromAll(ILoadSceneInfo, ILoadSceneInfo)"/>
/// </summary>
/// <param name="targetSceneReference">
/// A reference to the scene that's going to be transitioned to.
/// </param>
/// <param name="intermediateSceneReference">
/// 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>
/// <returns>
/// The transition operation.
/// </returns>
TAsyncScene TransitionToSceneFromAllAsync(ILoadSceneInfo targetSceneReference, ILoadSceneInfo intermediateSceneReference = default);

/// <summary>
/// Async version of the <see cref="ISceneLoader.LoadScenes(ILoadSceneInfo[], int)"/>.
/// </summary>
Expand Down
Loading
Loading