Docsv3.5.9
Back to API Reference
Class

UniTextDriver

sealed
Inherits:MonoBehaviour

Sequences parameter animation over the sibling text component: each clip owns one modifier parameter across the ranges its query matches and ramps every member between two endpoint values inside its own window on the shared timeline. Clips run in order, overlap freely, and may drive different parameters of different modifiers.

Remarks

The playhead advances on the chosen clock and is fully scrubbable: set Progress from code, an Animator, or a Timeline to render any exact state. Ownership follows each clip's query across text edits and releases on disable, returning every range to its cascade. Scrubbing and playback work in edit mode; automatic playback on enable starts only in play mode.
public float Duration{ get; set }
public float Speed{ get; set }

Playhead speed multiplier; negative values run backwards.

public bool IsPlaying{ get }

Whether the playhead is advancing.

public float Playhead{ get; set }

Position on the timeline in seconds: where the sequence evaluates, so a PingPong or Yoyo return reads as the mirrored position and never as a phase past the end. Setting it seeks that many seconds into the run, counted from its first pass, and renders that state; Progress is the same position normalized.

public float Progress{ get; set }

Normalized playhead over the timeline, 0..1. Setting it renders that exact state — scrubbing, rewinding and external timelines all work.

public float TimelineLength{ get }

Seconds the full timeline lasts: the latest clip end for the current members, or the authored fixed length when that is longer.

public void Play()

Starts or resumes playback; a finished finite run restarts at its beginning for positive speed or its end for negative speed.

public void Pause()

Pauses playback, keeping the current state.

public void Stop()

Stops playback and returns the playhead to the beginning.

public void Seek()

Moves the playhead to a normalized 0..1 position of the first pass and renders that state.

public void Advance()

Advances the playhead by explicit seconds — the tick source for the Manual clock.

public void Rebind()

Releases and rebuilds every clip's ownership against the current styles. Before the text component has initialized its style graph this is a deferred no-op; the graph's build signal re-enters it.

Back to API Reference