Перейти к основному содержимому

Textdisplay Spoken

Spoken dialogue with Text Display

Поля

ПолеТипПо умолчаниюОписание
startTriggersList<Ref<TriggerableEntry>>emptyTriggers to fire when this dialogue starts.
endTriggersList<Ref<TriggerableEntry>>emptyTriggers to fire when this dialogue ends.
textVar<String>——ПлейсхолдерыЦветаМногострочное
durationVar<Duration>ZEROThe duration it takes to type out the message.
soundVar<Sound>EMPTYThe sound to play when the dialogue starts
positionVar<Position>ORIGINOptional position override - when set it overrides the speaker's position. Use the position capture tool in-game.
scaleVar<Double>1.0Scale of the text display
backgroundColorVar<Color>BLACK_BACKGROUNDBackground color for the text display
textOpacityVar<Double>1.0Text opacity (0.0 to 1.0)
viewRangeVar<Double>64.0Maximum view distance for the text display
billboardVar<Boolean>trueWhether the text should face the player
showBackgroundVar<Boolean>trueWhether to show a background behind the text
speakerBackgroundColorVar<Color>—Background color for speaker name display
textBackgroundColorVar<Color>BLACK_BACKGROUNDBackground color for main text display
instructionBackgroundColorVar<Color>—Background color for instruction text display
showInstructionBackgroundVar<Boolean>falseWhether to show background behind instruction text
Общие поля TypeWriter (criteria, modifiers, triggers, speaker)
ПолеТипПо умолчаниюОписание
criteriaList<Criteria>empty—
modifiersList<Modifier>empty—
triggersList<Ref<TriggerableEntry>>empty—
speakerRef<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.