Version: 2023.1
LanguageEnglish
  • C#

OverlayAttribute Constructor

Leave feedback
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

Declaration

public OverlayAttribute(Type editorWindowType, string id, string displayName, string ussName, bool defaultDisplay);

Declaration

public OverlayAttribute(Type editorWindowType, string id, string displayName, bool defaultDisplay);

Declaration

public OverlayAttribute(Type editorWindowType, string displayName, bool defaultDisplay);

Declaration

public OverlayAttribute();

Parameters

id Defines the unique identifier used to identify the overlay.
ussName Name of the overlay's root visual element.
editorWindowType Defines which EditorWindow type the overlay will be used in.
displayName Defines what the display name of the overlay will be.
defaultLayout The Layout that this Overlay will be initialized with in new windows.
defaultDisplay True if this Overlay is enabled by default in new windows.

Description

Attribute used to register a class as an Overlay.

Overlays are not directly instantiated in code. The Editor will use reflection on startup to identify Overlay classes with an OverlayAttribute to populate the available Overlays in an Editor Window.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright ©2023 Unity Technologies. Publication Date: 2023-11-02.
Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use Legal Privacy Policy Cookies Do Not Sell or Share My Personal Information