Legacy Documentation: Version 5.4
LanguageEnglish
  • C#
  • JS

Script language

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

SceneManager.UnloadScene

public static bool UnloadScene(int sceneBuildIndex);
public static bool UnloadScene(string sceneName);
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

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

''It's not recommended to use this function but instead use'' UnloadSceneAsync.

Warning: This can't 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 that sceneName is case insensitive.

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