CodeEffectBase
public abstract class CodeEffectBase : ITextStudioEffect, ITextStudioBuiltIn, ITextStudioEffectFactory, ITextStudioEffectDefinition, ITextStudioEffectMetadataProvider, 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”
CreateMetadata()
Section titled “CreateMetadata()”protected virtual TextStudioEffectMetadata CreateMetadata()Creates cached authoring metadata for this code-defined effect.
Returns
TextStudio.TextStudioEffectMetadata
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. |
CreateEffect(in TextStudioTagParameters)
Section titled “CreateEffect(in TextStudioTagParameters)”public virtual 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.
ApplyCustomParameters(in TextStudioTagParameters)
Section titled “ApplyCustomParameters(in TextStudioTagParameters)”protected virtual void ApplyCustomParameters(in TextStudioTagParameters parameters)Allows an add-on effect family to bind parameters without base-assembly type knowledge.
Parameters
| Name | Type |
|---|---|
parameters |
TextStudio.TextStudioTagParameters |
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
PlaybackRole
Section titled “PlaybackRole”public virtual TextStudioEffectPlaybackRole PlaybackRole { get; }Returns
TextStudio.TextStudioEffectPlaybackRole
DefaultPlayback
Section titled “DefaultPlayback”public virtual TextStudioEffectPlaybackPreset DefaultPlayback { get; }Returns
TextStudio.TextStudioEffectPlaybackPreset
DefaultCurve
Section titled “DefaultCurve”public virtual TextStudioEffectCurvePreset DefaultCurve { get; }Returns
TextStudio.TextStudioEffectCurvePreset
DefaultPlaybackDuration
Section titled “DefaultPlaybackDuration”public virtual float DefaultPlaybackDuration { get; }Returns
System.Single
DefaultDelayBetweenCycles
Section titled “DefaultDelayBetweenCycles”public virtual float DefaultDelayBetweenCycles { get; }Returns
System.Single
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
Metadata
Section titled “Metadata”public TextStudioEffectMetadata Metadata { get; }Returns
TextStudio.TextStudioEffectMetadata