Experimental: this API is experimental and might be changed or removed in the future.

PrefabStage

class in UnityEditor.Experimental.SceneManagement

/

Inherits from:SceneManagement.PreviewSceneStage

Switch to Manual

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.

The API is experimental and may change or be removed in future versions.

Variables

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 Functions

ClearDirtinessClear the dirtyness flag for the Prefab stage.
IsPartOfPrefabContentsIs this GameObject 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

Variables

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 Functions

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

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.