EditorWindow
Derive from this class to create a custom Editor window.
Read time 8 minutesLast updated 5 days ago
Definition
- Type: Class
- Namespace: UnityEditor
- Assembly: UnityEditor.CoreModule
- Inherits from: ScriptableObject
[ExcludeFromObjectFactory]public class EditorWindow : ScriptableObject
Remarks
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 multiple times per second on all visible windows.
- 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.
Examples
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); }}
Properties
Property | Description |
|---|---|
| autoRepaintOnSceneChange | Enable this property to automatically repaint the window when the SceneView is modified. |
| dataModeController | An instance of IDataModeController to handle DataMode functionalities for the current window. |
| docked | Returns true if EditorWindow is docked. |
| hasFocus | Returns true if EditorWindow is focused. |
| hasUnsavedChanges | This property specifies whether the Editor prompts the user to save or discard unsaved changes before the window closes. |
| maximized | Whether or not this window is maximized? |
| maxSize | The maximum size of this window when it is floating or modal. The maximum size is not used when the window is docked. |
| minSize | The minimum size of this window when it is floating or modal. The minimum size is not used when the window is docked. |
| overlayCanvas | The OverlayCanvas for this window. |
| position | The desired position of the window in screen space. |
| rootVisualElement | Retrieves the root visual element of this window hierarchy. |
| saveChangesMessage | The message that displays to the user if they are prompted to save |
| titleContent | The GUIContent used for drawing the title of EditorWindows. |
| wantsLessLayoutEvents | Specifies whether a layout pass is performed before all user events (for example, EventType.MouseDown or EventType.KeyDown), or is only performed before repaint events. |
| wantsMouseEnterLeaveWindow | Checks whether MouseEnterWindow and MouseLeaveWindow events are received in the GUI in this Editor window. |
| wantsMouseMove | Checks whether MouseMove events are received in the GUI in this Editor window. |
Static Properties
Property | Description |
|---|---|
| focusedWindow | The EditorWindow which currently has keyboard focus. (Read Only) |
| mouseOverWindow | The EditorWindow currently under the mouse cursor. (Read Only) |
Methods
Method | Description |
|---|---|
| Awake | Called as the new window is opened. |
| BeginWindows | Mark the beginning area of all popup windows. |
| Close | Close the editor window. |
| CreateGUI | CreateGUI is called when the EditorWindow's rootVisualElement is ready to be populated. |
| DiscardChanges | Discards unsaved changes to the contents of the window. |
| EndWindows | Close a window group started with EditorWindow.BeginWindows(). |
| Focus | Moves keyboard focus to another EditorWindow. |
| GetExtraPaneTypes | Gets the extra types of EditorWindow associated with the current window. |
| OnBackingScaleFactorChanged | Called when the UI scaling for this EditorWindow is changed. |
| OnBecameInvisible | Called after the window is removed from a container view, or is no longer visible within a tabbed collection of EditorWindow. |
| OnBecameVisible | Called after the window is added to a container view. |
| OnDestroy | OnDestroy is called to close the EditorWindow window. |
| OnFocus | Called when the window gets keyboard focus. |
| OnGUI | Implement your own editor GUI here. |
| OnHierarchyChange | Handler for message that is sent when an object or group of objects in the hierarchy changes. |
| OnInspectorUpdate | OnInspectorUpdate is called at 10 frames per second to give the inspector a chance to update. |
| OnLostFocus | Called when the window loses keyboard focus. |
| OnProjectChange | Handler for message that is sent whenever the state of the project changes. |
| OnSelectionChange | Called whenever the selection has changed. |
| RemoveNotification | Stop showing notification message. |
| Repaint | Make the window repaint. This queues a command to render the window on the next frame. |
| SaveChanges | Performs a save action on the contents of the window. |
| SendEvent | Sends an Event to a window. |
| Show | Show the EditorWindow window. |
| ShowAsDropDown | Shows a window with dropdown behaviour and styling. |
| ShowAuxWindow | Show the editor window in the auxiliary window. |
| ShowModal | Show modal editor window. |
| ShowModalUtility | Shows the EditorWindow as a floating modal window. |
| ShowNotification | Show a notification message. |
| ShowPopup | Shows an Editor window using popup-style framing. |
| ShowTab | Shows a docked Editor window. |
| ShowUtility | Show the EditorWindow as a floating utility window. |
| TryGetOverlay | Get an Overlay with matching ID from an EditorWindow canvas. |
| Update | Called multiple times per second on all visible windows. |
Static Methods
Method | Description |
|---|---|
| CreateWindow | Creates an EditorWindow of type |
| FocusWindowIfItsOpen | Focuses the first found EditorWindow of specified type if it is open. |
| GetWindow | Returns the first EditorWindow of type |
| GetWindowWithRect | Returns the first EditorWindow of type |
| HasOpenInstances | Checks if an editor window is open. |
Static Events
Member | Description |
|---|---|
| windowFocusChanged | Called whenever the focused editor window is changed. |
Inheritance
Operators
Operator | Description |
|---|---|
| operator == | Compares two object references to see if they refer to the same object. |
| bool | Determines whether the object exists. |
| operator != | Compares if two objects refer to a different object. |