Textdisplay Spoken

Spoken dialogue with Text Display

DialogueFourni par Text Display Dialogue

Champs

Champ	Type	Par défaut	Description
startTriggers	List<Ref<TriggerableEntry>>	empty	Triggers to fire when this dialogue starts.
endTriggers	List<Ref<TriggerableEntry>>	empty	Triggers to fire when this dialogue ends.
text	Var<String>	—	—PlaceholdersCouleursMultiligne
duration	Var<Duration>	ZERO	The duration it takes to type out the message.
sound	Var<Sound>	EMPTY	The sound to play when the dialogue starts
position	Var<Position>	ORIGIN	Optional position override - when set it overrides the speaker's position. Use the position capture tool in-game.
scale	Var<Double>	1.0	Scale of the text display
backgroundColor	Var<Color>	BLACK_BACKGROUND	Background color for the text display
textOpacity	Var<Double>	1.0	Text opacity (0.0 to 1.0)
viewRange	Var<Double>	64.0	Maximum view distance for the text display
billboard	Var<Boolean>	true	Whether the text should face the player
showBackground	Var<Boolean>	true	Whether to show a background behind the text
speakerBackgroundColor	Var<Color>	—	Background color for speaker name display
textBackgroundColor	Var<Color>	BLACK_BACKGROUND	Background color for main text display
instructionBackgroundColor	Var<Color>	—	Background color for instruction text display
showInstructionBackground	Var<Boolean>	false	Whether to show background behind instruction text

Champs TypeWriter communs (criteria, modifiers, triggers, speaker)

Champ	Type	Par défaut	Description
criteria	List<Criteria>	empty	—
modifiers	List<Modifier>	empty	—
triggers	List<Ref<TriggerableEntry>>	empty	—
speaker	Ref<SpeakerEntry>	—	—

How to use it

The text is split into one floating line per line break, so use the multi-line field for longer messages. MiniMessage tags and %placeholders% work in text.

• Position. Without position, the text floats one block above the speaker entity. With position set, it uses that exact point.
• Typing. duration is the typing time. Zero shows the whole text at once.
• Closing. The first press of the confirmation key (or right-click on the text) completes the typing, the second closes the dialogue. A "Click to continue" hint appears under the text once it is complete.
• Start and end. startTriggers fire when the dialogue appears, endTriggers when it ends normally.
• Backgrounds. showBackground and backgroundColor colour the text and speaker name; showInstructionBackground adds a background to the hint line. speakerBackgroundColor, textBackgroundColor and instructionBackgroundColor exist in the entry but the dialogue reads backgroundColor for the speaker name and the text.