Legacy Documentation: Version 5.6 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Method group is Obsolete

SceneManager.UnloadScene

Other Versions
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

Obsolete public static function UnloadScene(sceneBuildIndex: int): bool;
Obsolete public static bool UnloadScene(int sceneBuildIndex);
Obsolete public static function UnloadScene(sceneName: string): bool;
Obsolete public static bool UnloadScene(string sceneName);
Obsolete public static function UnloadScene(scene: SceneManagement.Scene): bool;
Obsolete public static bool UnloadScene(SceneManagement.Scene scene);

Parameters

sceneBuildIndex Index of the scene in the Build Settings to unload.
sceneName Name or path of the scene to unload.
scene Scene to unload.

Returns

bool Returns true if the scene is unloaded.

Description

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

Note: It is not recommended to use this function but instead use UnloadSceneAsync.

Warning: This cannot be called during various physics and visibility callbacks like OnTriggerEnter or OnBecameVisible. This limitation is the reason this function is not recommended to use.

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 load 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:
"Assets/Scenes/Scene1.unity"
"Scenes/Scene1"
"Scene1"

Note: sceneName is case insensitive.
Note: Assets are currently not unloaded, in order to free up asset memory call Resources.UnloadAllUnusedAssets.

Leave Feedback

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2017 Unity Technologies. Publication: 5.6-001N. Built: 2017-07-12.
Tutorials Community Answers Knowledge Base Forums Asset Store LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information