ITextStudioWaitLifecycleSink

InterfaceTextStudioTextStudio

public interface ITextStudioWaitLifecycleSink

Receives lifecycle notifications for waits that suspend reveal or hide playback. Implementations must not retain the supplied marker beyond the notification.

Methods

NotifyTypewriterWaitStarted(ActionMarker, TextStudioTypewriterWaitKind, float, bool)

void NotifyTypewriterWaitStarted(ActionMarker marker, TextStudioTypewriterWaitKind kind, float duration, bool isHide)

Notifies the sink immediately before a wait suspends playback.

Parameters

Name	Type	Description
marker	TextStudio.ActionMarker	Marker that initiated the wait.
kind	TextStudio.TextStudioTypewriterWaitKind	Kind of wait being started.
duration	System.Single	Known duration in seconds, or a negative value for an externally completed wait.
isHide	System.Boolean	Whether the wait belongs to hide playback.

NotifyTypewriterWaitFinished(ActionMarker, TextStudioTypewriterWaitKind, float, bool)

void NotifyTypewriterWaitFinished(ActionMarker marker, TextStudioTypewriterWaitKind kind, float duration, bool isHide)

Notifies the sink after a wait completes or is skipped.

Parameters

Name	Type	Description
marker	TextStudio.ActionMarker	Marker that initiated the wait.
kind	TextStudio.TextStudioTypewriterWaitKind	Kind of wait that finished.
duration	System.Single	Configured duration in seconds, or a negative value for an externally completed wait.
isHide	System.Boolean	Whether the wait belonged to hide playback.