OpenPreviewScene(string)
Opens a Scene Asset in a preview Scene.
Read time 1 minuteLast updated 13 days ago
Definition
- Type: Method
- Namespace: UnityEditor.SceneManagement
- Assembly: UnityEditor.CoreModule
public static Scene OpenPreviewScene(string scenePath)
Parameters
Scene file to open.
Returns
Type | Description |
|---|---|
| Scene | The created preview Scene. |
Remarks
You can use this function for tooling that needs to access GameObjects but where the scene should not be displayed in the Hierarchy. Make sure to call EditorSceneManager.ClosePreviewScene to prevent leaking scenes.
Additional Resources: EditorSceneManager.NewPreviewScene, EditorSceneManager.ClosePreviewScene.
Examples
using UnityEditor;using UnityEditor.SceneManagement;using UnityEngine;public static class TestOpenAsPreviewScene{ [MenuItem("Assets/Scene Root Names")] static void OpenContextClickedSceneInAPreviewScene() { SceneAsset sceneAsset = Selection.activeObject as SceneAsset; if (sceneAsset == null) { Debug.Log("Context click on a Scene Asset file"); return; } var assetPath = AssetDatabase.GetAssetPath(sceneAsset); var scene = EditorSceneManager.OpenPreviewScene(assetPath); try { var rootGameObjects = scene.GetRootGameObjects(); Debug.Log($"Root GameObject Names (count: {rootGameObjects.Length})"); foreach (var gameObject in rootGameObjects) Debug.Log(gameObject.name); } finally { EditorSceneManager.ClosePreviewScene(scene); } }}