Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


DockZone

DockZone describes the area of the screen that an Overlay is displayed in.
Read time 1 minuteLast updated 14 days ago

Definition

public enum DockZone

Remarks

Use DockZone in an OverlayAttribute to set the default location for an Overlay.

Examples

using UnityEditor;using UnityEditor.Overlays;using UnityEngine;using UnityEngine.UIElements;// Use OverlayAttribute to specify that in new Scene Views, when this Overlay is first opened it will be in the// top toolbar, aligned to the left side.[Overlay(typeof(SceneView), "Docked Top Toolbar, Left Aligned", defaultDockZone = DockZone.TopToolbar, defaultDockPosition = DockPosition.Top)]class MyOverlay : Overlay{ public override VisualElement CreatePanelContent() => new Label("Overlay Contents");}

Fields

Value

Description

BottomToolbarOverlays are displayed in the bottom toolbar.
FloatingOverlays are not bound to a toolbar or column.
LeftColumnOverlays are displayed in the left column.
LeftToolbarOverlays are displayed in the left toolbar.
RightColumnOverlays are displayed in the right column.
RightToolbarOverlays are displayed in the right toolbar.
TopToolbarOverlays are displayed in the top toolbar.