(() => wait.MoveNext());
+ wait.MoveNext();
}
[UnityTest]
diff --git a/Packages/packages-lock.json b/Packages/packages-lock.json
index ba18cfb..210c8aa 100644
--- a/Packages/packages-lock.json
+++ b/Packages/packages-lock.json
@@ -13,12 +13,19 @@
"source": "embedded",
"dependencies": {}
},
+ "com.mygamedevtools.script-template": {
+ "version": "3.4.0",
+ "depth": 0,
+ "source": "registry",
+ "dependencies": {},
+ "url": "https://package.openupm.com"
+ },
"com.unity.addressables": {
- "version": "1.21.2",
+ "version": "1.21.12",
"depth": 0,
"source": "registry",
"dependencies": {
- "com.unity.scriptablebuildpipeline": "1.21.1",
+ "com.unity.scriptablebuildpipeline": "1.21.5",
"com.unity.modules.assetbundle": "1.0.0",
"com.unity.modules.imageconversion": "1.0.0",
"com.unity.modules.jsonserialize": "1.0.0",
@@ -46,17 +53,17 @@
"depth": 0,
"source": "builtin",
"dependencies": {
- "com.unity.ide.visualstudio": "2.0.16",
- "com.unity.ide.rider": "3.0.16",
+ "com.unity.ide.visualstudio": "2.0.18",
+ "com.unity.ide.rider": "3.0.21",
"com.unity.ide.vscode": "1.2.5",
"com.unity.editorcoroutines": "1.0.0",
- "com.unity.performance.profile-analyzer": "1.1.1",
+ "com.unity.performance.profile-analyzer": "1.2.2",
"com.unity.test-framework": "1.1.33",
- "com.unity.testtools.codecoverage": "1.2.1"
+ "com.unity.testtools.codecoverage": "1.2.4"
}
},
"com.unity.ide.rider": {
- "version": "3.0.16",
+ "version": "3.0.21",
"depth": 1,
"source": "registry",
"dependencies": {
@@ -65,7 +72,7 @@
"url": "https://packages.unity.com"
},
"com.unity.ide.visualstudio": {
- "version": "2.0.16",
+ "version": "2.0.18",
"depth": 1,
"source": "registry",
"dependencies": {
@@ -81,14 +88,14 @@
"url": "https://packages.unity.com"
},
"com.unity.performance.profile-analyzer": {
- "version": "1.1.1",
+ "version": "1.2.2",
"depth": 1,
"source": "registry",
"dependencies": {},
"url": "https://packages.unity.com"
},
"com.unity.scriptablebuildpipeline": {
- "version": "1.21.1",
+ "version": "1.21.5",
"depth": 1,
"source": "registry",
"dependencies": {},
@@ -113,7 +120,7 @@
"url": "https://packages.unity.com"
},
"com.unity.testtools.codecoverage": {
- "version": "1.2.1",
+ "version": "1.2.4",
"depth": 1,
"source": "registry",
"dependencies": {
@@ -132,7 +139,7 @@
"url": "https://packages.unity.com"
},
"com.unity.timeline": {
- "version": "1.7.2",
+ "version": "1.7.4",
"depth": 0,
"source": "registry",
"dependencies": {
diff --git a/ProjectSettings/PackageManagerSettings.asset b/ProjectSettings/PackageManagerSettings.asset
index fc46b30..011c892 100644
--- a/ProjectSettings/PackageManagerSettings.asset
+++ b/ProjectSettings/PackageManagerSettings.asset
@@ -32,6 +32,7 @@ MonoBehaviour:
m_Scopes:
- com.cysharp.unitask
- com.openupm
+ - com.mygamedevtools
m_IsDefault: 0
m_Capabilities: 0
m_ConfigSource: 4
@@ -40,6 +41,6 @@ MonoBehaviour:
m_RegistryInfoDraft:
m_Modified: 0
m_ErrorMessage:
- m_UserModificationsInstanceId: -842
- m_OriginalInstanceId: -844
+ m_UserModificationsInstanceId: -838
+ m_OriginalInstanceId: -842
m_LoadAssets: 0
diff --git a/ProjectSettings/ProjectSettings.asset b/ProjectSettings/ProjectSettings.asset
index 0c684b8..3b104cb 100644
--- a/ProjectSettings/ProjectSettings.asset
+++ b/ProjectSettings/ProjectSettings.asset
@@ -3,7 +3,7 @@
--- !u!129 &1
PlayerSettings:
m_ObjectHideFlags: 0
- serializedVersion: 25
+ serializedVersion: 26
productGUID: 9ef03355832746f49b725e90ca3b2446
AndroidProfiler: 0
AndroidFilterTouchesWhenObscured: 0
@@ -52,6 +52,7 @@ PlayerSettings:
m_MTRendering: 1
mipStripping: 0
numberOfMipsStripped: 0
+ numberOfMipsStrippedPerMipmapLimitGroup: {}
m_StackTraceTypes: 010000000100000001000000010000000100000001000000
iosShowActivityIndicatorOnLoading: -1
androidShowActivityIndicatorOnLoading: -1
@@ -145,14 +146,15 @@ PlayerSettings:
enableFrameTimingStats: 0
enableOpenGLProfilerGPURecorders: 1
useHDRDisplay: 0
- D3DHDRBitDepth: 0
+ hdrBitDepth: 0
m_ColorGamuts: 00000000
targetPixelDensity: 30
resolutionScalingMode: 0
resetResolutionOnWindowResize: 0
androidSupportedAspectRatio: 1
androidMaxAspectRatio: 2.1
- applicationIdentifier: {}
+ applicationIdentifier:
+ Standalone: com.DefaultCompany.scene-loader
buildNumber:
Standalone: 0
iPhone: 0
@@ -242,6 +244,7 @@ PlayerSettings:
useCustomLauncherGradleManifest: 0
useCustomBaseGradleTemplate: 0
useCustomGradlePropertiesTemplate: 0
+ useCustomGradleSettingsTemplate: 0
useCustomProguardFile: 0
AndroidTargetArchitectures: 1
AndroidTargetDevices: 0
@@ -469,7 +472,6 @@ PlayerSettings:
switchReleaseVersion: 0
switchDisplayVersion: 1.0.0
switchStartupUserAccount: 0
- switchTouchScreenUsage: 0
switchSupportedLanguagesMask: 0
switchLogoType: 0
switchApplicationErrorCodeCategory:
@@ -511,6 +513,7 @@ PlayerSettings:
switchNativeFsCacheSize: 32
switchIsHoldTypeHorizontal: 0
switchSupportedNpadCount: 8
+ switchEnableTouchScreen: 1
switchSocketConfigEnabled: 0
switchTcpInitialSendBufferSize: 32
switchTcpInitialReceiveBufferSize: 64
@@ -523,6 +526,7 @@ PlayerSettings:
switchNetworkInterfaceManagerInitializeEnabled: 1
switchPlayerConnectionEnabled: 1
switchUseNewStyleFilepaths: 1
+ switchUseLegacyFmodPriorities: 0
switchUseMicroSleepForYield: 1
switchEnableRamDiskSupport: 0
switchMicroSleepForYieldTime: 25
@@ -720,6 +724,7 @@ PlayerSettings:
hmiPlayerDataPath:
hmiForceSRGBBlit: 1
embeddedLinuxEnableGamepadInput: 1
+ hmiLogStartupTiming: 0
hmiCpuConfiguration:
apiCompatibilityLevel: 6
activeInputHandler: 0
diff --git a/ProjectSettings/ProjectVersion.txt b/ProjectSettings/ProjectVersion.txt
index df0a387..9bc389c 100644
--- a/ProjectSettings/ProjectVersion.txt
+++ b/ProjectSettings/ProjectVersion.txt
@@ -1,2 +1,2 @@
-m_EditorVersion: 2022.2.0f1
-m_EditorVersionWithRevision: 2022.2.0f1 (35dcd44975df)
+m_EditorVersion: 2022.3.2f1
+m_EditorVersionWithRevision: 2022.3.2f1 (d74737c6db50)
diff --git a/README.md b/README.md
index ce9b87d..54553e8 100644
--- a/README.md
+++ b/README.md
@@ -33,7 +33,7 @@ Scene Loading
-A package that standardizes scene loading operations between the Unity Scene Manager and Addressables, allowing multiple alternatives of awaiting such as Coroutines, Async or UniTask.
+A package that standardizes scene loading operations between the Unity Scene Manager and Addressables, allowing multiple alternatives of awaiting such as Coroutines, Async or UniTask; and adds support for batch scene operations.
Summary
@@ -44,6 +44,8 @@ Summary
* [Installing from Git](#installing-from-git-requires-git-installed-and-added-to-the-path)
* [Dependencies](#dependencies)
* [Overview](#overview)
+ * [TL;DR](#tldr)
+ * [Description](#description)
* [Usage](#usage)
* [The Scene Managers](#the-scene-managers)
* [The LoadSceneInfo objects](#the-loadsceneinfo-objects)
@@ -95,11 +97,19 @@ _*Installed via UPM or OpenUPM. Check the [package documentation](https://github
Overview
---
+### TL;DR
+
+* Simplify scene loading with [Unity Addressables](https://docs.unity3d.com/Manual/com.unity.addressables.html) or standard Unity Scenes.
+* Ability to **transition** between scenes.
+* Batch scene operations: load, unload, or transition to **multiple scenes**.
+
+### Description
+
Loading scenes in Unity is very simple, mostly, but when you start to deal with other systems such as [Unity Addressables](https://docs.unity3d.com/Manual/com.unity.addressables.html), it can get a little messy. Also, there are some common scene load scenarios that you'd usually reimplement every project, like scene transitions.
In this package, you'll have the possibility to standardize the scene loading process between the standard **Unity Scene Manager** and **Addressables**, while still being able to choose how to await (if you want) the operations, be it Coroutines, standard Async (through ValueTasks) or [UniTask](https://github.com/Cysharp/UniTask).
-Aside from the ordinary **Load** and **Unload** actions, the Scene Loading tools introduce the **Transition** as a new standard to control transitions between scenes with an optional intermediate "loading scene" in between.
+Aside from the ordinary **Load** and **Unload** actions, the Scene Loading tools introduce the **Transition** as a new standard to control transitions between scenes with an optional intermediate "loading scene" in between. Also, starting from version `2.2` you can also **Load**, **Unload** and **Transition** to **multiple scenes** in parallel!
:information_source: You don't need to understand what **Addressables** or **UniTask** do in order to use this package. There are scene loaders that only rely on basic Unity Engine functionalities.
@@ -110,6 +120,21 @@ Loading scenes with this package implies that the scenes **will always be loaded
In order to standardize how the scenes are loaded, you'll be using `ISceneLoader`, `ISceneManager` and `ILoadSceneInfo` objects.
+```mermaid
+flowchart BT
+ sm([Scene Manager])
+ sl([Scene Loader])
+ lsi([Load Scene Info])
+
+ lsi -->|Load| sl
+ lsi -->|Unload| sl
+ lsi -->|Transition| sl
+ sl -->|Load| sm
+ sl -->|Unload| sm
+```
+
+These structures are meant to be used together. If you do not plan to use scene transitions or to have custom _awaitable_ types, you don't need to use the `ISceneLoader`.
+
### The Scene Managers
The `ISceneManager` interface exposes a few methods and events to standardize the scene load operations:
@@ -125,8 +150,12 @@ public interface ISceneManager
void SetActiveScene(Scene scene);
+ ValueTask LoadScenesAsync(ILoadSceneInfo[] sceneInfos, int setIndexActive = -1, IProgress progress = null);
+
ValueTask LoadSceneAsync(ILoadSceneInfo sceneInfo, bool setActive = false, IProgress progress = null);
+ ValueTask UnloadSceneAsync(ILoadSceneInfo[] sceneInfos);
+
ValueTask UnloadSceneAsync(ILoadSceneInfo sceneInfo);
Scene GetActiveScene();
@@ -154,13 +183,17 @@ In this context, the _Unity Scene Manager_ would be something like a **global sc
Speaking of multiple scene managers, you can use a `SceneManager` and a `SceneManagerAddressable` **at the same time**, just keep in mind they will have their own contexts **in isolation** to the other.
```mermaid
-flowchart RL
- subgraph usm [Unity Scene Manager]
- a1((Scene Manager)) --> b1[Scene A]
- a1 --> b2[Scene B]
- a2((Scene Manager Addressable)) --> c1[Scene X]
- a2 --> c2[Scene Y]
- end
+flowchart TB
+ sm([Scene Manager]) --> s_a[Scene A]
+ sm --> s_b[Scene B]
+ sma([Scene Manager Addressable]) --> s_x[Scene X]
+ sma --> s_y[Scene Y]
+
+ usm([Unity Scene Manager])
+ s_a --> usm
+ s_b --> usm
+ s_x --> usm
+ s_y --> usm
```
The `ISceneManager` interface defines that both `LoadSceneAsync` and `UnloadSceneAsync` methods return a `ValueTask`.
@@ -169,6 +202,8 @@ This means you can _await_ those methods if they are implemented with the _async
Both these methods also receive an `ILoadSceneInfo` object.
So, instead of having multiple methods for receiving the scene's build index or the scene's name, we simply have an object instead.
+Alternatively, you can also use the `LoadScenesAsync` and `UnloadScenesAsync` methods, to perform the operations on multiple scenes in parallel. These will return a `ValueTask`.
+
### The LoadSceneInfo objects
As its name states, these objects hold references to a scene to be loaded (or unloaded) and are able to validate whether they are a reference to a loaded scene.
@@ -208,10 +243,16 @@ public interface ISceneLoader
{
ISceneManager Manager { get; }
- void TransitionToScene(ILoadSceneInfo targetSceneInfo, ILoadSceneInfo intermediateSceneInfo = default);
+ void TransitionToScenes(ILoadSceneInfo[] targetScenes, int setIndexActive, ILoadSceneInfo intermediateSceneInfo = null, Scene externalOriginScene = default);
+
+ void TransitionToScene(ILoadSceneInfo targetSceneInfo, ILoadSceneInfo intermediateSceneInfo = null, Scene externalOriginScene = default);
+
+ void UnloadScenes(ILoadSceneInfo[] sceneInfos);
void UnloadScene(ILoadSceneInfo sceneInfo);
+ void LoadScenes(ILoadSceneInfo[] sceneInfos, int setIndexActive = -1);
+
void LoadScene(ILoadSceneInfo sceneInfo, bool setActive = false);
}
```
@@ -219,18 +260,40 @@ public interface ISceneLoader
And the `ISceneLoaderAsync`:
```cs
-public interface ISceneLoaderAsync : ISceneLoader
+public interface ISceneLoaderAsync : ISceneLoader
{
- TAsync TransitionToSceneAsync(ILoadSceneInfo targetSceneReference, ILoadSceneInfo intermediateSceneReference = default);
+ TAsyncSceneArray TransitionToScenesAsync(ILoadSceneInfo[] targetScenes, int setIndexActive, ILoadSceneInfo intermediateSceneReference = default, Scene externalOriginScene = default);
+
+ TAsyncScene TransitionToSceneAsync(ILoadSceneInfo targetSceneReference, ILoadSceneInfo intermediateSceneReference = default, Scene externalOriginScene = default);
+
+ TAsyncSceneArray LoadScenesAsync(ILoadSceneInfo[] sceneReferences, int setIndexActive = -1, IProgress progress = null);
+
+ TAsyncScene LoadSceneAsync(ILoadSceneInfo sceneReference, bool setActive = false, IProgress progress = null);
- TAsync LoadSceneAsync(ILoadSceneInfo sceneReference, bool setActive = false, IProgress progress = null);
+ TAsyncSceneArray UnloadScenesAsync(ILoadSceneInfo[] sceneReferences);
- TAsync UnloadSceneAsync(ILoadSceneInfo sceneReference);
+ TAsyncScene UnloadSceneAsync(ILoadSceneInfo sceneReference);
}
```
Note that the `ISceneLoaderAsync` interface inherits from `ISceneLoader`.
-The `TAsync` type should return a `Scene` instance, and can be anything you mean to _await_ or a [Coroutine](https://docs.unity3d.com/Manual/Coroutines.html) (that can't return anything without additional code), for example `Task`, `ValueTask` or `UniTask`.
+The `TAsyncScene` type should return a `Scene` instance, and can be anything you mean to _await_ or a [Coroutine](https://docs.unity3d.com/Manual/Coroutines.html) (that can't return anything without additional code), for example `Task`, `ValueTask` or `UniTask`, while the `TAsyncSceneArray` should return a `Scene[]` instance, such as `Task`, `ValueTask` or `UniTask`.
+
+The package comes with **three** Scene Loader implementations:
+* The `SceneLoaderCoroutine`, that simply returns `Coroutines` for every method.
+* The `SceneLoaderAsync`, that just like the `ISceneManager` implementations, will return `ValueTask` values.
+* The `SceneLoaderUniTask`, that will return `UniTask` values.
+
+All of them have interfaces to simplify your code:
+
+```cs
+public interface ISceneLoaderCoroutine : ISceneLoaderAsync { }
+
+public interface ISceneLoaderAsync : ISceneLoaderAsync, ValueTask> { }
+
+public interface ISceneLoaderUniTask : ISceneLoaderAsync, UniTask> { }
+```
+
The `Manager` property can be used to listen to the `SceneLoaded`, `SceneUnloaded`, and `ActiveSceneChanged` events.
Both `LoadSceneAsync` and `UnloadSceneAsync` methods will simply call the `ISceneManager` equivalents, while the `LoadScene` and `UnloadScene` will do the same but without _await_.
@@ -254,6 +317,8 @@ In this case you would:
That's four operations now.
The `TransitionToScene` and `TransitionToSceneAsync` methods let you only provide where you want to go from the currently active scene and if you want an intermediary scene (loading scene for example).
+You can also transition from a scene **outside** of the scene manager context, by providing a scene in the `externalOriginScene` parameter in the Transition methods. Just make sure this scene **is not** in another scene manager context.
+
### Practical Examples
When creating your scene loader, you must first create your scene manager.
@@ -285,11 +350,11 @@ You can also define the scene loader types as their `ISceneLoaderAsync` implemen
```cs
ISceneManager sceneManager = new SceneManager();
-ISceneLoaderAsync coroutineSceneLoader = new SceneLoaderCoroutine(sceneManager);
+ISceneLoaderCoroutine coroutineSceneLoader = new SceneLoaderCoroutine(sceneManager);
// Or
-ISceneLoaderAsync> asyncSceneLoader = new SceneLoaderAsync(sceneManager);
+ISceneLoaderAsync asyncSceneLoader = new SceneLoaderAsync(sceneManager);
// Or
-ISceneLoaderAsync> unitaskSceneLoader = new SceneLoaderUniTask(sceneManager);
+ISceneLoaderUniTask unitaskSceneLoader = new SceneLoaderUniTask(sceneManager);
```
#### Loading scenes with load scene info