Paper Dialog

Display a customizable dialog

ДействиеПредоставлено: Dialog Menu

Поля

Поле	Тип	По умолчанию	Описание
message	Var<String>	—	Lines of text displayed in the dialog body.ПлейсхолдерыМногострочное
bodyItem	Var<Item>	—	Item showcased in the dialog body (empty for none).
buttons	List<DialogButtonConfig>	empty	—Варианты:action_buttonboolean_buttonmultiple_choice_buttonnumber_range_buttontext_input_buttontrigger_button action_button (3) Поле Тип По умолчанию Описание label Var<String> — Text displayed on the button.Плейсхолдеры command Var<String> — Command executed when the button is clicked.Плейсхолдеры asOp Var<Boolean> false Whether to execute the command as OP. boolean_button (8) Поле Тип По умолчанию Описание label Var<String> — Label displayed next to the toggle.Плейсхолдеры key Var<String> DialogKey.BOOLEAN.key Key used to insert the value in the command. Default: 'boolean'.Плейсхолдеры initial Var<Boolean> false — onTrue Var<String> — Value inserted in the command when the toggle is true.Плейсхолдеры onFalse Var<String> — Value inserted in the command when the toggle is false.Плейсхолдеры command Var<String> — Command template executed when the confirmation button is clicked. Use $(<key>) to insert the value.Плейсхолдеры asOp Var<Boolean> false Whether to execute the command as OP. buttonLabel Var<String> OK Label for the confirmation button.Плейсхолдеры multiple_choice_button (6) Поле Тип По умолчанию Описание label Var<String> — Label displayed above the options.Плейсхолдеры key Var<String> DialogKey.CHOICE.key Key used to insert the selected option in the command. Default: 'choice'.Плейсхолдеры options Var<String> — Comma separated options. Append * to mark the initial option.Плейсхолдеры command Var<String> — Command template executed when the confirmation button is clicked. Use $(<key>) to insert the selected option.Плейсхолдеры asOp Var<Boolean> false Whether to execute the command as OP. buttonLabel Var<String> OK Label for the confirmation button.Плейсхолдеры number_range_button (9) Поле Тип По умолчанию Описание label Var<String> — Label displayed above the slider.Плейсхолдеры key Var<String> DialogKey.VALUE.key Key used to insert the value in the command. Default: 'value'.Плейсхолдеры 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.Плейсхолдеры asOp Var<Boolean> false Whether to execute the command as OP. buttonLabel Var<String> OK Label for the confirmation button.Плейсхолдеры text_input_button (11) Поле Тип По умолчанию Описание label Var<String> — Label displayed above the text input.Плейсхолдеры key Var<String> DialogKey.INPUT.key Key used to insert the value in the command. Default: 'input'.Плейсхолдеры command Var<String> — Command template executed when the confirmation button is clicked. Use $(<key>) to insert the value.Плейсхолдеры asOp Var<Boolean> false Whether to execute the command as OP. buttonLabel Var<String> OK Label for the confirmation button.Плейсхолдеры 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) Поле Тип По умолчанию Описание label Var<String> — Text displayed on the button.Плейсхолдеры triggers List<Ref<TriggerableEntry>> empty Entries triggered when the button is clicked.
exitButton	ExitButtonConfig	—	— ExitButtonConfig (3) Поле Тип По умолчанию Описание label Var<String> — Text displayed on the exit button.Плейсхолдеры command Var<String> — Command executed when the exit button is clicked.Плейсхолдеры asOp Var<Boolean> false Whether to execute the command as OP.
showExitButton	Var<Boolean>	true	Whether to display the exit button.Плейсхолдеры
columns	Var<Int>	1	Number of columns to display.Плейсхолдеры
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.Значения:CLOSENONEWAIT_FOR_RESPONSE

Общие поля TypeWriter (criteria, modifiers, triggers, displayName)

Поле	Тип	По умолчанию	Описание
criteria	List<Criteria>	empty	—
modifiers	List<Modifier>	empty	—
triggers	List<Ref<TriggerableEntry>>	empty	—
displayName	Var<String>	—	Custom display name for the dialog title.Плейсхолдеры

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.