ITypewriterProvider

InterfaceTextStudioTextStudio

public interface ITypewriterProvider

Compatibility contract for components that drive reveal and hide sequences through a typewriter-style API.

Methods

ShowText(string)

void ShowText(string text)

Replaces the current content and begins reveal playback.

Parameters

Name	Type	Description
text	System.String	Markup to compile and reveal.

SkipTypewriter()

void SkipTypewriter()

Completes reveal immediately and dispatches remaining reveal events.

StartShowing()

void StartShowing()

Starts reveal playback for the current content.

StopShowing()

void StopShowing()

Stops reveal at its current visibility.

SetTypewriterSpeed(float)

void SetTypewriterSpeed(float multiplier)

Changes reveal timing without modifying authored timing assets.

Parameters

Name	Type	Description
multiplier	System.Single	Non-negative multiplier, where 1 uses authored timing.

TriggerRemainingEvents()

void TriggerRemainingEvents()

Dispatches pending marker and cue events without advancing the reveal animation.

GetApproximateShowDuration()

float GetApproximateShowDuration()

Estimates reveal duration using the current content and timing configuration.

Returns

System.Single: Approximate duration in seconds, including configured waits that have known durations.

StartDisappear()

void StartDisappear()

Starts hide playback for the current content.

SkipDisappear()

void SkipDisappear()

Completes hide playback immediately.

StopDisappear()

void StopDisappear()

Stops hide playback at its current visibility.

GetApproximateHideDuration()

float GetApproximateHideDuration()

Estimates hide duration using the current content and timing configuration.

Returns

System.Single: Approximate duration in seconds.

Properties

IsShowingText

bool IsShowingText { get; }

Gets whether reveal playback is currently active.

Returns

System.Boolean

IsDisappearing

bool IsDisappearing { get; }

Gets whether hide playback is currently active.

Returns

System.Boolean

Events

OnTypewriterStarted

event Action OnTypewriterStarted

Occurs when reveal playback starts or restarts.

Returns

System.Action

OnShowComplete

event Action OnShowComplete

Occurs after reveal and its final configured delay complete.

Returns

System.Action

OnDisappearComplete

event Action OnDisappearComplete

Occurs after hide playback makes the complete text invisible.

Returns

System.Action