Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.borntocraftstudio.net/llms.txt

Use this file to discover all available pages before exploring further.

The textdisplay_spoken_cinematic entry is a Cinematic Primary Entry. It displays floating dialogue text synchronized with timeline frames, perfect for cutscenes.

​
Configuration

​
speaker
Ref<SpeakerEntry>
The speaker entity. Text will appear above their head.
​
position
Var<Position>
Optional fixed override position if not using a speaker.
​
segments
List<Segment>
The timeline of text to display.

​
Segment Definition

​
startFrame
Int
required
Frame (tick) when text appears.
​
endFrame
Int
required
Frame (tick) when text disappears.
​
text
String
required
The text content to show.

​
Animation

​
appearanceDelay
Duration
default:"1s"
Delay before typing effect starts after spawn.
​
animationDuration
Duration
default:"2s"
Time taken to fully animate/type the text.
cinematic:
  type: textdisplay_spoken_cinematic
  speaker: "hero_npc"
  segments:
    - startFrame: 0
      endFrame: 60
      text: "Look at that view!"
    - startFrame: 70
      endFrame: 120
      text: "It's breathtaking."