Version: 2017.2 (switch to 2017.3b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

EditorWindow.GetWindow

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

Cancel

public static method GetWindow(t: Type, utility: bool = false, title: string = null, focus: bool = true): EditorWindow;
public static EditorWindow GetWindow(Type t, bool utility = false, string title = null, bool focus = true);

Parameters

t The type of the window. Must derive from EditorWindow.
utility Set this to true, to create a floating utility window, false to create a normal window.
title If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title.
focus Whether to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus).

Description

Returns the first EditorWindow of type t which is currently on the screen.

If there is none, creates and shows new window and returns the instance of it.


Simple Empty non-dockable window.

// Simple script that creates a new non-dockable window

import UnityEditor;

class GetWindowEx extends EditorWindow { @MenuItem("Example/Display simple Window") static function Initialize() { var window : GetWindowEx = EditorWindow.GetWindow(GetWindowEx, true, "My Empty Window"); } }
using UnityEngine;
using UnityEditor;

// Simple script that creates a new non-dockable window public class EditorWindowTest : EditorWindow { [MenuItem("Example/Display simple Window")] static void Initialize() { EditorWindowTest window = (EditorWindowTest)EditorWindow.GetWindow(typeof(EditorWindowTest), true, "My Empty Window"); } }

public static method GetWindow(): T;
public static T GetWindow();
public static method GetWindow(utility: bool): T;
public static T GetWindow(bool utility);
public static method GetWindow(utility: bool, title: string): T;
public static T GetWindow(bool utility, string title);
public static method GetWindow(title: string): T;
public static T GetWindow(string title);
public static method GetWindow(title: string, focus: bool): T;
public static T GetWindow(string title, bool focus);
public static method GetWindow(utility: bool, title: string, focus: bool): T;
public static T GetWindow(bool utility, string title, bool focus);

Parameters

T The type of the window. Must derive from EditorWindow.
utility Set this to true, to create a floating utility window, false to create a normal window.
title If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title.
focus Whether to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus).

Description

Returns the first EditorWindow of type T which is currently on the screen.

If there is none, creates and shows new window and returns the instance of it.


public static method GetWindow(params desiredDockNextTo: Type[]): T;
public static T GetWindow(params Type[] desiredDockNextTo);
public static method GetWindow(title: string, params desiredDockNextTo: Type[]): T;
public static T GetWindow(string title, params Type[] desiredDockNextTo);
public static method GetWindow(title: string, focus: bool, params desiredDockNextTo: Type[]): T;
public static T GetWindow(string title, bool focus, params Type[] desiredDockNextTo);

Parameters

T The type of the window. Must derive from EditorWindow.
title If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title.
desiredDockNextTo An array of EditorWindow types that the window will attempt to dock onto.
focus Whether to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus).

Description

Returns the first EditorWindow of type T which is currently on the screen.

If there is none, creates and shows new window and returns the instance of it. The created window will attempt to be docked next to the first founds specified window type.

Did you find this page useful? Please give it a rating: