TextStudioEffectAsset<TState, TParams>
public abstract class TextStudioEffectAsset<TState, TParams> : TextStudioEffectAsset, ITextStudioEffectCapabilitiesProvider, ITextStudioEffect, ITextStudioEffectDefinition where TState : struct where TParams : structGeneric ScriptableObject wrapper for effects. Provides type-safe effect creation with minimal boilerplate.
Methods
Section titled “Methods”
Evaluate(ref EvaluatedGlyphState, in EffectEvaluationContext)
Section titled “Evaluate(ref EvaluatedGlyphState, in EffectEvaluationContext)”public override 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. |
CreateDefaultParams(AnimationPhase)
Section titled “CreateDefaultParams(AnimationPhase)”protected virtual TParams CreateDefaultParams(AnimationPhase phase)Creates authoring defaults for a newly enabled effect phase.
Parameters
| Name | Type |
|---|---|
phase |
TextStudio.AnimationPhase |
Returns
{TParams}
CreateDefaultState()
Section titled “CreateDefaultState()”protected virtual TState CreateDefaultState()Creates isolated mutable state for one glyph when the effect requires it.
Returns
{TState}
EvaluateEffect(ref EvaluatedGlyphState, ref TState, in TParams, in EffectEvaluationContext, EffectBlendMode)
Section titled “EvaluateEffect(ref EvaluatedGlyphState, ref TState, in TParams, in EffectEvaluationContext, EffectBlendMode)”protected abstract void EvaluateEffect(ref EvaluatedGlyphState glyphState, ref TState effectState, in TParams parameters, in EffectEvaluationContext context, EffectBlendMode blendMode)Evaluates one glyph using resolved phase parameters and mutable per-glyph state.
Parameters
| Name | Type |
|---|---|
glyphState |
TextStudio.EvaluatedGlyphState |
effectState |
{TState} |
parameters |
{TParams} |
context |
TextStudio.EffectEvaluationContext |
blendMode |
TextStudio.EffectBlendMode |
Constructors
Section titled “Constructors”
TextStudioEffectAsset()
Section titled “TextStudioEffectAsset()”protected TextStudioEffectAsset()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
RevealParams
Section titled “RevealParams”public TParams RevealParams { get; }Returns
{TParams}
ActiveParams
Section titled “ActiveParams”public TParams ActiveParams { get; }Returns
{TParams}
HideParams
Section titled “HideParams”public TParams HideParams { get; }Returns
{TParams}
Reveal
Section titled “Reveal”public TextStudioEffectPhaseBlock Reveal { get; }Returns
TextStudio.TextStudioEffectPhaseBlock
Active
Section titled “Active”public TextStudioEffectPhaseBlock Active { get; }Returns
TextStudio.TextStudioEffectPhaseBlock
public TextStudioEffectPhaseBlock Hide { get; }Returns
TextStudio.TextStudioEffectPhaseBlock
DefaultId
Section titled “DefaultId”protected virtual string DefaultId { get; }Returns
System.String