CommentComponent Class

Summary

Holds a text comment for a GameObject which can be viewed and edited in the inspector.

By default, this script sets itself to be excluded from the build.
Assembly
InspectorGadgets.dll
Namespace
InspectorGadgets
Interfaces
Base Types
  • MonoBehaviour
graph BT Type-->Base0["MonoBehaviour"] Type-.->Interface0["IComment"] click Interface0 "/inspector-gadgets/api/InspectorGadgets/IComment" Type["CommentComponent"] class Type type-node

Syntax

[HelpURL(Strings.APIDocumentationURL + "/" + nameof(CommentComponent))]
public sealed class CommentComponent : MonoBehaviour, IComment

Attributes

Type Description
HelpURL

Properties

Name Value Summary
IncludeInBuild bool
False if this script is set to HideFlags.DontSaveInBuild.
Text string
[SerializeField] [InspectorGadgets.IComment] The text of this comment.