EditorWindow

Description

Derive from this class to create a custom Editor window.

Use this class to create Editor windows that can either float independently or dock as tabs, similar to the default windows in the Unity Editor.

You can use the MenuItem attribute to configure an Editor window to be opened in the Unity Editor menu.

When creating a custom Editor window, follow these guidelines:

• Put code dependent on UXML/USS loading in the CreateGUI method to ensure that all necessary assets are available.
• Keep the event registration code inside CreateGUI or after CreateGUI is called.

The following diagram shows the order of execution of an Editor window:

• OnEnable: Called when the script is loaded or when the object is enabled.
• EditorApplication.isUpdating: If true, the Editor is currently refreshing the AssetDatabase.
• CreateGUI: Generates the graphical user interface if the Editor is not updating.
• Update: Called once per frame to update the script's logic.
• OnGUI: Called multiple times per frame for rendering and handling GUI events.
• OnDisable: Called when the script is disabled or the object is destroyed to finalize and clean up resources.

For an example on how to create an Editor window that reacts to user input, refer to Create a custom Editor window with C# script.

using UnityEditor;
using UnityEngine;
using UnityEngine.UIElements;

public class MyEditorWindow : EditorWindow
{
    [MenuItem("Examples/My Editor Window")]
    public static void ShowExample()
    {
        MyEditorWindow wnd = GetWindow<MyEditorWindow>();
        wnd.titleContent = new GUIContent("MyEditorWindow");
    }

    public void CreateGUI()
    {
        // Each editor window contains a root VisualElement object
        VisualElement root = rootVisualElement;

        // VisualElements objects can contain other VisualElement following a tree hierarchy
        Label label = new Label("Hello World!");
        root.Add(label);

        // Create button
        Button button = new Button();
        button.name = "button";
        button.text = "Button";
        root.Add(button);

        // Create toggle
        Toggle toggle = new Toggle();
        toggle.name = "toggle";
        toggle.label = "Toggle";
        root.Add(toggle);
    }
}

Static Properties

Properties

Public Methods

Protected Methods

Static Methods

Messages

Events

Inherited Members