Skip to content

feat: Dialog API documentation #621

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.

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

Strokkur424
Copy link
Contributor

No description provided.

Copy link

github-actions bot commented Jul 10, 2025

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

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

The type primarily influences the bottom part of the dialog.

## Registering dialogs in the registry
If you want dialogs to be registered in the dialogs registry, you have register them inside a registry modification lifecycle
Copy link

Choose a reason for hiding this comment

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

Should we add a remark reminding about needing to do this for the dialogList type?

Copy link

@mbax mbax Jul 12, 2025

Choose a reason for hiding this comment

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

Also, "you have to register" but maybe instead "you must register"

Copy link
Member

Choose a reason for hiding this comment

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

You don't have to do it for the dialog list type. You can use a RegistryValueSet and just have a list of directly created ones.

```

### Reading the input
To retrieve the values the user put into the dialog, we once again have to listen to a `PlayerCustomClickEvent`.
Copy link

Choose a reason for hiding this comment

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

What about custom click action with the callback built in, instead of listening to the event?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants