ITextStudioPlayback

InterfaceTextStudioTextStudio

public interface ITextStudioPlayback

Focused reveal and hide playback contract shared by every Text Studio host.

Methods

ShowText(string)

void ShowText(string markup)

Replaces the content and begins reveal playback using the current settings.

Parameters

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

ShowTextInstant(string)

void ShowTextInstant(string markup)

Replaces the content and displays it completely without advancing a reveal clock.

Parameters

Name	Type	Description
markup	System.String	Markup to compile and display.

StartReveal()

void StartReveal()

Starts reveal playback for the current compiled content.

PauseReveal()

void PauseReveal()

Pauses reveal playback while retaining its current position.

ResumeReveal()

void ResumeReveal()

Resumes reveal playback from its paused position.

SkipCurrentWait()

void SkipCurrentWait()

Requests cooperative cancellation of the active wait and resumes reveal. Custom non-skippable action coroutines may continue running.

SkipReveal()

void SkipReveal()

Completes reveal immediately, including remaining reveal events.

StopReveal()

void StopReveal()

Stops reveal at its current visibility without completing it.

StartDisappear()

void StartDisappear()

Starts hide playback for the current content.

SkipDisappear()

void SkipDisappear()

Completes hide playback immediately.

SetRevealProgress(float)

void SetRevealProgress(float progress)

Sets reveal to an explicit normalized position without changing authored content.

Parameters

Name	Type	Description
progress	System.Single	Requested progress, clamped to the 0 to 1 range.

SetRevealSpeed(float)

void SetRevealSpeed(float multiplier)

Changes the playback-rate multiplier used by subsequent reveal updates.

Parameters

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

AdvanceOrSkip()

bool AdvanceOrSkip()

Advances a paused or waiting reveal when possible; otherwise completes the active reveal.

Returns

System.Boolean: true when the call changed playback state.

Properties

RevealProgress

float RevealProgress { get; }

Gets normalized reveal progress from 0 (hidden) to 1 (fully revealed).

Returns

System.Single

RevealedGlyphCount

int RevealedGlyphCount { get; }

Gets the number of semantic glyphs currently revealed.

Returns

System.Int32

TotalGlyphCount

int TotalGlyphCount { get; }

Gets the number of visible semantic glyphs in the compiled content.

Returns

System.Int32

IsRevealing

bool IsRevealing { get; }

Gets whether reveal playback is currently advancing.

Returns

System.Boolean

IsRevealPaused

bool IsRevealPaused { get; }

Gets whether reveal playback is paused without being stopped.

Returns

System.Boolean

IsWaitingForAction

bool IsWaitingForAction { get; }

Gets whether reveal is suspended while an action coroutine is active.

Returns

System.Boolean

IsDisappearing

bool IsDisappearing { get; }

Gets whether hide playback is currently advancing.

Returns

System.Boolean

Events

OnShowComplete

event Action OnShowComplete

Occurs after the final reveal delay has completed and the text is fully shown.

Returns

System.Action

OnDisappearComplete

event Action OnDisappearComplete

Occurs after hide playback has made the complete text invisible.

Returns

System.Action

OnTypewriterStarted

event Action OnTypewriterStarted

Occurs when reveal playback starts or restarts.

Returns

System.Action