Version: 5.6 (switch to 2017.1b)
LanguageEnglish
  • C#
  • JS

Script language

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

EditorSceneManager

class in UnityEditor.SceneManagement

/

Inherits from:SceneManagement.SceneManager

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

Description

Scene management in the Editor.

Static Variables

loadedSceneCountThe number of loaded Scenes.
preventCrossSceneReferencesControls whether cross-Scene references are allowed in the Editor.

Static Functions

CloseSceneClose the Scene. If removeScene flag is true, the closed Scene will also be removed from EditorSceneManager.
DetectCrossSceneReferencesDetects cross-scene references in a Scene.
EnsureUntitledSceneHasBeenSavedShows a save dialog if an Untitled scene exists in the current scene manager setup.
GetSceneManagerSetupReturns the current setup of the SceneManager.
MarkAllScenesDirtyMark all the loaded Scenes as modified.
MarkSceneDirtyMark the specified Scene as modified.
MoveSceneAfterAllows you to reorder the Scenes currently open in the Hierarchy window. Moves the source Scene so it comes after the destination Scene.
MoveSceneBeforeAllows you to reorder the Scenes currently open in the Hierarchy window. Moves the source Scene so it comes before the destination Scene.
NewSceneCreate a new Scene.
OpenSceneOpen a Scene in the Editor.
RestoreSceneManagerSetupRestore the setup of the SceneManager.
SaveCurrentModifiedScenesIfUserWantsToAsks you if you want to save the modified Scene or Scenes.
SaveModifiedScenesIfUserWantsToAsks whether the modfied input Scenes should be saved.
SaveOpenScenesSave all open Scenes.
SaveSceneSave a Scene.
SaveScenesSave a list of Scenes.

Events

newSceneCreatedThis event is called after a new Scene has been created.
sceneClosedThis event is called after a Scene has been closed in the editor.
sceneClosingThis event is called before closing an open Scene after you have requested that the Scene is closed.
sceneOpenedThis event is called after a Scene has been opened in the editor.
sceneOpeningThis event is called before opening an existing Scene.
sceneSavedThis event is called after a Scene has been saved.
sceneSavingThis event is called before a Scene is saved disk after you have requested the Scene to be saved.

Delegates

NewSceneCreatedCallbackCallbacks of this type which have been added to the newSceneCreated event are called after a new Scene has been created.
SceneClosedCallbackCallbacks of this type which have been added to the sceneClosed event are called immediately after the Scene has been closed.
SceneClosingCallbackCallbacks of this type which have been added to the sceneClosing event are called just before a Scene is closed.
SceneOpenedCallbackCallbacks of this type which have been added to the sceneOpened event are called after a Scene has been opened.
SceneOpeningCallbackCallbacks of this type which have been added to the sceneOpening event are called just before opening a Scene.
SceneSavedCallbackCallbacks of this type which have been added to the sceneSaved event are called after a Scene has been saved.
SceneSavingCallbackCallbacks of this type which have been added to the sceneSaving event are called just before the Scene is saved.

Inherited members

Static Variables

sceneCountThe total number of currently loaded scenes.
sceneCountInBuildSettingsNumber of scenes in Build Settings.

Static Functions

CreateSceneCreate an empty new scene at runtime with the given name.
GetActiveSceneGets the currently active scene.
GetSceneAtGet the scene at index in the SceneManager's list of added scenes.
GetSceneByBuildIndexGet a scene struct from a build index.
GetSceneByNameSearches through the scenes added to the SceneManager for a scene with the given name.
GetSceneByPathSearches all scenes added to the SceneManager for a scene that has the given asset path.
LoadSceneLoads the scene by its name or index in Build Settings.
LoadSceneAsyncLoads the scene asynchronously in the background.
MergeScenesThis will merge the source scene into the destinationScene.
MoveGameObjectToSceneMove a GameObject from its current scene to a new Scene.
SetActiveSceneSet the scene to be active.
UnloadSceneAsyncDestroys all GameObjects associated with the given scene and removes the scene from the SceneManager.

Events

activeSceneChangedAdd a delegate to this to get notifications when the active scene has changed
sceneLoadedAdd a delegate to this to get notifications when a scene has loaded
sceneUnloadedAdd a delegate to this to get notifications when a scene has unloaded