Sound, Input, Events, and Interaction

Actions inside the line

Wait, speed, input, event, marker, and sound actions let authored text control pacing without splitting the sentence across scripts. A Play Sound action can use an asset or component, stop on skip, and optionally wait for completion with a timeout.

First beat<wait seconds=.35> waits. <speed x=2>Then the pace changes.</speed>

Open the tag browser for a guided setup when an action has parameters. Required values stay enabled, optional values can be included deliberately, and Select offers compatible routes or identifiers discovered from the current text. Generated Markup is type-checked before Copy or Insert, and browsing never invokes runtime-only callbacks.

Audio sets and players

An Audio Set defines the available clips and marker cues. The Audio Player decides how glyphs, words, punctuation, and markers trigger them. Keep frequent glyph sounds short and varied enough to avoid fatigue.

Audio Sets preview glyph clips and marker cues before they are connected to dialogue.

Built-in action tags

• <wait=0.5> pauses reveal for a cooperative timed wait. Named form: <wait seconds=0.5>.
• <pause> pauses indefinitely until code or a later action resumes reveal.
• <resume> releases an ordinary pause.
• <speed=1.25> sets the reveal multiplier. <speedUp=2> and <speedDown=2> change it relative to the current pacing.
• <waitForInput input=submit timeout=5> waits for a keyed or any-input provider and may time out.
• <event=doorOpen,cellar> raises a named route with optional payload values.
• <playSound> invokes a registered Play Sound asset or component and can optionally wait, time out, and stop on skip.

Actions are point-in-time markers and do not wrap visible text. They run when reveal reaches their compiled position. Self-closing syntax is accepted, but the short non-closing form is common because the action itself has no range.

The searchable tag browser keeps its catalog compact. Select an action that needs parameters, then choose Configure to open the guided setup only when it is useful. The setup validates required values, offers contextual route choices, and shows the exact markup that will be inserted before it changes the source.

Authoring pattern: search by intent, preview the exact action markup, and insert only after the route and parameters are valid. This is especially useful for sound cues, routed events, input waits, and project-specific actions.

Input System waits

The built-in waitForInput action falls back to the legacy any-advance provider. Install Input System 1.4.0 or newer to use InputActionReference mappings. Create named mappings such as submit, cancel, or next, decide whether each action should auto-enable, and use the same key in markup. A timeout greater than zero resumes automatically; zero or less waits until input or a cooperative skip.

Audio Sets and Audio Player

An Audio Set owns reusable glyph clips and named marker cues. The Audio Player decides when to play them, how to choose clips, whether sounds overlap or interrupt, the cooldown, punctuation policy, pitch and volume variation, and the AudioSource pool. Preview assets before placing them in a scene, then test a fast reveal and a full skip so multiple glyphs revealed in one frame do not overwhelm the mix.

Play Sound action assets and components are for authored one-shot cues that may wait for completion. Glyph audio is for the continuing texture of a typewriter. Marker cues are for semantic beats. Use the smallest mechanism that owns the desired timing.

Events, markers, and relays

The Events tab exposes typewriter start, shown, disappeared, glyph-revealed, wait-started, wait-finished, and marker messages. Use TextStudioMarkerEventRouter to map named event routes to UnityEvents and choose whether a binding receives the route, first parameter, or joined payload.

The door opens.<event=doorOpen,cellar> Stay close.<event=music,tense>

Use TextStudioTypewriterEventRelay when designers need inspector-wired callbacks without a custom subscriber. Per-glyph events can fire frequently, so keep expensive work, allocations, and scene searches out of those listeners.

Dialogue Source and long text

TextStudioDialogueSource is the stable bridge for dialogue, quest, subtitle, or cutscene systems. ShowLine stores the line, updates the hub, and optionally restarts reveal. AdvanceOrSkip completes the current wait or reveal before asking the owning system for another line.

TextStudioPageNavigator works with TMP Page overflow and can follow the revealed glyph without changing reveal progress. TextStudioAutoScrollFollower keeps logs, subtitle history, tutorials, and credits visible inside a ScrollRect. Test page changes after localization, font fallback, and narrow layout changes.