Version: 2021.3
LanguageEnglish
  • C#

EditorTool.toolbarIcon

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

public GUIContent toolbarIcon;

Description

The icon and tooltip for this custom editor tool. If this function is not implemented, the toolbar displays the Inspector icon for the target type. If no target type is defined, the toolbar displays the Tool Mode icon.

This property is accessed frequently, so load the icon's GUIContent in MonoBehaviour.OnEnable.

using UnityEditor.EditorTools;
using UnityEngine;

public class ToolbarIconSample : MonoBehaviour {}

[EditorTool("Toolbar Icon Sample Tool", typeof(ToolbarIconSample))]
class ToolbarIconSampleTool : EditorTool
{
    GUIContent m_Icon;

    public override GUIContent toolbarIcon => m_Icon;

    private void OnEnable()
    {
        m_Icon = new GUIContent("Text Icon", "Toolbar Icon Sample Tool tooltip.");
    }

    private void OnDisable()
    {
        m_Icon = null;
    }
}