UI Spoken Cinematic
The only dialogue a cinematic needs. It draws through the very renderer
ui_spoken uses, so a line looks the same whether the scene is played or
walked into, and the house style serves both.
A cinematic already owns the camera and the pacing, so there is nothing to answer and nothing to
time out: there is deliberately no cinematic twin of ui_option. A
scene that must ask something ends and hands over to a dialogue.
Configuration
| Field | What it does |
|---|---|
speaker | Whose name is drawn above the frame. |
segments | The lines, each with the frames it occupies. |
style | The ui_dialogue_style these lines take. |
portrait | Picture drawn beside the speaker's name. |
One segment
| Field | What it does |
|---|---|
startFrame / endFrame | The frames it is on screen for. One frame is 50 ms. |
text | What is said. |
duration | How long the typing takes. Leave empty to type over the whole segment. |
An unset duration is the useful default: the author has already said how long the line is on
screen by dragging it, and asking for that length a second time is a value to keep in step with
every edit.
Silence between two lines
The frame comes down between segments. The cells travel in a channel that persists until something replaces it, so a scene that stops speaking would otherwise keep its last line up through a pause the author wrote on purpose.
Leave a gap between two segments and the screen is genuinely empty for that gap.
Letterbox
A cinematic style usually declares letterboxRows, the black bands above and below. Give the speech
frame room for them: bands of two rows occupy the top and bottom two rows of the grid, and a frame
that reaches into them would be drawn over.
[!NOTE] Nothing is drawn while scrubbing the timeline. The frame is published through a channel the plugin owns, and leaving one behind on a seek would outlive the scrub with no way for the editor to take it down.