feat(paper): add dialog documentation about tags and nbt payloads #702
+95
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
built with Refined Cloudflare Pages Action⚡ Cloudflare Pages Deployment
|
zlataovce
approved these changes
Dec 25, 2025
Member
zlataovce
left a comment
zlataovce
left a comment
There was a problem hiding this comment.
looks good apart from a couple of nitpicks
|
|
||
| #### Creating payloads with `adventure-nbt`. | ||
|
|
||
| The `BinaryTagHolder.binaryTagHolder` factory method requires an SNBT formatted string. We can either construct this string manually, or use |
Member
There was a problem hiding this comment.
Suggested change
| The `BinaryTagHolder.binaryTagHolder` factory method requires an SNBT formatted string. We can either construct this string manually, or use | |
| The `BinaryTagHolder.binaryTagHolder` factory method requires an SNBT-formatted string. We can either construct this string manually, or use |
| This NBT data will be sent to the client when the dialog is shown, and when the player clicks the button, a | ||
| [`PlayerCustomClickEvent`](jd:paper:io.papermc.paper.event.player.PlayerCustomClickEvent) will be fired containing the same NBT data among other information. | ||
|
|
||
| #### Creating payloads with `adventure-nbt`. |
Member
There was a problem hiding this comment.
Suggested change
| #### Creating payloads with `adventure-nbt`. | |
| #### Creating payloads with `adventure-nbt` |
|
|
||
| To read the NBT payload, we can use the [`PlayerCustomClickEvent#getTag()`](jd:paper:io.papermc.paper.event.player.PlayerCustomClickEvent#getTag()) method. | ||
|
|
||
| #### Reading payloads with adventure-nbt. |
Member
There was a problem hiding this comment.
consistency
Suggested change
| #### Reading payloads with adventure-nbt. | |
| #### Reading payloads with `adventure-nbt` |
Comment on lines
+481
to
+486
| ActionButton.create( | ||
| Component.text("Confirm", TextColor.color(0xAEFFC1)), | ||
| Component.text("Click to confirm your input."), | ||
| 100, | ||
| DialogAction.customClick(Key.key("papermc:user_input/confirm"), null) | ||
| ), |
Member
There was a problem hiding this comment.
would probably dedent this
Suggested change
| ActionButton.create( | |
| Component.text("Confirm", TextColor.color(0xAEFFC1)), | |
| Component.text("Click to confirm your input."), | |
| 100, | |
| DialogAction.customClick(Key.key("papermc:user_input/confirm"), null) | |
| ), | |
| ActionButton.create( | |
| Component.text("Confirm", TextColor.color(0xAEFFC1)), | |
| Component.text("Click to confirm your input."), | |
| 100, | |
| DialogAction.customClick(Key.key("papermc:user_input/confirm"), null) | |
| ) |
| } | ||
| ``` | ||
|
|
||
| ### Registering Pause Screen Additions and Quick Actions tags |
Member
There was a problem hiding this comment.
Suggested change
| ### Registering Pause Screen Additions and Quick Actions tags | |
| ### Pause Screen Additions and Quick Actions |
| ``` | ||
|
|
||
| ### Registering Pause Screen Additions and Quick Actions tags | ||
| Dialog when registered in the registry can be tagged with these special tags: |
Member
There was a problem hiding this comment.
Suggested change
| Dialog when registered in the registry can be tagged with these special tags: | |
| Dialogs can be tagged with these special tags when registered: |
zlataovce
added
dev guide
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request adds new documentation explaining how to use dialog tags for pause screen and quick actions integration, and introduces a new section on using NBT payloads with dialogs in the API. The changes provide detailed code examples and best practices for both registering dialogs with special tags and handling custom NBT data using the
adventure-nbtlibrary.Dialog Tag Registration Enhancements:
PAUSE_SCREEN_ADDITIONSandQUICK_ACTIONSto integrate custom dialogs into the game's pause screen and quick actions menu, including a full code example for registering these tags in a plugin bootstrapper.NBT Payload Support for Dialogs:
PlayerCustomClickEvent.adventure-nbtlibrary, including exception handling and dependency notes.BinaryTagHoldertoCompoundBinaryTagand handling potential nulls and IO exceptions.