Version: 2021.2
LanguageEnglish
  • C#

Stage

class in UnityEditor.SceneManagement

/

Inherits from:ScriptableObject

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

The Stage class represents an editing context which includes a collection of Scenes.

The main stage contains all the currently open regular Scenes, while a Prefab stage contains a preview Scene used solely for editing the Prefab in.

The breadcrumbs shown in the Scene view when in Prefab Mode each represent an individual stage. Those with a Prefab icon represent Prefab stages.

See Also: MainStage, PreviewSceneStage.

Properties

assetPathThe path of the Asset file associated with the stage, relative to the project root folder.
stageHandleThe StageHandle struct for this stage.

Public Methods

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 Methods

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.

Inherited Members

Properties

hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.

Public Methods

GetInstanceIDGets the instance ID of the object.
ToStringReturns the name of the object.

Static Methods

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.
OnValidateEditor-only function that Unity calls when the script is loaded or a value changes in the Inspector.
ResetReset to default values.