Saltar al contenido principal

Textdisplay Option

Option dialogue with Text Display

Campos

CampoTipoPredeterminadoDescripción
startTriggersList<Ref<TriggerableEntry>>emptyTriggers to fire when this dialogue starts.
endTriggersList<Ref<TriggerableEntry>>emptyTriggers to fire when this dialogue ends.
textVar<String>——PlaceholdersColoresVarias líneas
optionsList<Option>empty—
Option (5)
CampoTipoPredeterminadoDescripción
textVar<String>—Text for this option.Varias líneas
positionVar<Position>ORIGINOptional position override for this option - when set it overrides the dialog's global position for this option. Use the position capture tool in-game.
criteriaList<Criteria>emptyThe criteria that must be met for this option to show.
modifiersList<Modifier>emptyThe modifiers to apply when this option is chosen.
triggersList<Ref<TriggerableEntry>>emptyThe triggers to fire when this option is chosen.
durationVar<Duration>ZEROThe duration it takes to type out the message. If the duration is zero, the message will be displayed instantly.
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
selectedOptionBackgroundColorVar<Color>—Background color for selected option
unselectedOptionBackgroundColorVar<Color>—Background color for unselected options
timerVar<Duration>ZEROTimer duration for auto-cancelling the dialogue. Set to 0 to disable timer.
cancelTriggersList<Ref<TriggerableEntry>>emptyTriggers to fire when the dialogue is cancelled by timer.
Campos comunes de TypeWriter (criteria, modifiers, triggers, speaker)
CampoTipoPredeterminadoDescripción
criteriaList<Criteria>empty—
modifiersList<Modifier>empty—
triggersList<Ref<TriggerableEntry>>empty—
speakerRef<SpeakerEntry>——

How to use it​

Each option has its own text, criteria, modifiers and triggers. Options whose criteria do not match are hidden, and the numbering follows the visible options.

  • Choosing. Scroll the hotbar to move the highlight (it wraps around), then right-click in the air or on the floating text. Confirmation is only possible once the typing and the options have all appeared.
  • Position. The text sits one block above the speaker, or at position. Options are stacked below the text. An option position places that single option at an absolute point and removes it from the stack.
  • Timer. With timer above zero the dialogue is cancelled when it expires and cancelTriggers fire. Show the countdown with %typewriter_textdisplaydialogue_timer% in text or in an option text.
  • Selected option. The index of the highlighted option (starting at 1) is stored in the interaction context for other entries.
  • Colours. selectedOptionBackgroundColor and unselectedOptionBackgroundColor colour the options.