Version: 2022.3
LanguageEnglish
  • C#

PrefabStage

class in UnityEditor.SceneManagement

/

Inherits from:SceneManagement.PreviewSceneStage

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 PrefabStage class represents an editing context for Prefab Assets.

A stage is 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 which are shown in the Scene view when in Prefab Mode each represent a stage. Those with a Prefab icon represent Prefab stages.

Properties

assetPathThe asset path where the Prefab Asset file is stored, relative to the project root.
modeThe Prefab Stage can be opened either in isolation or in context.
openedFromInstanceObjectA GameObject inside the Prefab instance that you opened Prefab Mode through.
openedFromInstanceRootThe root of the Prefab instance that you opened Prefab Mode through.
prefabContentsRootThe root GameObject of the loaded Prefab Asset contents.

Public Methods

ClearDirtinessClear the dirtyness flag for the Prefab stage.
IsPartOfPrefabContentsReturns true if the given GameObject is part of the loaded Prefab Asset contents in the Prefab stage.

Events

prefabSavedCallback that is invoked whenever the contents of a Prefab stage has been saved.
prefabSavingCallback that's invoked whenever the contents of a Prefab stage is about to be saved.
prefabStageClosingCallback that's invoked whenever a Prefab stage is about to be opened.
prefabStageDirtiedCallback that's invoked whenever a Prefab stage changes from unmodified to modified.
prefabStageOpenedCallback that's invoked whenever a Prefab stage has been opened.

Inherited Members

Properties

hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.
sceneThe preview Scene this stage controls. Stage content should be moved into this Scene.
stageHandleSee Stage.stageHandle.
assetPathThe path of the Asset file associated with the stage, relative to the project root folder.
stageHandleThe StageHandle struct for this stage.

Public Methods

GetInstanceIDGets 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 Methods

OnCloseStageUnity calls this method when the Stage is closed. Classes that inherit from PreviewSceneStage should implement cleanup logic in this method.
OnOpenStageUnity calls this method when the Stage is opened. Classes that inherit from PreviewSceneStage should implement initialization logic in this method.
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 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.
FindAnyObjectByTypeRetrieves any active loaded object of Type type.
FindFirstObjectByTypeRetrieves the first active loaded object of Type type.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsByTypeRetrieves a list of all loaded objects of Type type.
FindObjectsOfTypeGets a list of all loaded objects of Type type.
InstantiateClones the object original and returns the clone.
InstantiateAsyncCaptures a snapshot of the original object (that must be related to some GameObject) and returns the AsyncInstantiateOperation.
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

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