Commands Overhaul

src/main/java/ch/njol/skript/Skript.java

@@ -4,7 +4,6 @@
 import ch.njol.skript.bukkitutil.BurgerHelper;
 import ch.njol.skript.classes.ClassInfo;
 import ch.njol.skript.classes.data.*;
-import ch.njol.skript.command.Commands;
 import ch.njol.skript.doc.Documentation;
 import ch.njol.skript.events.EvtSkript;
 import ch.njol.skript.expressions.arithmetic.ExprArithmetic;
@@ -44,15 +43,14 @@
 import org.bukkit.event.Event;
 import org.bukkit.event.EventHandler;
 import org.bukkit.event.Listener;
-import org.bukkit.event.player.PlayerCommandPreprocessEvent;
 import org.bukkit.event.player.PlayerJoinEvent;
 import org.bukkit.event.server.PluginDisableEvent;
-import org.bukkit.event.server.ServerCommandEvent;
 import org.bukkit.event.server.ServerLoadEvent;
 import org.bukkit.plugin.Plugin;
 import org.bukkit.plugin.PluginDescriptionFile;
 import org.bukkit.plugin.java.JavaPlugin;
 import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.jetbrains.annotations.UnknownNullability;
 import org.jetbrains.annotations.Unmodifiable;
@@ -63,6 +61,7 @@
 import org.skriptlang.skript.addon.AddonModule;
 import org.skriptlang.skript.bukkit.BukkitModule;
 import org.skriptlang.skript.bukkit.SkriptMetrics;
+import org.skriptlang.skript.bukkit.command.elements.effects.EffCommand;
 import org.skriptlang.skript.bukkit.lang.eventvalue.EventValueRegistry;
 import org.skriptlang.skript.bukkit.log.runtime.BukkitRuntimeErrorConsumer;
 import org.skriptlang.skript.bukkit.registration.BukkitSyntaxInfos;
@@ -80,7 +79,9 @@
 import org.skriptlang.skript.lang.script.Script;
 import org.skriptlang.skript.lang.structure.Structure;
 import org.skriptlang.skript.lang.structure.StructureInfo;
+import org.skriptlang.skript.log.runtime.ErrorSource;
 import org.skriptlang.skript.log.runtime.RuntimeErrorManager;
+import org.skriptlang.skript.log.runtime.RuntimeErrorProducer;
 import org.skriptlang.skript.registration.DefaultSyntaxInfos;
 import org.skriptlang.skript.registration.SyntaxInfo;
 import org.skriptlang.skript.registration.SyntaxRegistry;
@@ -577,8 +578,6 @@ public String name() {
 
 		Aliases.load();
 
-		Commands.registerListeners();
-
 		if (logNormal())
 			info(" " + Language.get("skript.copyright"));
 
@@ -1804,26 +1803,24 @@ public static <E extends Structure> void registerStructure(
 	 * @param sender
 	 * @param command
 	 * @return Whether the command was run
+	 * @deprecated There is no replacement for this method.
 	 */
-	public static boolean dispatchCommand(final CommandSender sender, final String command) {
-		try {
-			if (sender instanceof Player) {
-				final PlayerCommandPreprocessEvent e = new PlayerCommandPreprocessEvent((Player) sender, "/" + command);
-				Bukkit.getPluginManager().callEvent(e);
-				if (e.isCancelled() || !e.getMessage().startsWith("/"))
-					return false;
-				return Bukkit.dispatchCommand(e.getPlayer(), e.getMessage().substring(1));
-			} else {
-				final ServerCommandEvent e = new ServerCommandEvent(sender, command);
-				Bukkit.getPluginManager().callEvent(e);
-				if (e.getCommand().isEmpty() || e.isCancelled())
-					return false;
-				return Bukkit.dispatchCommand(e.getSender(), e.getCommand());
+	@Deprecated(since = "INSERT VERSION", forRemoval = true)
+	public static boolean dispatchCommand(CommandSender sender, String command) {
+		return EffCommand.dispatchCommand(sender, command, new RuntimeErrorProducer() {
+			@Override
+			public @NotNull ErrorSource getErrorSource() {
+				throw new UnsupportedOperationException();
 			}
-		} catch (final Exception ex) {
-			ex.printStackTrace(); // just like Bukkit
-			return false;
-		}
+			@Override
+			public void error(String message) { }
+			@Override
+			public void error(String message, String highlight) { }
+			@Override
+			public void warning(String message) { }
+			@Override
+			public void warning(String message, String highlight) { }
+		});
 	}
 
 	// ================ LOGGING ================

src/main/java/ch/njol/skript/SkriptConfig.java

@@ -243,6 +243,10 @@ public static String formatDate(final long timestamp) {
 	public static final Option<Boolean> caseInsensitiveVariables = new Option<>("case-insensitive variables", true)
 			.setter(t -> Variables.caseInsensitiveVariables = t);
 
+	/**
+	 * @deprecated This config option is no longer used and there is no replacement.
+	 */
+	@Deprecated(since = "INSERT VERSION", forRemoval = true)
 	public static final Option<Boolean> caseInsensitiveCommands = new Option<>("case-insensitive commands", false)
 		.optional(true);
 
@@ -308,6 +312,13 @@ public static String formatDate(final long timestamp) {
 	public static final Option<Boolean> allowUnsafePlatforms = new Option<>("allow unsafe platforms", false)
 			.optional(true);
 
+	public static final Option<Boolean> enableLegacyTabCompletion = new Option<>("enable legacy tab completion event compatibility", true)
+			.optional(true);
+
+	/**
+	 * @deprecated This config option is no longer used and there is no replacement.
+	 */
+	@Deprecated(since = "INSERT VERSION", forRemoval = true)
 	public static final Option<Boolean> keepLastUsageDates = new Option<>("keep command last usage dates", false)
 			.optional(true);
 

src/main/java/ch/njol/skript/bukkitutil/CommandReloader.java

@@ -10,7 +10,9 @@
 
 /**
  * Utilizes CraftServer with reflection to re-send commands to clients.
+ * @deprecated This behavior should not be relied upon. There is no replacement.
  */
+@Deprecated(since = "INSERT VERSION", forRemoval = true)
 public class CommandReloader {
 
 	@Nullable

src/main/java/ch/njol/skript/command/Argument.java

@@ -22,7 +22,10 @@
  * Represents an argument of a command
  * 
  * @author Peter Güttinger
+ * @deprecated There is no direct replacement for this class.
+ * The closest alternative is {@link org.skriptlang.skript.bukkit.command.custom.ArgumentData}.
  */
+@Deprecated(since = "INSERT VERSION", forRemoval = true)
 public class Argument<T> {
 
 	@Nullable

src/main/java/ch/njol/skript/command/CommandUsage.java

@@ -10,7 +10,9 @@
 /**
  * Holds info about the usage of a command.
  * TODO: replace with record when java 17
+ * @deprecated There is no direct replacement for this class.
  */
+@Deprecated(since = "INSERT VERSION", forRemoval = true)
 public class CommandUsage {
 
 	/**

src/main/java/ch/njol/skript/command/Commands.java

@@ -22,7 +22,6 @@
 import org.bukkit.event.EventPriority;
 import org.bukkit.event.Listener;
 import org.bukkit.event.player.AsyncPlayerChatEvent;
-import org.bukkit.event.player.PlayerCommandPreprocessEvent;
 import org.bukkit.event.server.ServerCommandEvent;
 import org.bukkit.help.HelpMap;
 import org.bukkit.help.HelpTopic;
@@ -52,10 +51,6 @@
 @SuppressWarnings("deprecation")
 public abstract class Commands {
 
-	public final static ArgsMessage m_too_many_arguments = new ArgsMessage("commands.too many arguments");
-	public final static Message m_internal_error = new Message("commands.internal error");
-	public final static Message m_correct_usage = new Message("commands.correct usage");
-
 	/**
 	 * A Converter flag declaring that a Converter cannot be used for parsing command arguments.
 	 */
@@ -125,46 +120,6 @@ public static String unescape(String string) {
 		return "" + unescape.matcher(string).replaceAll("$0");
 	}
 
-	private final static Listener commandListener = new Listener() {
-
-		@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)
-		public void onPlayerCommand(PlayerCommandPreprocessEvent event) {
-			// Spigot will simply report that the command doesn't exist if a player does not have permission to use it.
-			// This is good security but, well, it's a breaking change for Skript. So we need to check for permissions
-			// ourselves and handle those messages, for every command.
-
-			// parse command, see if it's a skript command
-			String[] cmd = event.getMessage().substring(1).split("\\s+", 2);
-			String label = cmd[0].toLowerCase(Locale.ENGLISH);
-			String arguments = cmd.length == 1 ? "" : "" + cmd[1];
-			ScriptCommand command = commands.get(label);
-
-			// is it a skript command?
-			if (command != null) {
-				// if so, check permissions to handle ourselves
-				if (!command.checkPermissions(event.getPlayer(), label, arguments))
-					event.setCancelled(true);
-
-				// we can also handle case sensitivity here:
-				if (SkriptConfig.caseInsensitiveCommands.value()) {
-					cmd[0] = event.getMessage().charAt(0) + label;
-					event.setMessage(String.join(" ", cmd));
-				}
-			}
-		}
-
-		@SuppressWarnings("null")
-		@EventHandler(priority = EventPriority.HIGHEST)
-		public void onServerCommand(ServerCommandEvent event) {
-			if (event.getCommand().isEmpty() || event.isCancelled())
-				return;
-			if ((Skript.testing() || SkriptConfig.enableEffectCommands.value()) && event.getCommand().startsWith(SkriptConfig.effectCommandToken.value())) {
-				if (handleEffectCommand(event.getSender(), event.getCommand()))
-					event.setCancelled(true);
-			}
-		}
-	};
-
 	static boolean handleEffectCommand(CommandSender sender, String command) {
 		if (!(Skript.testing() || sender instanceof ConsoleCommandSender || sender.hasPermission("skript.effectcommands") || SkriptConfig.allowOpsToUseEffectCommands.value() && sender.isOp()))
 			return false;
@@ -278,37 +233,45 @@ public static void unregisterCommand(ScriptCommand scriptCommand) {
 	private static boolean registeredListeners = false;
 
 	public static void registerListeners() {
-		if (!registeredListeners) {
-			Bukkit.getPluginManager().registerEvents(commandListener, Skript.getInstance());
-
-			Bukkit.getPluginManager().registerEvents(new Listener() {
-				@EventHandler(priority = EventPriority.LOWEST, ignoreCancelled = true)
-				public void onPlayerChat(AsyncPlayerChatEvent event) {
-					if ((!SkriptConfig.enableEffectCommands.value() && !Skript.testing()) || !event.getMessage().startsWith(SkriptConfig.effectCommandToken.value()))
-						return;
-					if (!event.isAsynchronous()) {
-						if (handleEffectCommand(event.getPlayer(), event.getMessage()))
-							event.setCancelled(true);
-					} else {
-						Future<Boolean> f = Bukkit.getScheduler().callSyncMethod(Skript.getInstance(), () -> handleEffectCommand(event.getPlayer(), event.getMessage()));
-						try {
-							while (true) {
-								try {
-									if (f.get())
-										event.setCancelled(true);
-									break;
-								} catch (InterruptedException ignored) {
-								}
-							}
-						} catch (ExecutionException e) {
-							Skript.exception(e);
+		if (registeredListeners) {
+			return;
+		}
+		Bukkit.getPluginManager().registerEvents(new Listener() {
+			@EventHandler(priority = EventPriority.HIGHEST)
+			public void onServerCommand(ServerCommandEvent event) {
+				if (event.getCommand().isEmpty() || event.isCancelled())
+					return;
+				if ((Skript.testing() || SkriptConfig.enableEffectCommands.value()) && event.getCommand().startsWith(SkriptConfig.effectCommandToken.value())) {
+					if (handleEffectCommand(event.getSender(), event.getCommand()))
+						event.setCancelled(true);
+				}
+			}
+
+			@EventHandler(priority = EventPriority.LOWEST, ignoreCancelled = true)
+			public void onPlayerChat(AsyncPlayerChatEvent event) {
+				if ((!SkriptConfig.enableEffectCommands.value() && !Skript.testing()) || !event.getMessage().startsWith(SkriptConfig.effectCommandToken.value()))
+					return;
+				if (!event.isAsynchronous()) {
+					if (handleEffectCommand(event.getPlayer(), event.getMessage()))
+						event.setCancelled(true);
+				} else {
+					Future<Boolean> f = Bukkit.getScheduler().callSyncMethod(Skript.getInstance(), () -> handleEffectCommand(event.getPlayer(), event.getMessage()));
+					try {
+						while (true) {
+							try {
+								if (f.get())
+									event.setCancelled(true);
+								break;
+							} catch (InterruptedException ignored) { }
 						}
+					} catch (ExecutionException e) {
+						Skript.exception(e);
 					}
 				}
-			}, Skript.getInstance());
+			}
+		}, Skript.getInstance());
 
-			registeredListeners = true;
-		}
+		registeredListeners = true;
 	}
 
 	/**

src/main/java/ch/njol/skript/command/ScriptCommand.java

@@ -64,11 +64,12 @@
 
 /**
  * This class is used for user-defined commands.
+ * @deprecated There is no direct replacement for this class.
+ * The closest alternative is {@link org.skriptlang.skript.bukkit.command.custom.ScriptBrigadierCommand}.
  */
+@Deprecated(since = "INSERT VERSION", forRemoval = true)
 public class ScriptCommand implements TabExecutor {
 
-	public final static Message m_executable_by_players = new Message("commands.executable by players");
-	public final static Message m_executable_by_console = new Message("commands.executable by console");
 	private static final String DEFAULT_PREFIX = "skript";
 
 	final String name;
@@ -160,7 +161,7 @@ public ScriptCommand(
 		label = "" + name.toLowerCase(Locale.ENGLISH);
 		this.permission = permission;
 		if (permissionMessage == null) {
-			VariableString defaultMsg = VariableString.newInstance(Language.get("commands.no permission message"));
+			VariableString defaultMsg = VariableString.newInstance("You don't have the required permission to use this command");
 			assert defaultMsg != null;
 			permissionMessage = defaultMsg;
 		}
@@ -262,12 +263,12 @@ public boolean onCommand(final @Nullable CommandSender sender, final @Nullable C
 	public boolean execute(final CommandSender sender, final String commandLabel, final String rest) {
 		if (sender instanceof Player) {
 			if ((executableBy & PLAYERS) == 0) {
-				sender.sendMessage("" + m_executable_by_console);
+				sender.sendMessage("This command can only be used by the console");
 				return false;
 			}
 		} else {
 			if ((executableBy & CONSOLE) == 0) {
-				sender.sendMessage("" + m_executable_by_players);
+				sender.sendMessage("This command can only be used by players");
 				return false;
 			}
 		}
@@ -332,7 +333,7 @@ public boolean execute(final CommandSender sender, final String commandLabel, fi
 	boolean execute2(final ScriptCommandEvent event, final CommandSender sender, final String commandLabel, final String rest) {
 		final ParseLogHandler log = SkriptLogger.startParseLogHandler();
 		try {
-			final boolean ok = SkriptParser.parseArguments(rest, ScriptCommand.this, event);
+			final boolean ok = false;
 			if (!ok) {
 				final LogEntry e = log.getError();
 				if (e != null)
@@ -351,7 +352,7 @@ boolean execute2(final ScriptCommandEvent event, final CommandSender sender, fin
 		final long startTrigger = System.nanoTime();
 
 		if (!trigger.execute(event))
-			sender.sendMessage(Commands.m_internal_error.toString());
+			sender.sendMessage("An internal error occurred while attempting to perform this command.");
 
 		if (Skript.log(Verbosity.VERY_HIGH))
 			Skript.info("# " + name + " took " + 1. * (System.nanoTime() - startTrigger) / 1000000. + " milliseconds");

src/main/java/ch/njol/skript/command/ScriptCommandEvent.java

@@ -5,7 +5,13 @@
 import org.bukkit.command.CommandSender;
 import org.bukkit.entity.Player;
 import org.bukkit.event.HandlerList;
+import org.skriptlang.skript.bukkit.command.custom.ScriptCommandExecutionEvent;
 
+/**
+ * @deprecated There is no direct replacement for this class.
+ * The closest alternative is {@link ScriptCommandExecutionEvent}.
+ */
+@Deprecated(since = "INSERT VERSION", forRemoval = true)
 public class ScriptCommandEvent extends CommandEvent {
 
 	private final ScriptCommand scriptCommand;

src/main/java/ch/njol/skript/command/package-info.java

@@ -1,25 +1 @@
-/**
- *   This file is part of Skript.
- *
- *  Skript is free software: you can redistribute it and/or modify
- *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation, either version 3 of the License, or
- *  (at your option) any later version.
- *
- *  Skript is distributed in the hope that it will be useful,
- *  but WITHOUT ANY WARRANTY; without even the implied warranty of
- *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *  GNU General Public License for more details.
- *
- *  You should have received a copy of the GNU General Public License
- *  along with Skript.  If not, see <http://www.gnu.org/licenses/>.
- *
- * Copyright Peter Güttinger, SkriptLang team and contributors
- */
-/**
- * Code related to handling commands, either Skript commands or custom script commands.
- * 
- * @author Peter Güttinger
- */
 package ch.njol.skript.command;
-