Allow old behavior for CommandRegisteredEvent (#8249)

Paper-MojangAPI/src/main/java/com/destroystokyo/paper/brigadier/BukkitBrigadierCommand.java

@@ -5,5 +5,10 @@ import com.mojang.brigadier.suggestion.SuggestionProvider;
 
 import java.util.function.Predicate;
 
+/**
+ * Brigadier {@link Command}, {@link SuggestionProvider}, and permission checker for Bukkit {@link Command}s.
+ *
+ * @param <S> command source type
+ */
 public interface BukkitBrigadierCommand <S extends BukkitBrigadierCommandSource> extends Command<S>, Predicate<S>, SuggestionProvider<S> {
 }

Paper-MojangAPI/src/main/java/com/destroystokyo/paper/event/brigadier/CommandRegisteredEvent.java

@@ -13,18 +13,17 @@ import org.bukkit.event.server.ServerEvent;
 import org.jetbrains.annotations.NotNull;
 
 /**
- * Fired anytime the server synchronizes Bukkit CommandMap to Brigadier.
+ * Fired anytime the server synchronizes Bukkit commands to Brigadier.
  *
- * Allows a plugin to control the Literal and Argument nodes for this command to be
- * sent to the client.
- * This is done at Plugin Enable time after commands have been registered, but some
- * plugins may use reflection to retrigger this rebuild during runtime.
+ * Allows a plugin to control the command node structure for its commands.
+ * This is done at Plugin Enable time after commands have been registered, but may also
+ * run at a later point in the server lifetime due to plugins, a server reload, etc.
  *
  * @deprecated Draft API - Subject to change until confirmed solves desired use cases
  */
 @Deprecated
 @Warning(false)
-public class CommandRegisteredEvent <S extends BukkitBrigadierCommandSource> extends ServerEvent implements Cancellable {
+public class CommandRegisteredEvent<S extends BukkitBrigadierCommandSource> extends ServerEvent implements Cancellable {
 
     private static final HandlerList handlers = new HandlerList();
     private final String commandLabel;
@@ -33,6 +32,7 @@ public class CommandRegisteredEvent <S extends BukkitBrigadierCommandSource> ext
     private final RootCommandNode<S> root;
     private final ArgumentCommandNode<S, String> defaultArgs;
     private LiteralCommandNode<S> literal;
+    private boolean rawCommand = false;
     private boolean cancelled = false;
 
     public CommandRegisteredEvent(String commandLabel, BukkitBrigadierCommand<S> brigadierCommand, Command command, RootCommandNode<S> root, LiteralCommandNode<S> literal, ArgumentCommandNode<S, String> defaultArgs) {
@@ -45,55 +45,99 @@ public class CommandRegisteredEvent <S extends BukkitBrigadierCommandSource> ext
     }
 
     /**
-     * @return The command name being registered
+     * Gets the command label of the {@link Command} being registered.
+     *
+     * @return the command label
      */
     public String getCommandLabel() {
-        return commandLabel;
+        return this.commandLabel;
     }
 
     /**
-     * @return The Bukkit API Brigadier Wrapped Command Object to handle executions and suggestions
+     * Gets the {@link BukkitBrigadierCommand} for the {@link Command} being registered. This can be used
+     * as the {@link com.mojang.brigadier.Command command executor} or
+     * {@link com.mojang.brigadier.suggestion.SuggestionProvider} of a {@link com.mojang.brigadier.tree.CommandNode}
+     * to delegate to the {@link Command} being registered.
+     *
+     * @return the {@link BukkitBrigadierCommand}
      */
     public BukkitBrigadierCommand<S> getBrigadierCommand() {
-        return brigadierCommand;
-    }
-
-    public Command getCommand() {
-        return command;
+        return this.brigadierCommand;
     }
 
     /**
-     * @return Gets the root command node being used to register a command to.
+     * Gets the {@link Command} being registered.
+     *
+     * @return the {@link Command}
+     */
+    public Command getCommand() {
+        return this.command;
+    }
+
+    /**
+     * Gets the {@link RootCommandNode} which is being registered to.
+     *
+     * @return the {@link RootCommandNode}
      */
     public RootCommandNode<S> getRoot() {
-        return root;
+        return this.root;
     }
 
     /**
-     * Returns the Bukkit API's default handling of Arguments, if you wish to reuse it.
-     * @return
+     * Gets the Bukkit APIs default arguments node (greedy string), for if
+     * you wish to reuse it.
+     *
+     * @return default arguments node
      */
     public ArgumentCommandNode<S, String> getDefaultArgs() {
-        return defaultArgs;
+        return this.defaultArgs;
     }
 
     /**
-     * Returns the Bukkit API's default literal for this command, including the {@link #getDefaultArgs()} as a child already.
-     * @return
+     * Gets the {@link LiteralCommandNode} to be registered for the {@link Command}.
+     *
+     * @return the {@link LiteralCommandNode}
      */
     public LiteralCommandNode<S> getLiteral() {
-        return literal;
+        return this.literal;
     }
 
     /**
-     * Changes the literal used to register this command. The previous literable is mutable, so this is primarily if
-     * you want to completely replace the object.
-     * @param literal
+     * Sets the {@link LiteralCommandNode} used to register this command. The default literal is mutable, so
+     * this is primarily if you want to completely replace the object.
+     *
+     * @param literal new node
      */
     public void setLiteral(LiteralCommandNode<S> literal) {
         this.literal = literal;
     }
 
+    /**
+     * Gets whether this command should is treated as "raw".
+     *
+     * @see #setRawCommand(boolean)
+     * @return whether this command is treated as "raw"
+     */
+    public boolean isRawCommand() {
+        return this.rawCommand;
+    }
+
+    /**
+     * Sets whether this command should be treated as "raw".
+     *
+     * <p>A "raw" command will only use the node provided by this event for
+     * sending the command tree to the client. For execution purposes, the default
+     * greedy string execution of a standard Bukkit {@link Command} is used.</p>
+     *
+     * <p>On older versions of Paper, this was the default and only behavior of this
+     * event.</p>
+     *
+     * @param rawCommand whether this command should be treated as "raw"
+     */
+    public void setRawCommand(final boolean rawCommand) {
+        this.rawCommand = rawCommand;
+    }
+
     /**
      * {@inheritDoc}
      */