CodeEffectBase
public abstract class CodeEffectBase : ITextStudioBuiltIn, ITextStudioParameterizedEffect, ITextStudioEffect, ITextStudioEffectDefinition, ITextStudioEffectCapabilitiesProviderBase class for stateless code-defined effects. All parameters are fields with sensible defaults. These never reference UnityEngine.Object subclasses so they are safe to construct at static init.
Methods
Section titled “Methods”
Evaluate(ref EvaluatedGlyphState, in EffectEvaluationContext)
Section titled “Evaluate(ref EvaluatedGlyphState, in EffectEvaluationContext)”public abstract void Evaluate(ref EvaluatedGlyphState state, in EffectEvaluationContext context)Evaluate the effect for a single glyph.
Parameters
| Name | Type | Description |
|---|---|---|
state |
TextStudio.EvaluatedGlyphState | Current glyph state (read/write). |
context |
TextStudio.EffectEvaluationContext | Evaluation context with timing, index, and effect area data. |
CreateParameterizedEffect(in TextStudioTagParameters)
Section titled “CreateParameterizedEffect(in TextStudioTagParameters)”public virtual ITextStudioEffect CreateParameterizedEffect(in TextStudioTagParameters parameters)Creates an invocation-specific effect using parsed inline tag parameters.
Parameters
| Name | Type | Description |
|---|---|---|
parameters |
TextStudio.TextStudioTagParameters | Read-only parsed parameters for one effect occurrence. |
Returns
TextStudio.ITextStudioEffect: An isolated effect instance, or the receiver when it is safely immutable.
Constructors
Section titled “Constructors”
CodeEffectBase()
Section titled “CodeEffectBase()”protected CodeEffectBase()Properties
Section titled “Properties”
public abstract string Id { get; }Returns
System.String
Category
Section titled “Category”public virtual string Category { get; }Returns
System.String
DisplayName
Section titled “DisplayName”public virtual string DisplayName { get; }Returns
System.String
Description
Section titled “Description”public virtual string Description { get; }Returns
System.String
DefaultPhases
Section titled “DefaultPhases”public virtual TextStudioPhaseMask DefaultPhases { get; }Returns
TextStudio.TextStudioPhaseMask
DefaultArea
Section titled “DefaultArea”public virtual TextStudioEffectAreaSettings DefaultArea { get; }Returns
TextStudio.TextStudioEffectAreaSettings
BlendMode
Section titled “BlendMode”public virtual EffectBlendMode BlendMode { get; }Returns
TextStudio.EffectBlendMode
Capabilities
Section titled “Capabilities”public virtual TextStudioEffectCapabilities Capabilities { get; }Gets immutable capabilities used by authoring validation and runtime compatibility checks.
Returns
TextStudio.TextStudioEffectCapabilities