TextStudioDialogueSource

ClassTextStudioTextStudio

[AddComponentMenu("Text Studio/Integration/Dialogue Source")]
[HelpURL("https://www.wetzold.com/tools/text-studio")]
public sealed class TextStudioDialogueSource : MonoBehaviour, ITextStudioExternalTextSource

Generic bridge for narrative, dialogue, subtitle, and speech-bubble systems. Third-party tools can call this component without taking a package dependency on their APIs; Text Studio remains responsible for reveal, tags, effects, and renderer output.

Methods

RegisterMarkupPreprocessor(ITextStudioMarkupPreprocessor)

public void RegisterMarkupPreprocessor(ITextStudioMarkupPreprocessor preprocessor)

Registers a dialogue-local markup transform in invocation order.

Parameters

Name	Type
`preprocessor`	TextStudio.ITextStudioMarkupPreprocessor

UnregisterMarkupPreprocessor(ITextStudioMarkupPreprocessor)

public bool UnregisterMarkupPreprocessor(ITextStudioMarkupPreprocessor preprocessor)

Stops applying a previously registered dialogue-local markup transform.

Parameters

Name	Type
`preprocessor`	TextStudio.ITextStudioMarkupPreprocessor

Returns

System.Boolean: true when the processor was registered.

ShowLine(string)

public void ShowLine(string markup)

Replaces the current line, preprocesses it, and starts reveal playback.

Parameters

Name	Type
`markup`	System.String

SetLine(string, bool)

public void SetLine(string markup, bool restartReveal)

Replaces and preprocesses the current line with explicit reveal-restart policy.

Parameters

Name	Type
`markup`	System.String
`restartReveal`	System.Boolean

AppendToLine(string)

public void AppendToLine(string markup)

Preprocesses and appends markup while preserving the existing prefix’s reveal state.

Parameters

Name	Type
`markup`	System.String

ClearLine()

public void ClearLine()

Clears source, processed line, and target output.

AdvanceOrSkip()

public bool AdvanceOrSkip()

Production dialogue “continue” behavior: first call completes the current reveal/wait, second call asks the owning dialogue system for the next line. Returns true only when the caller should advance externally.

Returns

System.Boolean

Constructors