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

Script language

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

Help.ShowHelpForObject

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 method ShowHelpForObject(obj: Object): void;
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.

    // 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"); } } } }

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