zhdev/oblak
1
0
Fork 0
Code Issues Pull requests Activity

Improve docs around Brigadier on bukkit/paper

Browse source
This commit is contained in:
Jason Penilla 2023-04-02 12:53:06 -07:00 • committed by Jason
parent c8f07033e6
commit 5bd2b90d02
5 changed files with 35 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

11
cloud-minecraft/cloud-paper/src/main/java/cloud/commandframework/paper/PaperCommandManager.java
View file

@ -113,7 +113,16 @@ public class PaperCommandManager<C> extends BukkitCommandManager<C> {
}
/**
* Register Brigadier mappings using the native paper events
* Attempts to enable Brigadier command registration through the Paper API, falling
* back to {@link BukkitCommandManager#registerBrigadier()} if that fails.
*
* <p>Callers should check for {@link CloudBukkitCapabilities#NATIVE_BRIGADIER} first
* to avoid exceptions.</p>
*
* <p>A check for {@link CloudBukkitCapabilities#NATIVE_BRIGADIER} {@code ||} {@link CloudBukkitCapabilities#COMMODORE_BRIGADIER}
* may also be appropriate for some use cases (because of the fallback behavior), but not most, as Commodore does not offer
* any functionality on modern
* versions (see the documentation for {@link CloudBukkitCapabilities#COMMODORE_BRIGADIER}).</p>
*
* @throws BrigadierFailureException Exception thrown if the mappings cannot be registered
*/