Version: 5.4 beta (switch to 5.3)
LanguageEnglish
  • C#
  • JS

Script language

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

SceneManager.UnloadScene

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

Sumbission failed

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

Close

Cancel

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

Parameters

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

Returns

bool Returns true if the scene is unloaded.

Description

Unloads all GameObjects associated with the given scene.

The given sceneName can either be the last part of the path, without .unity extension or the full path still without the .unity extension. The path has to be exactly as shown in the Build Settings Window. 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 path.

Note that this is case insensitive.

Note that assets are currently not unloaded, in order to free up asset memory call Resources.UnloadUnusedAssets.

Copyright © 2016 Unity Technologies. Publication 5.4b-R
Tutorials Community Answers Knowledge Base Forums Asset Store