EffectInfoAttribute
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true)]public sealed class EffectInfoAttribute : AttributeAttaches display metadata to an ITextStudioEffect or a
TextStudioEffectAsset subclass so editor tooling can render a premium
inspector (category grouping, tooltips, markup snippet preview).
Constructors
Section titled “Constructors”
EffectInfoAttribute(string, string, string, string)
Section titled “EffectInfoAttribute(string, string, string, string)”public EffectInfoAttribute(string category, string displayName, string description = null, string markupSnippet = null)Creates discoverable authoring metadata for a code-defined effect.
Parameters
| Name | Type |
|---|---|
category |
System.String |
displayName |
System.String |
description |
System.String |
markupSnippet |
System.String |
Properties
Section titled “Properties”
Category
Section titled “Category”public string Category { get; }Category used to group effects in editor tooling.
Returns
System.String
DisplayName
Section titled “DisplayName”public string DisplayName { get; }Short human-readable name.
Returns
System.String
Description
Section titled “Description”public string Description { get; }One-line description surfaced as a tooltip.
Returns
System.String
MarkupSnippet
Section titled “MarkupSnippet”public string MarkupSnippet { get; }Suggested markup snippet (e.g. <wave>text</wave>).
Returns
System.String