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

Textdisplay Player Option

Player Option dialogue with Text Display(relative position)

Поля

ПолеТипПо умолчаниюОписание
startTriggersList<Ref<TriggerableEntry>>emptyTriggers to fire when this dialogue starts.
endTriggersList<Ref<TriggerableEntry>>emptyTriggers to fire when this dialogue ends.
textVar<String>——ПлейсхолдерыЦветаМногострочное
optionsList<Option>empty—
Option (5)
ПолеТипПо умолчаниюОписание
textVar<String>—Text for this option.Многострочное
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
offsetXVar<Double>0.0Right offset relative to the player (positive = right).
offsetYVar<Double>0.0Up offset relative to the player (positive = up).
offsetZVar<Double>2.0Forward offset relative to the player (positive = forward).
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
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.
Общие поля TypeWriter (criteria, modifiers, triggers, speaker)
ПолеТипПо умолчаниюОписание
criteriaList<Criteria>empty—
modifiersList<Modifier>empty—
triggersList<Ref<TriggerableEntry>>empty—
speakerRef<SpeakerEntry>——

How to use it​

Use this variant when the menu should stay in front of the player rather than at the NPC. The display is recomputed every tick from the player's position and view direction and follows with smoothing.

  • Offsets. offsetX is to the right, offsetY up and offsetZ forward (default 2.0), all relative to the player, measured on the horizontal facing direction.
  • Option position. An option position is read as a relative offset (right, up, forward) from the player, not as a world position. A value of 0,0,0 means "stack it under the text".
  • Choosing and timer. Same controls as the world option dialogue: scroll to highlight, right-click to confirm, optional timer with cancelTriggers.
  • There is no billboard field: the text always faces the player.