Stage

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

Read time 5 minutes

Last updated 10 days ago

Definition


public abstract class Stage : ScriptableObject

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.

Property	Description
assetPath	The path of the Asset file associated with the stage, relative to the project root folder.
stageHandle	The StageHandle struct for this stage.

Method	Description
CreateHeaderContent	Creates the header content for this Stage. Both the Hierarchy window header and Scene view breadcrumb bar use this content.
FindComponentOfType	Returns the first active loaded object of the given type.
FindComponentsOfType	Returns a list of all active loaded objects of the given type.
GetCombinedSceneCullingMaskForCamera	Gets the Scene culling mask from this Stage.
GetHashForStateStorage	Unity calls this method to get a hash code that is used to save the state of the Stage to disk.
OnCloseStage	Unity calls this method when the Stage is closed. Classes that inherit from Stage should implement cleanup logic in this method.
OnDisable	See ScriptableObject.OnDisable().
OnEnable	See ScriptableObject.OnEnable().
OnFirstTimeOpenStageInSceneView	Unity calls this method the first time a Stage is opened for a specific Asset, for a specific Scene view.
OnOpenStage	Unity calls this method when the Stage is opened. Classes that inherit from Stage should implement initialization logic in this method.
OnReturnToStage	Unity calls this method when you return to a Stage that is already open.

Operator	Description
operator ==	Compares two object references to see if they refer to the same object.
bool	Determines whether the object exists.
operator !=	Compares if two objects refer to a different object.