Version: 2019.1 (switch to 2018.4
LanguageEnglish
  • C#

SceneManager.UnloadSceneAsync

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static AsyncOperation UnloadSceneAsync(int sceneBuildIndex);
public static AsyncOperation UnloadSceneAsync(string sceneName);
public static AsyncOperation UnloadSceneAsync(SceneManagement.Scene scene);
public static AsyncOperation UnloadSceneAsync(int sceneBuildIndex, SceneManagement.UnloadSceneOptions options);
public static AsyncOperation UnloadSceneAsync(string sceneName, SceneManagement.UnloadSceneOptions options);
public static AsyncOperation UnloadSceneAsync(SceneManagement.Scene scene, SceneManagement.UnloadSceneOptions options);

Parameters

sceneBuildIndexIndex of the Scene in BuildSettings.
sceneNameName or path of the Scene to unload.
sceneScene to unload.
optionsScene unloading options.

Returns

AsyncOperation Use the AsyncOperation to determine if the operation has completed.

Description

Destroys all GameObjects associated with the given Scene and removes the Scene from the SceneManager.

The given Scene name can either be the full Scene path, the path shown in the Build Settings window or just the Scene name. If only the Scene name is given this will unload the first Scene in the list that matches. If you have multiple Scenes with same name but different paths, you should use the full Scene path. Examples of supported formats:
"Scene1"
"Scene2"
"Scenes/Scene3"
"Scenes/Others/Scene3"
"Assets/scenes/others/scene3.unity"

Note: This is case-insensitive and due to it being async there are no guarantees about completion time.
Note: Assets are currently not unloaded. In order to free up asset memory call Resources.UnloadUnusedAssets.
Note: It is not possible to UnloadSceneAsync if there are no scenes to load. For example, a project that has a single scene cannot use this static member.

Did you find this page useful? Please give it a rating: