feat: Document custom argument suggestions #536
+201
−0
Conversation
This file contains 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
|
|
/mergeable |
Strokkur424
force-pushed
the
argument-suggestions
branch
from
61c7327 to
5277a45
Compare
Machine-Maker
approved these changes
Jan 30, 2025
olijeffers0n
requested changes
Jan 30, 2025
|
I mean, I didn't even mention this specific page in the WIP section. But I did add it now. Anything else? |
|
|
||
| This example obviously does not suggest anything, as we haven't added any suggestions yet. | ||
|
|
||
| ## The `SuggestionBuilder` |
There was a problem hiding this comment.
Small typo SuggestionsBuilder
| | getRemainingLowerCase() | asumm13text | The input for the current argument, lowercased | | ||
|
|
||
| ### Suggestions | ||
| The following overloads of the `SuggestionBuilder#suggest` method add values that will be send to the client as argument suggestions: |
|
|
||
| // Retrieve our argument values | ||
| final ItemStack item = ctx.getArgument("item", ItemStack.class); | ||
| final int amount = IntegerArgumentType.getInteger(ctx, "stacksize"); |
There was a problem hiding this comment.
amount is better for the argument name i think
|
|
||
| // Set the item's amount and give it to the player | ||
| item.setAmount(amount); | ||
| player.getInventory().setItem(player.getInventory().firstEmpty(), item); |
There was a problem hiding this comment.
This could be better using the new Player#give method to handle stack size properly. But if you think it's too complicated the first empty slot could be saved in a separate var.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #527.
Extending onto the Brigadier documentation, here I have documented the
suggestsmethod of aRequiredArgumentBuilder.