Skip to content

feat: add CommandDescription#530

Merged
Citymonstret merged 2 commits into2.0.0-devfrom
feature/2.0.0/command-descriptions
Nov 28, 2023
Merged

feat: add CommandDescription#530
Citymonstret merged 2 commits into2.0.0-devfrom
feature/2.0.0/command-descriptions

Conversation

@Citymonstret
Copy link
Copy Markdown
Member

@Citymonstret Citymonstret commented Nov 27, 2023

A command description is a pair of argument descriptions (a short description and a verbose description).

This uses argument descriptions as they are already well-supported by the platforms. This means that Minecraft commands can use the rich descriptions and all the features that come with that.

The old meta keys have been removed. A separate PR will address the @CommandDescription annotation.

This also changes how Bukkit attempts to resolve descriptions for root commands. It will:

  1. Check for the presence of a new BUKKIT_DESCRIPTION command meta key.
  2. Attempt to resolve the command description.
  3. Use the argument description of the root command node (the description you supply when you do CommandManager.commandBuilder(...)).

This should solve #527. The mapping to Bukkit is less than perfect, as Bukkit's help menu displays root commands, and root commands are not really a concept in Cloud outside of the command tree.

A command description is a pair of argument descriptions (a short description and a verbose description).

This uses argument descriptions as they are already well-supported by the platforms. This means that Minecraft commands can use the rich descriptions and all the features that come with that.

The old meta keys have been removed. A separate PR will address the `@CommandDescription` annotation.

This should solve #527.
@Citymonstret Citymonstret added this to the 2.0.0 milestone Nov 27, 2023
@Citymonstret Citymonstret self-assigned this Nov 27, 2023
@github-actions
Copy link
Copy Markdown

github-actions bot commented Nov 27, 2023

Test Results

  68 files  ±0    68 suites  ±0   12s ⏱️ -8s
443 tests ±0  443 ✔️ ±0  0 💤 ±0  0 ±0 
455 runs  ±0  455 ✔️ ±0  0 💤 ±0  0 ±0 

Results for commit 96085ba. ± Comparison against base commit eb3631e.

♻️ This comment has been updated with latest results.

@Citymonstret Citymonstret merged commit 046bcda into 2.0.0-dev Nov 28, 2023
@Citymonstret Citymonstret deleted the feature/2.0.0/command-descriptions branch November 28, 2023 05:34
@Citymonstret Citymonstret mentioned this pull request Nov 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

No open projects
Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant