Incendo
Support suggestion tooltips
Brigadier's SuggestionsBuilder#suggest(String, Message) can be used to insert a tooltip on the suggestion:
https://github.com/Mojang/brigadier/blob/872658c7372b47a2938f7a836cd33deebf8feb9a/src/main/java/com/mojang/brigadier/suggestion/SuggestionsBuilder.java#L53
Ideally, Cloud should be able to support these on supported platforms.
The goal is this feature:
More platforms than Brigadier support suggestions with context, so there should be an option to produce such suggestions.
Ideally there'd still be string suggestions that are used by default, and some suggestion class containing context, such as the tooltip, etc.
This has to wait until 2.0.0 though, as there's no way of implementing this in a clean way without breaking existing contracts.
This would be really nice for showing short descriptions of command literals, too. Couldn't this be done using ParserParameter, similar to how it's done for the description? An annotation could be added to match it.
What's the reason it cannot be implemented in a 'clean' way yet?
Suggestions tooltips are provided for each suggestion, which means they'd have to be provided by the suggestion providers. This is not possible without changing the contract for the suggestion methods, which means we cannot do it until the next major version bump (which is v2)
What's the status on this? Development of 2.0.0 currently doesn't really seem to go anywhere.
it's still planned - maybe possible for 1.x if someone takes the time to evolve the api in a compatible way while implementing this
well, if someone wants this, you can go to https://github.com/Incendo/cloud/pull/418
https://github.com/Incendo/cloud/pull/495 is a proof of concept of tooltip support in Cloud v2. It works, but has a less than ideal API. It does show how to integrate the tooltips with both Paper and generic Brigadier.
We've discussed this internally and for the actual implementation we want to introduce another generic parameter to CommandManager for the platform suggestion type, which extends Suggestion. The method returning suggestions in CommandManager should be be altered to return the platform suggestion type instead. This allows us to both support tooltips for Brigadier-native platforms, but also other exotic suggestion types (Discord?) in the future.
We will require each platform to support Suggestion by forcing them to provide a function (Suggestion) -> Platform Suggestion Type.