Version: 2022.3
LanguageEnglish
  • C#

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

Declaration

public static void ShowHelpForObject(Object obj);

Description

Show help page for this object.

Additional resources: 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"); } } } } }
Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961