Skip to main content
The textdisplay_spoken entry renders a single line of dialogue as a floating 3D entity, usually above an NPC’s head.

Configuration

text
String
required
The dialogue text.
speaker
Ref<SpeakerEntry>
The entity speaking. Determines the location and name tag.
duration
Duration
default:"0s"
Typing animation duration.
position
Var<Position>
Optional override for text position if no speaker is defined.

Styling

scale
Double
default:"1.0"
Text size multiplier.
billboard
Boolean
default:"true"
If true, text always faces the player.
backgroundColor
Color
default:"Black"
Background color of the text box.
textOpacity
Double
default:"1.0"
Opacity of the text (0.0 - 1.0).
viewRange
Double
default:"64.0"
Maximum distance at which the text is visible.

Advanced Colors

speakerBackgroundColor
Color
Color behind the speaker’s name.
textBackgroundColor
Color
Color behind the main text body.
instructionBackgroundColor
Color
Color behind instruction text (e.g. “Space to continue”).
dialogue:
  type: textdisplay_spoken
  text: "Can you hear me?"
  speaker: "guide_npc"
  backgroundColor: "#00000088"