[ Web Proxy ]
URL:
Viewing: https://docs.unity3d.com/ScriptReference/SceneAsset.html [Back]  [Original]

Unity - Scripting API: SceneAsset
Version: Unity 6.5 (6000.5)
    • Supported
    • Legacy
    LanguageEnglish
    • C#

    SceneAsset

    class in UnityEditor

    /

    Inherits from:Object

    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
    Your name Your email Suggestion* Submit suggestion

    Cancel

    Description

    SceneAsset is used to reference Scene objects in the Editor.

    This can be used as the type for ObjectField UI elements, to allow the user to pick a Scene object as the value of the field.

    This example shows how to pick a Scene in the editor. The ScenePicker component is placed on a game object in the Scene:

    using UnityEngine;

    public class ScenePicker : MonoBehaviour { [SerializeField] public string scenePath; }

    The ScenePickerEditor script must be in the Editor directory of the project. It provides the custom inspector in the editor that uses the SceneAsset class in an ObjectField to allow the user to pick a Scene.

    using UnityEngine;
    using UnityEditor;

    [CustomEditor(typeof(ScenePicker), true)] public class ScenePickerEditor : Editor { public override void OnInspectorGUI() { ScenePicker picker = target as ScenePicker; SceneAsset oldScene = AssetDatabase.LoadAssetAtPath<SceneAsset>(picker.scenePath);

    serializedObject.Update();

    EditorGUI.BeginChangeCheck(); SceneAsset newScene = EditorGUILayout.ObjectField("scene", oldScene, typeof(SceneAsset), false) as SceneAsset;

    if (EditorGUI.EndChangeCheck()) { string newPath = AssetDatabase.GetAssetPath(newScene); SerializedProperty scenePathProperty = serializedObject.FindProperty("scenePath"); scenePathProperty.stringValue = newPath; } serializedObject.ApplyModifiedProperties(); } }

    Inherited Members

    Properties

    PropertyDescription
    hideFlagsControls whether the object is hidden, saved with the scene, and editable by the user.
    nameThe name of the object.

    Public Methods

    MethodDescription
    GetEntityIdGets the EntityId of the object.
    GetHashCodeReturns the hash code for the object.
    ToStringReturns the name of the object.

    Static Methods

    MethodDescription
    DestroyRemoves a GameObject, component, or asset.
    DestroyImmediateDestroys the specified object immediately. Use with caution and in Edit mode only.
    DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
    FindAnyObjectByTypeRetrieves any active loaded object of Type T.
    FindObjectsByTypeRetrieves 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's related to another GameObject and obtains an AsyncInstantiateOperation instance of the resulting objects.

    Operators

    OperatorDescription
    boolDetermines whether the object exists.
    operator !=Compares if two objects refer to a different object.
    operator ==Compares two object references to see if they refer to the same object.

    Web Proxy Viewer  |  New URL  |  Original Page