Legacy Documentation: Version 5.6 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Help.HasHelpForObject

Other Versions
public static bool HasHelpForObject(Object obj);

Description

Is there a help page for this object?

See Also: Help.ShowHelpForObject, Help.GetHelpURLForObject.


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

    // 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.

    import UnityEditor;

    class QuickHelper extends EditorWindow {

        var source : Object;

        @MenuItem("Example/QuickHelper _h")
        static function Init() {
            var window : QuickHelper = EditorWindow.GetWindowWithRect(QuickHelper, Rect(0,0,165,100));
            window.Show();
        }

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

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

Leave Feedback

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 © 2017 Unity Technologies. Publication: 5.6-001N. Built: 2017-07-12.
Tutorials Community Answers Knowledge Base Forums Asset Store LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information