EditorToolAttribute
Registers an EditorTool as either a Global tool or a CustomEditor tool.
Read time 4 minutesLast updated 7 days ago
Definition
- Type: Constructor
- Namespace: UnityEditor.EditorTools
- Assembly: UnityEditor.CoreModule
EditorToolAttribute(string, Type)
Registers an EditorTool as either a Global tool or a CustomEditor tool.
public EditorToolAttribute(string displayName, Type componentToolTarget = null)
Parameters
Remarks
A Global tool is always available in the toolbar menu. A CustomEditor tool is only available when the current selection contains a matching target type.
EditorToolAttribute(string, Type, Type)
Registers an EditorTool as either a Global tool or a CustomEditor tool.
public EditorToolAttribute(string displayName, Type componentToolTarget, Type editorToolContext)
Parameters
The name to display in menus.
The EditorToolContext type that this tool relates to. When an EditorTool defines an scope, the tool is not shown in menus and must be activated by the EditorToolContext.ResolveTool method.
editorToolContextRemarks
A Global tool is always available in the toolbar menu. A CustomEditor tool is only available when the current selection contains a matching target type.
EditorToolAttribute(string, Type, Type, Type)
Registers an EditorTool as either a Global tool or a CustomEditor tool.
public EditorToolAttribute(string displayName, Type componentToolTarget, Type editorToolContext, Type variantGroup)
Parameters
The name to display in menus.
The EditorToolContext type that this tool relates to. When an EditorTool defines an scope, the tool is not shown in menus and must be activated by the EditorToolContext.ResolveTool method.
editorToolContextThe tool variant group to assign the tool to in the Tools overlay. Tool variants are used to group similar tools into a single button in the Tools overlay. Refer to ToolAttribute.variantGroup.
Remarks
A Global tool is always available in the toolbar menu. A CustomEditor tool is only available when the current selection contains a matching target type.
EditorToolAttribute(string, Type, Type, int, Type)
Registers an EditorTool as either a Global tool or a CustomEditor tool.
public EditorToolAttribute(string displayName, Type componentToolTarget, Type editorToolContext, int toolPriority, Type variantGroup)
Parameters
The name to display in menus.
The EditorToolContext type that this tool relates to. When an EditorTool defines an scope, the tool is not shown in menus and must be activated by the EditorToolContext.ResolveTool method.
editorToolContextThe order to display tools in the Tools overlay in. Refer to ToolAttribute.toolPriority.
The tool variant group to assign the tool to in the Tools overlay. Tool variants are used to group similar tools into a single button in the Tools overlay. Refer to ToolAttribute.variantGroup.
Remarks
A Global tool is always available in the toolbar menu. A CustomEditor tool is only available when the current selection contains a matching target type.
EditorToolAttribute(string, Type, Type, int, Type, int)
Registers an EditorTool as either a Global tool or a CustomEditor tool.
public EditorToolAttribute(string displayName, Type componentToolTarget, Type editorToolContext, int toolPriority, Type variantGroup, int variantPriority)
Parameters
The name to display in menus.
The EditorToolContext type that this tool relates to. When an EditorTool defines an scope, the tool is not shown in menus and must be activated by the EditorToolContext.ResolveTool method.
editorToolContextThe order to display tools in the Tools overlay in. Refer to ToolAttribute.toolPriority.
The tool variant group to assign the tool to in the Tools overlay. Tool variants are used to group similar tools into a single button in the Tools overlay. Refer to ToolAttribute.variantGroup.
The variant priority defines the order that tools are displayed in when they are displayed in a ToolAttribute.variantGroup dropdown.
Remarks
A Global tool is always available in the toolbar menu. A CustomEditor tool is only available when the current selection contains a matching target type.