Skip to main content
The BetterHud Option Dialogue displays an option dialogue using BetterHud’s popup system for better visual presentation.

​
Configuration

​
text
String
The text to display as the prompt.
​
duration
Int
The duration it takes to type out the message.
​
popupId
String
The ID of the BetterHud popup to display.
​
sound
String
The sound to play when the dialogue starts.
​
options
List<Option>
The options available to the player.

​
Layout Control

​
gridOriginX
Number
Base horizontal position for the option grid in BetterHud.
​
gridOriginY
Number
Base vertical position for the option grid in BetterHud.
​
gridColumnSpacing
Number
Horizontal spacing applied between columns when auto-arranging options.
​
gridRowSpacing
Number
Vertical spacing applied between rows when auto-arranging options.
​
autoLayoutColumns
Int
default:"1"
Number of columns used for automatic option placement. Set to 1 for a vertical list.
​
showAllOptions
Boolean
default:"false"
When enabled, exposes every option immediately, bypassing the typing animation gate.

​
Advanced

​
timer
Int
default:"0"
Timer duration for auto-cancelling the dialogue. Set to 0 to disable.
​
cancelTriggers
List<Ref<TriggerableEntry>>
Triggers to fire when the dialogue is cancelled by timer.
​
customVariables
Map<String, String>
Custom variables to pass to the popup.