Skip to content

WordTimings

ClassTextStudioTextStudio
public class WordTimings : TypingTimingsBase

Word-paced reveal timing settings.

GetRevealDelayAfter(in TextStudioTimingContext)

Section titled “GetRevealDelayAfter(in TextStudioTimingContext)”
public override float GetRevealDelayAfter(in TextStudioTimingContext context)

Calculates the delay after the current unit becomes visible.

Parameters

Name Type Description
context TextStudio.TextStudioTimingContext Transient semantic timing context that must not be retained.

Returns

System.Single: Delay in seconds. Runtime playback clamps negative values to zero.

public WordTimings()

public float NormalWordDelay { get; set; }

Returns

System.Single

public float PunctuationWordDelay { get; set; }

Returns

System.Single

public string PunctuationChars { get; set; }

Returns

System.String

public bool WaitAfterFinalReveal { get; set; }

Returns

System.Boolean

public override bool IncludesFinalRevealDelay { get; }

Whether the final revealed unit contributes its trailing delay before the reveal-complete event is raised. Custom timing assets can override this property when completion should coincide with final visibility.

Returns

System.Boolean