ITextStudioController
public interface ITextStudioControllerRestricted playback controller exposed to custom actions while they execute.
Methods
Section titled “Methods”
SetRevealSpeed(float)
Section titled “SetRevealSpeed(float)”void SetRevealSpeed(float multiplier)Changes the reveal-rate multiplier for subsequent updates.
Parameters
| Name | Type | Description |
|---|---|---|
multiplier |
System.Single | Non-negative multiplier, where 1 uses authored timing. |
PauseReveal()
Section titled “PauseReveal()”void PauseReveal()Pauses reveal while preserving its current position.
ResumeReveal()
Section titled “ResumeReveal()”void ResumeReveal()Resumes reveal from its paused position.
SkipCurrentWait()
Section titled “SkipCurrentWait()”void SkipCurrentWait()Requests cooperative cancellation of the active wait and resumes reveal.
Properties
Section titled “Properties”
RevealProgress
Section titled “RevealProgress”float RevealProgress { get; }Gets normalized reveal progress from 0 to 1.
Returns
System.Single
RevealedGlyphCount
Section titled “RevealedGlyphCount”int RevealedGlyphCount { get; }Gets the number of semantic glyphs currently revealed.
Returns
System.Int32
TotalGlyphCount
Section titled “TotalGlyphCount”int TotalGlyphCount { get; }Gets the number of visible semantic glyphs in the current plan.
Returns
System.Int32
IsRevealing
Section titled “IsRevealing”bool IsRevealing { get; }Gets whether reveal playback is currently advancing.
Returns
System.Boolean
IsRevealPaused
Section titled “IsRevealPaused”bool IsRevealPaused { get; }Gets whether reveal playback is paused.
Returns
System.Boolean
CoroutineHost
Section titled “CoroutineHost”MonoBehaviour CoroutineHost { get; }Gets the component that owns action coroutines.
Returns
UnityEngine.MonoBehaviour
Events
Section titled “Events”
OnMarkerReached
Section titled “OnMarkerReached”event Action<string, string[]> OnMarkerReachedOccurs when playback reaches an authored marker.
Returns
System.Action{System.String,System.String[]}