Skip to content

TextStudioExternalEffectDriver

ClassTextStudioTextStudio
public sealed class TextStudioExternalEffectDriver : MonoBehaviour, ITextStudioExternalEffectSource

Exposes one effect definition as externally driven progress and intensity. The component owns no clock or lifecycle, so Animator, Timeline, tweens, gameplay code, and editor scrubbing can drive the same renderer-neutral effect contract.

Submit(in TextStudioExternalEffectSubmissionContext)

Section titled “Submit(in TextStudioExternalEffectSubmissionContext)”
public void Submit(in TextStudioExternalEffectSubmissionContext context)

Submits the driver’s current effect state during an external effect collection pass.

Parameters

Name Type
context TextStudio.TextStudioExternalEffectSubmissionContext

public TextStudioExternalEffectDriver()

public TextStudioEffectDefinitionAsset Effect { get; set; }

Returns

TextStudio.TextStudioEffectDefinitionAsset

public float Progress { get; set; }

Returns

System.Single

public float Intensity { get; set; }

Returns

System.Single

public TextStudioExternalEffectRangeMode RangeMode { get; set; }

Returns

TextStudio.TextStudioExternalEffectRangeMode

public int StartGlyph { get; set; }

Returns

System.Int32

public int EndGlyph { get; set; }

Returns

System.Int32

public bool IsActive { get; }

Whether the source currently has a contribution to submit.

Returns

System.Boolean