Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

OverlayAttribute

class in UnityEditor.Overlays

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

Description

Attribute used to register a class as an overlay.

Overlay must derive from the Overlay class.

Properties

defaultDisplayWhether the target Overlay is shown when a new instance of the EditorWindow type is instantiated.
defaultDockIndexSets the defaultDockIndex to define where in a DockZone an Overlay is placed.
defaultDockPositionSets the default alignment for a new Overlay instance.
defaultDockZoneSets the default location of an Overlay in an EditorWindow.
defaultHeightSets the default height of an Overlay.
defaultLayoutSets the default Layout for an Overlay when it is created for the first time.
defaultWidthSets the default width of an Overlay.
displayNameDefines the display name of the overlay.
editorWindowTypeDefines which EditorWindow type the overlay is used in.
idDefines the unique identifier used to identify the overlay.
maxHeightSets the maximum height of an Overlay.
maxWidthSets the maximum width of an Overlay.
minHeightSets the minimum height of an Overlay.
minWidthSets the minimum width of an Overlay.
prioritySets the order that overlays are displayed in the overlay menu. The default value is 100. Lower values are displayed before higher values.
ussNameName of the overlay's root visual element.

Constructors

OverlayAttributeAttribute used to register a class as an Overlay.