HelpDrawer Class

Reference

Definition

Namespace:: Microsoft.MixedReality.Toolkit.Editor

Assembly:: Microsoft.MixedReality.Toolkit.Editor.Inspectors.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Custom property drawer to show an optionally collapsible foldout help section in the Inspector

C++

public ref class HelpDrawer : UnityEditor::DecoratorDrawer

[UnityEditor.CustomPropertyDrawer(typeof(Microsoft.MixedReality.Toolkit.HelpAttribute))]
public class HelpDrawer : UnityEditor.DecoratorDrawer

[<UnityEditor.CustomPropertyDrawer(typeof(Microsoft.MixedReality.Toolkit.HelpAttribute))>]
type HelpDrawer = class
    inherit DecoratorDrawer

Public Class HelpDrawer
Inherits DecoratorDrawer

Inheritance: UnityEditor.DecoratorDrawer
HelpDrawer

Attributes: UnityEditor.CustomPropertyDrawerAttribute

Examples

[Help("This is a multiline optionally collapsable help section.\n • Great for providing simple instructions in Inspector.\n • Easy to use.\n • Saves space.")]

Constructors

HelpDrawer()

Methods

GetHeight()	Gets the height of the decorator
OnGUI(Rect)	Unity calls this function to draw the GUI

Applies to

Product	Versions
MRTK2 Unity 2018	2.5.0, 2.5.1, 2.5.2, 2.5.3, 2.5.4, 2.6.0, 2.7.0
MRTK2 Unity 2019	2.5.0, 2.5.1, 2.5.2, 2.5.3, 2.5.4, 2.6.0, 2.7.0, 2.8.0
MRTK2 Unity 2020	2.5.2, 2.5.3, 2.5.4, 2.6.0, 2.7.0, 2.8.0

Share via