Version: 2023.2
LanguageEnglish
  • C#

ToolAttribute

class in UnityEditor.EditorTools

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

Base class from which EditorToolAttribute and EditorToolContextAttribute inherit.

Static Properties

defaultPriorityThe default value for ToolAttribute.toolPriority and ToolAttribute.variantPriority. Specify a priority lower than this value to display a tool before the default entries, or specify a higher value to display it after the default entries.

Properties

displayNameThe name that displays in menus.
targetContextIf provided, the EditorTool will only be made available when the ToolManager.activeContextType is equal to targetContext.
targetTypeSet to the type that this EditorTool or EditorToolContext can edit. Set to null if the tool is not specific to a Component and should be available at any time.
toolPriorityTool priority defines the order that tools are displayed in within the Tools Overlay.
variantGroupTool variants are used to group logically similar tools into a single button in the Tools Overlay.
variantPriorityThe variant priority defines the order that tools are displayed in when they are displayed in a ToolAttribute.variantGroup dropdown.