CommentAsset Class

Summary

Holds a text comment as a UnityEngine.ScriptableObject asset which can be viewed and edited in the inspector.
Assembly
Kybernetik.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

Remarks

By default, this script sets itself to be excluded from the build.

Attributes

Type Description
CreateAssetMenuAttribute
HelpURLAttribute

Properties

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