DockManagerclass

objectWidgetDockManager
Namespace
Editor
Assembly
Sandbox.Tools
Declaration
public class Editor.DockManager : Editor.Widget

Constructors1

Showing 1 constructors

Methods11

Showing 11 methods

public void Clear()PUBLIC

Clear the known widgets, reset manager to an empty state.

Returns:void

public T Create()PUBLIC

Creates a widget by type

Returns:T

public Editor.Widget GetDockWidget(string name)PUBLIC

Get an active, created dock

ParameterTypeDescription
namestring
Returns:Widget

public void RegisterDockType(string name, string icon, System.Func`1<Editor.Widget> create, bool deleteOnClose = True)PUBLIC

ParameterTypeDescription
namestring
iconstring
createFunc<Widget>
deleteOnClose = Truebool
Returns:void

public void SetDockState(string name, bool visible)PUBLIC

Set dock as visible, or hidden, by name.

ParameterTypeDescription
namestring
visiblebool
Returns:void

public void UnregisterDockType(string name)PUBLIC

Unregister a dock type.

ParameterTypeDescription
namestring
Returns:void

Properties3

Showing 3 properties

public System.Collections.Generic.IEnumerable`1<Editor.DockManager.DockInfo> Editor.DockManager.DockTypes { get; set; }PUBLICGETSET

A list of dock types that are registered.

Returns:IEnumerable<DockInfo>

public System.Action Editor.DockManager.OnLayoutLoaded { get; set; }PUBLICGETSET

Called when the layout state is changed programatically. This is generally called when the default layout is loaded, or a saved layout is loaded.

Returns:Action

public string Editor.DockManager.State { get; set; }PUBLICGETSET

A JSON string representing the entire state of the dock manager, i.e. position of all the docks, etc.

Returns:string

On this page