Attribute used to register a class as an overlay.
Overlay must derive from the Overlay class.
defaultDisplay | Set this value to true to ensure that the target Overlay will be shown when a new instance of the EditorWindow type is instantiated. |
defaultDockIndex | Set the defaultDockIndex to define where in a DockZone an Overlay is placed. |
defaultDockPosition | Set defaultDockPosition to define the default alignment for a newly instantiated Overlay. |
defaultDockZone | Use defaultDockZone to set the default location for an Overlay when it is made visible for the first time in a new EditorWindow. |
defaultLayout | Set defaultLayout to define the Layout for an Overlay when it is created for the first time. |
displayName | Defines what the display name of the overlay will be. |
editorWindowType | Defines which EditorWindow type the overlay is used in. |
id | Defines the unique identifier used to identify the overlay. |
ussName | Name of the overlay's root visual element. |
OverlayAttribute | Attribute used to register a class as an Overlay. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.