Skip to content

chore: improve documentation for the Dialog API #656

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
Strokkur424 merged 5 commits into from
Oct 4, 2025
Merged

chore: improve documentation for the Dialog API #656

Strokkur424 merged 5 commits into from
Oct 4, 2025

Conversation

@novitpw
Copy link
Contributor

@novitpw novitpw commented Sep 24, 2025

This PR improves the documentation for the dialog API example, as several issues were noticed after reading it. The PR includes the following fixes:

  • Using UUID instead of PlayerCommonConnection
  • Using ConcurrentHashMap, since events are triggered in different threads
  • One-minute timeout to prevent the player connection from hanging indefinitely
  • Manually closing the dialog using Audience#closeDialog, as the client sometimes doesn't do this if no button was pressed (e.g., in case of a timeout)
  • All of this includes a bit of adherence to best practices ;)

@github-actions
Copy link

github-actions bot commented Sep 24, 2025 •
edited
Loading

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
papermc-docs ✅ Ready (View Log) Visit Preview acd3ff3

Strokkur424
Strokkur424 requested changes Sep 24, 2025
View reviewed changes
@novitpw novitpw requested a review from Strokkur424 September 24, 2025 20:03
@zlataovce zlataovce linked an issue Sep 24, 2025 that may be closed by this pull request
Dialog API "Requiring the player to agree before allowing them to join" should be updated to include handling if the user leaves the server during configuration #655
Closed
olijeffers0n
olijeffers0n approved these changes Sep 25, 2025
View reviewed changes
Copy link
Member

@olijeffers0n olijeffers0n left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice

MrPowerGamerBR
MrPowerGamerBR approved these changes Sep 26, 2025
View reviewed changes
Copy link

@MrPowerGamerBR MrPowerGamerBR left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only nitpack that I have is that it would be nice to show how you can also clean up the map using the PlayerConnectionCloseEvent event too.

@Strokkur424 Strokkur424 merged commit 48f324f into PaperMC:main Oct 4, 2025
3 checks passed
@Strokkur424
Copy link
Member

Strokkur424 commented Oct 4, 2025

Thank you for the pull request!

@novitpw novitpw deleted the improve-dialogs branch October 28, 2025 11:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@zlataovce zlataovce zlataovce approved these changes

@olijeffers0n olijeffers0n olijeffers0n approved these changes

@Strokkur424 Strokkur424 Strokkur424 approved these changes

@MrPowerGamerBR MrPowerGamerBR Awaiting requested review from MrPowerGamerBR

Assignees

@Strokkur424 Strokkur424

Labels

None yet

Projects

None yet

Milestone

No milestone

5 participants

@novitpw @Strokkur424 @MrPowerGamerBR @zlataovce @olijeffers0n