メインコンテンツまでスキップ

Paper Dialog

Display a customizable dialog

フィールド

フィールド型デフォルト説明
messageVar<String>—Lines of text displayed in the dialog body.プレースホルダー複数行
bodyItemVar<Item>—Item showcased in the dialog body (empty for none).
buttonsList<DialogButtonConfig>empty—バリアント:action_buttonboolean_buttonmultiple_choice_buttonnumber_range_buttontext_input_buttontrigger_button
action_button(3)
フィールド型デフォルト説明
labelVar<String>—Text displayed on the button.プレースホルダー
commandVar<String>—Command executed when the button is clicked.プレースホルダー
asOpVar<Boolean>falseWhether to execute the command as OP.
boolean_button(8)
フィールド型デフォルト説明
labelVar<String>—Label displayed next to the toggle.プレースホルダー
keyVar<String>DialogKey.BOOLEAN.keyKey used to insert the value in the command. Default: 'boolean'.プレースホルダー
initialVar<Boolean>false—
onTrueVar<String>—Value inserted in the command when the toggle is true.プレースホルダー
onFalseVar<String>—Value inserted in the command when the toggle is false.プレースホルダー
commandVar<String>—Command template executed when the confirmation button is clicked. Use $(<key>) to insert the value.プレースホルダー
asOpVar<Boolean>falseWhether to execute the command as OP.
buttonLabelVar<String>OKLabel for the confirmation button.プレースホルダー
multiple_choice_button(6)
フィールド型デフォルト説明
labelVar<String>—Label displayed above the options.プレースホルダー
keyVar<String>DialogKey.CHOICE.keyKey used to insert the selected option in the command. Default: 'choice'.プレースホルダー
optionsVar<String>—Comma separated options. Append * to mark the initial option.プレースホルダー
commandVar<String>—Command template executed when the confirmation button is clicked. Use $(<key>) to insert the selected option.プレースホルダー
asOpVar<Boolean>falseWhether to execute the command as OP.
buttonLabelVar<String>OKLabel for the confirmation button.プレースホルダー
number_range_button(9)
フィールド型デフォルト説明
labelVar<String>—Label displayed above the slider.プレースホルダー
keyVar<String>DialogKey.VALUE.keyKey used to insert the value in the command. Default: 'value'.プレースホルダー
startVar<Int>0—
endVar<Int>0—
initialVar<Int>MIN_VALUE—
stepVar<Int>1—
commandVar<String>—Command template executed when the confirmation button is clicked. Use $(<key>) to insert the value.プレースホルダー
asOpVar<Boolean>falseWhether to execute the command as OP.
buttonLabelVar<String>OKLabel for the confirmation button.プレースホルダー
text_input_button(11)
フィールド型デフォルト説明
labelVar<String>—Label displayed above the text input.プレースホルダー
keyVar<String>DialogKey.INPUT.keyKey used to insert the value in the command. Default: 'input'.プレースホルダー
commandVar<String>—Command template executed when the confirmation button is clicked. Use $(<key>) to insert the value.プレースホルダー
asOpVar<Boolean>falseWhether to execute the command as OP.
buttonLabelVar<String>OKLabel for the confirmation button.プレースホルダー
widthVar<Int>200—
labelVisibleVar<Boolean>true—
initialVar<String>——
maxLengthVar<Int>256—
maxLinesVar<Int>0—
heightVar<Int>0—
trigger_button(2)
フィールド型デフォルト説明
labelVar<String>—Text displayed on the button.プレースホルダー
triggersList<Ref<TriggerableEntry>>emptyEntries triggered when the button is clicked.
exitButtonExitButtonConfig——
ExitButtonConfig(3)
フィールド型デフォルト説明
labelVar<String>—Text displayed on the exit button.プレースホルダー
commandVar<String>—Command executed when the exit button is clicked.プレースホルダー
asOpVar<Boolean>falseWhether to execute the command as OP.
showExitButtonVar<Boolean>trueWhether to display the exit button.プレースホルダー
columnsVar<Int>1Number of columns to display.プレースホルダー
dialogTypeDialogDisplayTypeMULTI_ACTIONWindow layout: button grid, yes/no confirmation, or single-button notice.
afterActionDialogCloseBehaviourCLOSEWhat happens client-side after clicking a button.値:CLOSENONEWAIT_FOR_RESPONSE
TypeWriter 共通フィールド(criteria, modifiers, triggers, displayName)
フィールド型デフォルト説明
criteriaList<Criteria>empty—
modifiersList<Modifier>empty—
triggersList<Ref<TriggerableEntry>>empty—
displayNameVar<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.