Class WindowsModule

Manages Editor windows and popups.

System.Object
FlaxEditor.Modules.EditorModule
WindowsModule
Namespace: FlaxEditor.Modules
Assembly: FlaxEngine.CSharp.dll
Syntax
public sealed class WindowsModule : EditorModule

Fields

ContentWin

The content window.

Declaration
public ContentWindow ContentWin
Field Value
ContentWindow

DebugLogWin

The debug log window.

Declaration
public DebugLogWindow DebugLogWin
Field Value
DebugLogWindow

EditorOptionsWin

The editor options window.

Declaration
public EditorOptionsWindow EditorOptionsWin
Field Value
EditorOptionsWindow

EditWin

The edit game window.

Declaration
public EditGameWindow EditWin
Field Value
EditGameWindow

GameCookerWin

The game cooker window.

Declaration
public GameCookerWindow GameCookerWin
Field Value
GameCookerWindow

GameWin

The game window.

Declaration
public GameWindow GameWin
Field Value
GameWindow

GraphicsQualityWin

The graphics quality window.

Declaration
public GraphicsQualityWindow GraphicsQualityWin
Field Value
GraphicsQualityWindow

OutputLogWin

The output log window.

Declaration
public OutputLogWindow OutputLogWin
Field Value
OutputLogWindow

PluginsWin

The plugins manager window.

Declaration
public PluginsWindow PluginsWin
Field Value
PluginsWindow

ProfilerWin

The profiler window.

Declaration
public ProfilerWindow ProfilerWin
Field Value
ProfilerWindow

PropertiesWin

The properties window.

Declaration
public PropertiesWindow PropertiesWin
Field Value
PropertiesWindow

SceneWin

The scene tree window.

Declaration
public SceneTreeWindow SceneWin
Field Value
SceneTreeWindow

ToolboxWin

The toolbox window.

Declaration
public ToolboxWindow ToolboxWin
Field Value
ToolboxWindow

VisualScriptDebuggerWin

The Visual Script debugger window.

Declaration
public VisualScriptDebuggerWindow VisualScriptDebuggerWin
Field Value
VisualScriptDebuggerWindow

Windows

List with all created editor windows.

Declaration
public readonly List<EditorWindow> Windows
Field Value
System.Collections.Generic.List<EditorWindow>

Properties

MainWindow

The main editor window.

Declaration
public Window MainWindow { get; }
Property Value
Window

Methods

CloseAllEditors(ContentItem)

Closes all windows that are using given element to view/edit it.

Declaration
public void CloseAllEditors(ContentItem item)
Parameters
FlaxEditor.Content.ContentItem item

The item.

FindEditor(ContentItem)

Finds the first window that is using given element to view/edit it.

Declaration
public EditorWindow FindEditor(ContentItem item)
Parameters
FlaxEditor.Content.ContentItem item

The item.
Returns
EditorWindow

Editor window or null if cannot find any window.

FlashMainWindow()

Flash main editor window to catch user attention

Declaration
public void FlashMainWindow()

LoadDefaultLayout()

Loads the default workspace layout for the current editor version.

Declaration
public void LoadDefaultLayout()

LoadLayout(String)

Loads the layout from the file.

Declaration
public bool LoadLayout(string path)
Parameters
System.String path

The layout file path.
Returns
System.Boolean

True if layout has been loaded otherwise if failed (e.g. missing file).

OnEndInit()

Declaration
public override void OnEndInit()
Overrides
FlaxEditor.Modules.EditorModule.OnEndInit()

OnExit()

Declaration
public override void OnExit()
Overrides
FlaxEditor.Modules.EditorModule.OnExit()

OnInit()

Declaration
public override void OnInit()
Overrides
FlaxEditor.Modules.EditorModule.OnInit()

OnPlayBegin()

Declaration
public override void OnPlayBegin()
Overrides
FlaxEditor.Modules.EditorModule.OnPlayBegin()

OnPlayBeginning()

Declaration
public override void OnPlayBeginning()
Overrides
FlaxEditor.Modules.EditorModule.OnPlayBeginning()

OnPlayEnd()

Declaration
public override void OnPlayEnd()
Overrides
FlaxEditor.Modules.EditorModule.OnPlayEnd()

OnUpdate()

Declaration
public override void OnUpdate()
Overrides
FlaxEditor.Modules.EditorModule.OnUpdate()

Open(EditorWindow)

Opens the specified editor window (shows it with editor options handling for new windows).

Declaration
public void Open(EditorWindow window)
Parameters
EditorWindow window

The window.

SaveCurrentLayout()

Saves the current workspace layout.

Declaration
public void SaveCurrentLayout()

SaveLayout()

Asks user for the layout name and saves the current windows layout in the current project cache folder.

Declaration
public void SaveLayout()

SaveLayout(String)

Saves the layout to the file.

Declaration
public void SaveLayout(string path)
Parameters
System.String path

The layout file path.

TakeScreenshot()

Takes the screenshot of the current viewport.

Declaration
public void TakeScreenshot()

UpdateWindowTitle()

Updates the main window title.

Declaration
public void UpdateWindowTitle()

Events

MainWindowClosing

Occurs when main editor window is being closed.

Declaration
public event Action MainWindowClosing
Event Type
System.Action

WindowAdded

Occurs when new window gets opened and added to the editor windows list.

Declaration
public event Action<EditorWindow> WindowAdded
Event Type
System.Action<EditorWindow>

WindowRemoved

Occurs when new window gets closed and removed from the editor windows list.

Declaration
public event Action<EditorWindow> WindowRemoved
Event Type
System.Action<EditorWindow>

Extension Methods

See Also

FlaxEditor.Modules.EditorModule