Paper Dialog

Display a customizable dialog

ActionProvided by Dialog Menu

Fields

Field	Type	Default	Description
message	Var<String>	—	Lines of text displayed in the dialog body.PlaceholdersMulti-line
bodyItem	Var<Item>	—	Item showcased in the dialog body (empty for none).
buttons	List<DialogButtonConfig>	empty	—Variants:action_buttonboolean_buttonmultiple_choice_buttonnumber_range_buttontext_input_buttontrigger_button action_button (3) Field Type Default Description label Var<String> — Text displayed on the button.Placeholders command Var<String> — Command executed when the button is clicked.Placeholders asOp Var<Boolean> false Whether to execute the command as OP. boolean_button (8) Field Type Default Description label Var<String> — Label displayed next to the toggle.Placeholders key Var<String> DialogKey.BOOLEAN.key Key used to insert the value in the command. Default: 'boolean'.Placeholders initial Var<Boolean> false — onTrue Var<String> — Value inserted in the command when the toggle is true.Placeholders onFalse Var<String> — Value inserted in the command when the toggle is false.Placeholders command Var<String> — Command template executed when the confirmation button is clicked. Use $(<key>) to insert the value.Placeholders asOp Var<Boolean> false Whether to execute the command as OP. buttonLabel Var<String> OK Label for the confirmation button.Placeholders multiple_choice_button (6) Field Type Default Description label Var<String> — Label displayed above the options.Placeholders key Var<String> DialogKey.CHOICE.key Key used to insert the selected option in the command. Default: 'choice'.Placeholders options Var<String> — Comma separated options. Append * to mark the initial option.Placeholders command Var<String> — Command template executed when the confirmation button is clicked. Use $(<key>) to insert the selected option.Placeholders asOp Var<Boolean> false Whether to execute the command as OP. buttonLabel Var<String> OK Label for the confirmation button.Placeholders number_range_button (9) Field Type Default Description label Var<String> — Label displayed above the slider.Placeholders key Var<String> DialogKey.VALUE.key Key used to insert the value in the command. Default: 'value'.Placeholders start Var<Int> 0 — end Var<Int> 0 — initial Var<Int> MIN_VALUE — step Var<Int> 1 — command Var<String> — Command template executed when the confirmation button is clicked. Use $(<key>) to insert the value.Placeholders asOp Var<Boolean> false Whether to execute the command as OP. buttonLabel Var<String> OK Label for the confirmation button.Placeholders text_input_button (11) Field Type Default Description label Var<String> — Label displayed above the text input.Placeholders key Var<String> DialogKey.INPUT.key Key used to insert the value in the command. Default: 'input'.Placeholders command Var<String> — Command template executed when the confirmation button is clicked. Use $(<key>) to insert the value.Placeholders asOp Var<Boolean> false Whether to execute the command as OP. buttonLabel Var<String> OK Label for the confirmation button.Placeholders width Var<Int> 200 — labelVisible Var<Boolean> true — initial Var<String> — — maxLength Var<Int> 256 — maxLines Var<Int> 0 — height Var<Int> 0 — trigger_button (2) Field Type Default Description label Var<String> — Text displayed on the button.Placeholders triggers List<Ref<TriggerableEntry>> empty Entries triggered when the button is clicked.
exitButton	ExitButtonConfig	—	— ExitButtonConfig (3) Field Type Default Description label Var<String> — Text displayed on the exit button.Placeholders command Var<String> — Command executed when the exit button is clicked.Placeholders asOp Var<Boolean> false Whether to execute the command as OP.
showExitButton	Var<Boolean>	true	Whether to display the exit button.Placeholders
columns	Var<Int>	1	Number of columns to display.Placeholders
dialogType	DialogDisplayType	MULTI_ACTION	Window layout: button grid, yes/no confirmation, or single-button notice.
afterAction	DialogCloseBehaviour	CLOSE	What happens client-side after clicking a button.Values:CLOSENONEWAIT_FOR_RESPONSE

Common TypeWriter fields (criteria, modifiers, triggers, displayName)

Field	Type	Default	Description
criteria	List<Criteria>	empty	—
modifiers	List<Modifier>	empty	—
triggers	List<Ref<TriggerableEntry>>	empty	—
displayName	Var<String>	—	Custom display name for the dialog title.Placeholders

How to use it

Build the whole window in this one entry.

1. Set displayName (title), message (body text, several lines allowed) and optionally bodyItem.
2. Pick dialogType: MULTI_ACTION (grid with columns), CONFIRMATION (first button = yes, exit button = no) or NOTICE (one button).
3. Add buttons in buttons. Choose a type for each: action, trigger, text input, boolean, multiple choice or number range.
4. Configure exitButton. It is shown when showExitButton is on, and always in CONFIRMATION mode. With an empty command, it just closes the dialog.
5. Choose afterAction: CLOSE, NONE (stay open) or WAIT_FOR_RESPONSE.

Commands run as the clicking player (as OP for the duration of the command when asOp is on). In a command, $(key) is replaced by the value of the input with that key. A trigger button fires its triggers for the player, so you can continue a quest sequence from a click without any command.

See the main page for the full table of button types and layouts.