Version: 2019.1 (switch to 2018.4
LanguageEnglish
  • C#

EditorSceneManager

class in UnityEditor.SceneManagement

/

Inherits from:SceneManagement.SceneManager

/

Implemented in:UnityEditor

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 Properties

DefaultSceneCullingMaskThe Scene culling mask that is drawn by all Cameras. All Scenes start with this culling mask by default.
loadedSceneCountThe number of loaded Scenes.
playModeStartSceneLoads this SceneAsset when you start Play Mode.
preventCrossSceneReferencesControls whether cross-Scene references are allowed in the Editor.
previewSceneCountThe current amount of active preview Scenes.

Static Methods

CalculateAvailableSceneCullingMaskGo through all Scenes and find the smallest unused bit in the unition of all Scene culling masks.
ClosePreviewSceneCloses a preview Scene created by NewPreviewScene.
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.
GetSceneCullingMaskReturn the culling mask set on the given Scene.
GetSceneManagerSetupReturns the current setup of the SceneManager.
IsPreviewSceneIs the Scene a preview Scene?
IsPreviewSceneObjectIs this object part of a preview Scene?
LoadSceneAsyncInPlayModeThis method allows you to load a Scene during playmode in the editor, without requiring the Scene to be included in the Build Settings Scene list.
LoadSceneInPlayModeThis method allows you to load a Scene during playmode in the editor, without requiring the Scene to be included in the Build Settings Scene list.
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.
NewPreviewSceneCreates a new preview Scene. Any object added to a preview Scene will only be rendered in that 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.
SetSceneCullingMaskSet the culling mask on this scene to this value. Cameras will only render objects in Scenes that have the same bits set in their culling mask.

Events

activeSceneChangedInEditModeSubscribe to this event to get notified when the active Scene has changed in Edit mode in the Editor.
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 Properties

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

Static Methods

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 loaded Scenes.
GetSceneByBuildIndexGet a Scene struct from a build index.
GetSceneByNameSearches through the Scenes loaded for a Scene with the given name.
GetSceneByPathSearches all Scenes loaded 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

activeSceneChangedSubscribe to this event to get notified 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.

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