Textdisplay Player Option

Player Option dialogue with Text Display(relative position)

对话由 Text Display Dialogue 提供

字段

字段	类型	默认值	描述
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>	—	—占位符颜色多行
options	List<Option>	empty	— Option（5） 字段 类型 默认值 描述 text Var<String> — Text for this option.多行 position Var<Position> ORIGIN Optional position override for this option - when set it overrides the dialog's global position for this option. Use the position capture tool in-game. criteria List<Criteria> empty The criteria that must be met for this option to show. modifiers List<Modifier> empty The modifiers to apply when this option is chosen. triggers List<Ref<TriggerableEntry>> empty The triggers to fire when this option is chosen.
duration	Var<Duration>	ZERO	The duration it takes to type out the message. If the duration is zero, the message will be displayed instantly.
sound	Var<Sound>	EMPTY	The sound to play when the dialogue starts
offsetX	Var<Double>	0.0	Right offset relative to the player (positive = right).
offsetY	Var<Double>	0.0	Up offset relative to the player (positive = up).
offsetZ	Var<Double>	2.0	Forward offset relative to the player (positive = forward).
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
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
selectedOptionBackgroundColor	Var<Color>	—	Background color for selected option
unselectedOptionBackgroundColor	Var<Color>	—	Background color for unselected options
timer	Var<Duration>	ZERO	Timer duration for auto-cancelling the dialogue. Set to 0 to disable timer.
cancelTriggers	List<Ref<TriggerableEntry>>	empty	Triggers to fire when the dialogue is cancelled by timer.

TypeWriter 通用字段（criteria, modifiers, triggers, speaker）

字段	类型	默认值	描述
criteria	List<Criteria>	empty	—
modifiers	List<Modifier>	empty	—
triggers	List<Ref<TriggerableEntry>>	empty	—
speaker	Ref<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.