Skip to content

Display, Waits & Events

import { Aside } from '@astrojs/starlight/components';


TagDescription
[l]Wait for a click (line wait).
[p]Wait for a click then clear the message window.
[r]Insert a line break.
[s]Halt execution until an event fires (click, timeout, …).
[cm]Clear the current message layer.
[er]Erase all layers.
[ch text=…]Output a single full-width character.
[hch text=…]Output a single half-width character.
TagDescription
[nowait][l] and [p] no longer block for a click.
[endnowait]Restore normal click-wait behaviour.

Pause execution for N milliseconds. If canskip=true (default), the player can click to skip.

[wait time=2000]
[wait time=5000 canskip=false]

Wait up to N ms for a click. Click cancels the timer early.

The following tags wait for the named async operation to finish:

TagWaits for…
[wa]All async operations
[wm]Move/position animation
[wt]Transition
[wq]Quake/shake/flash effect
[wb]BGM fade
[wf]Fadein/fadeout
[wl]Layer fade
[ws]Sound effect
[wv]Voice
[wp]Pause (generic)

All accept optional canskip=true/false and buf=N attributes.

Cancel all in-progress asynchronous operations immediately.


Register a jump (or expression) to execute the next time the player clicks while execution is halted at [s]. Provide at least one of storage=/target=/exp=.

[click target=*resume]
[s]

Same as [click] but fires on mouse-wheel scroll.

Register a jump that fires automatically after N milliseconds while at [s].

[timeout time=3000 target=*auto_continue]
[s]
TagCancels
[cclick]Active [click] handler
[ctimeout]Active [timeout] handler
[cwheel]Active [wheel] handler
[waitclick]Wait until next click, then continue

TagDescription
[skipstart]Enable skip mode — [l]/[p] waits are auto-advanced at high speed.
[skipstop]Disable skip mode.
[cancelskip]Cancel skip mode (alias for [skipstop]).
[clickskip enabled=…]Enable or disable click-to-skip for transitions and animations.

TagDescription
[delay speed=N]Set per-character display delay (ms)
[configdelay speed=N]Set the config-layer display delay
[resetdelay]Reset delay to system default
[nowait]Disable character-by-character delay entirely
[endnowait]Re-enable delay
[autowc time=N]Per-character post-display wait; time= omitted to disable
[resetwait]Reset the auto-wait baseline timer

Manually push a string into the backlog.

AttributeTypeDescription
text=stringThe text to record
join=boolAppend to the previous backlog entry instead of starting a new one

Disable/re-enable automatic backlog recording of DisplayText events.


Open a text-input dialog. The entered value is stored in f[name].

AttributeTypeDescription
name=stringKey in f to write the result into
prompt=stringPlaceholder / hint text
title=stringDialog title

Halt execution until the host fires a named trigger event.