MainStage

class in UnityEditor.SceneManagement

/

Inherits from:SceneManagement.Stage

Switch to Manual

Description

The Main Stage contains all the currently open regular Scenes and is always available.

The Main Stage also includes the DontDestroyOnLoad Scene, which the Hierarchy sometimes shows during Play Mode, as well as every GameObject marked with the HideFlags.HideAndAndDontSave HideFlags. It includes these GameObjects because, by default, these GameObjects do not belong to any particular Scene but Unity renders them together with the Main Stage objects in the SceneView.

Other Stage types exists for Editor tooling purposes. For example, you can use PreviewSceneStage as a base class for custom Stages.

Inherited members

Variables

hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.
assetPathThe path of the Asset file associated with the stage, relative to the project root folder.
stageHandleThe StageHandle struct for this stage.

Public Functions

GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the object.
FindComponentOfTypeReturns the first active loaded object of the given type.
FindComponentsOfTypeReturns a list of all active loaded objects of the given type.
GetCombinedSceneCullingMaskForCameraGets the Scene culling mask from this Stage.

Protected Functions

CreateHeaderContentCreates the header content for this Stage. Both the Hierarchy window header and Scene view breadcrumb bar use this content.
GetHashForStateStorageUnity calls this method to get a hash code that is used to save the state of the Stage to disk.
OnCloseStageUnity calls this method when the Stage is closed. Classes that inherit from Stage should implement cleanup logic in this method.
OnDisableSee ScriptableObject.OnDisable.
OnEnableSee ScriptableObject.OnEnable.
OnFirstTimeOpenStageInSceneViewUnity calls this method the first time a Stage is opened for a specific Asset, for a specific Scene view.
OnOpenStageUnity calls this method when the Stage is opened. Classes that inherit from Stage should implement initialization logic in this method.
OnReturnToStageUnity calls this method when you return to a Stage that is already open.

Static Functions

DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeGets a list of all loaded objects of Type type.
InstantiateClones the object original and returns the clone.
CreateInstanceCreates an instance of a scriptable object.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.

Messages

AwakeThis function is called when the ScriptableObject script is started.
OnDestroyThis function is called when the scriptable object will be destroyed.
OnDisableThis function is called when the scriptable object goes out of scope.
OnEnableThis function is called when the object is loaded.
OnValidateThis function is called when the script is loaded or a value is changed in the Inspector (Called in the editor only).
ResetReset to default values.