TextStudioCodeEffectAsset
public abstract class TextStudioCodeEffectAsset : TextStudioEffectDefinitionAsset, ITextStudioEffectCapabilitiesProvider, ITextStudioEffectFactory, ITextStudioEffectDefinition, ITextStudioEffectMetadataProviderLean asset-backed definition for programmable leaf effects. Lifecycle, playback, curves, sequencing, and scope are authored by Composed Effect layers rather than this asset.
Methods
Section titled “Methods”
CreateEffect(in TextStudioTagParameters)
Section titled “CreateEffect(in TextStudioTagParameters)”public abstract ITextStudioEffect CreateEffect(in TextStudioTagParameters parameters)Creates an invocation-specific evaluator from parsed tag parameters.
Parameters
| Name | Type | Description |
|---|---|---|
parameters |
TextStudio.TextStudioTagParameters | Read-only parsed parameters for one effect occurrence. |
Returns
TextStudio.ITextStudioEffect: A detached evaluator, or null when binding fails.
ValidatePublishedParameters()
Section titled “ValidatePublishedParameters()”protected abstract void ValidatePublishedParameters()Validates the published parameter contract after serialized values change.
EnsureIdentityInitialized()
Section titled “EnsureIdentityInitialized()”protected void EnsureIdentityInitialized()Initializes missing identity and metadata fields from the effect’s declared defaults.
Constructors
Section titled “Constructors”
TextStudioCodeEffectAsset()
Section titled “TextStudioCodeEffectAsset()”protected TextStudioCodeEffectAsset()Properties
Section titled “Properties”
public override string Id { get; }Returns
System.String
DefaultArea
Section titled “DefaultArea”public override TextStudioEffectAreaSettings DefaultArea { get; }Returns
TextStudio.TextStudioEffectAreaSettings
BlendMode
Section titled “BlendMode”public override EffectBlendMode BlendMode { get; }Returns
TextStudio.EffectBlendMode
Capabilities
Section titled “Capabilities”public override TextStudioEffectCapabilities Capabilities { get; }Gets immutable capabilities used by authoring validation and runtime compatibility checks.
Returns
TextStudio.TextStudioEffectCapabilities
DefaultId
Section titled “DefaultId”protected virtual string DefaultId { get; }Returns
System.String
DefaultCategory
Section titled “DefaultCategory”protected virtual string DefaultCategory { get; }Returns
System.String
DefaultDisplayName
Section titled “DefaultDisplayName”protected virtual string DefaultDisplayName { get; }Returns
System.String
DefaultDescription
Section titled “DefaultDescription”protected virtual string DefaultDescription { get; }Returns
System.String
DefaultMarkupSnippet
Section titled “DefaultMarkupSnippet”protected virtual string DefaultMarkupSnippet { get; }Returns
System.String
DefaultSuggestedPhases
Section titled “DefaultSuggestedPhases”protected virtual TextStudioPhaseMask DefaultSuggestedPhases { get; }Returns
TextStudio.TextStudioPhaseMask
MetadataCategory
Section titled “MetadataCategory”protected string MetadataCategory { get; }Returns
System.String
MetadataDisplayName
Section titled “MetadataDisplayName”protected string MetadataDisplayName { get; }Returns
System.String
MetadataDescription
Section titled “MetadataDescription”protected string MetadataDescription { get; }Returns
System.String
MetadataMarkupSnippet
Section titled “MetadataMarkupSnippet”protected string MetadataMarkupSnippet { get; }Returns
System.String
MetadataSuggestedPhases
Section titled “MetadataSuggestedPhases”protected TextStudioPhaseMask MetadataSuggestedPhases { get; }Returns
TextStudio.TextStudioPhaseMask
Metadata
Section titled “Metadata”public abstract TextStudioEffectMetadata Metadata { get; }Returns
TextStudio.TextStudioEffectMetadata