Version: 2023.2
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

defaultDisplaySet this value to true to ensure that the target Overlay will be shown when a new instance of the EditorWindow type is instantiated.
defaultDockIndexSet the defaultDockIndex to define where in a DockZone an Overlay is placed.
defaultDockPositionSet defaultDockPosition to define the default alignment for a newly instantiated Overlay.
defaultDockZoneUse defaultDockZone to set the default location for an Overlay when it is made visible for the first time in a new EditorWindow.
defaultHeightSet defaultHeight to define the height of an Overlay when it hasn't been resized by the user.
defaultLayoutSet defaultLayout to define the Layout for an Overlay when it is created for the first time.
defaultWidthSet defaultWidth to define the width of an Overlay when it hasn't been resized by the user.
displayNameDefines what the display name of the overlay will be.
editorWindowTypeDefines which EditorWindow type the overlay is used in.
idDefines the unique identifier used to identify the overlay.
maxHeightSet maxHeight to define the maximum height of an Overlay.
maxWidthSet maxWidth to define the maximum width of an Overlay.
minHeightSet minHeight to define the minimum height of an Overlay.
minWidthSet maxWidth to define the minimum width of an Overlay.
ussNameName of the overlay's root visual element.

Constructors

OverlayAttributeAttribute used to register a class as an Overlay.