CommentAsset Class

Summary

Holds a text comment as a ScriptableObject asset 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
  • ScriptableObject
graph BT Type-->Base0["ScriptableObject"] Type-.->Interface0["IComment"] click Interface0 "/inspector-gadgets/api/InspectorGadgets/IComment" Type["CommentAsset"] class Type type-node

Syntax

[CreateAssetMenu(menuName = "Comment", fileName = "Comment", order = 26)]
[HelpURL(Strings.APIDocumentationURL + "/" + nameof(CommentAsset))]
public sealed class CommentAsset : ScriptableObject, IComment

Attributes

Type Description
CreateAssetMenu
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.