Version: 2018.3 (switch to 2019.1)
LanguageEnglish
  • C#

Help.ShowHelpForObject

Other Versions
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

public static void ShowHelpForObject(Object obj);

Description

Show help page for this object.

See Also: Help.HasHelpForObject, Help.GetHelpURLForObject.


Editor Window that lets you load docs for any Selected GameObject.

using UnityEngine;
using UnityEditor;

// EditorScript that quickly searchs for a help page
// of the selected Object.
//
// If there is no page found on the Manual it opens the Unity forum.

class QuickHelper : EditorWindow
{
    Object source;

    [@MenuItem("Example/QuickHelper _h")]
    static void Init()
    {
        EditorWindow window = EditorWindow.GetWindowWithRect(typeof(QuickHelper), new Rect(0, 0, 165, 100));
        window.Show();
    }

    void OnGUI()
    {
        EditorGUILayout.BeginHorizontal();
        source = EditorGUILayout.ObjectField(source, typeof(Object));
        EditorGUILayout.EndHorizontal();

        if (GUILayout.Button("Search!"))
        {
            if (source == null)
            {
                this.ShowNotification(new GUIContent("No object selected for searching"));
            }
            else
            {
                if (Help.HasHelpForObject(source))
                {
                    Help.ShowHelpForObject(source);
                }
                else
                {
                    Help.BrowseURL("http://forum.unity3d.com/search.php");
                }
            }
        }
    }
}

Did you find this page useful? Please give it a rating:

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 © 2019 Unity Technologies. Publication: 2018.3-002V. Built: 2019-04-15.
TutorialsCommunity AnswersKnowledge BaseForumsAsset StoreLegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information