Add ExecutableBy.OPERATORS

Author: APickledWalrus

src/main/java/org/skriptlang/skript/bukkit/command/custom/ExecutableBy.java

@@ -1,11 +1,13 @@
 package org.skriptlang.skript.bukkit.command.custom;
 
+import com.google.common.collect.Sets;
 import org.bukkit.command.BlockCommandSender;
 import org.bukkit.command.CommandSender;
 import org.bukkit.command.ConsoleCommandSender;
 import org.bukkit.command.RemoteConsoleCommandSender;
 import org.bukkit.entity.Player;
 
+import java.util.Set;
 import java.util.function.Predicate;
 
 /**
@@ -18,6 +20,11 @@ public enum ExecutableBy {
 	 */
 	PLAYERS(sender -> sender instanceof Player),
 
+	/**
+	 * This command is only executable by operators.
+	 */
+	OPERATORS(CommandSender::isOp),
+
 	/**
 	 * This command is only executable by console.
 	 */
@@ -45,9 +52,21 @@ public Predicate<CommandSender> predicate() {
 	public String toString() {
 		return switch (this) {
 			case PLAYERS -> "players";
+			case OPERATORS -> "operators";
 			case CONSOLE -> "the console";
 			case BLOCKS -> "blocks";
 		};
 	}
 
+	/**
+	 * Compares whether a set of {@link ExecutableBy}s is a superset of another.
+	 * @param first The first set.
+	 * @param second The second set.
+	 * @return Whether the first set includes all {@link CommandSender}s covered by the second.
+	 */
+	public static boolean isSuperSet(Set<ExecutableBy> first, Set<ExecutableBy> second) {
+		Set<ExecutableBy> difference = Sets.difference(second, first);
+		return difference.isEmpty() || difference.equals(Set.of(ExecutableBy.OPERATORS));
+	}
+
 }

src/main/java/org/skriptlang/skript/bukkit/command/elements/structures/util/SubCommandEntryData.java

@@ -98,11 +98,14 @@ protected List<String> getValue(String value) {
 			protected Set<ExecutableBy> getValue(String value) {
 				EnumSet<ExecutableBy> executableBy = EnumSet.noneOf(ExecutableBy.class);
 				for (String type : pattern.split(value)) {
-					if (type.equalsIgnoreCase("console") || type.equalsIgnoreCase("the console")) {
-						executableBy.add(ExecutableBy.CONSOLE);
-					} else if (type.equalsIgnoreCase("players") || type.equalsIgnoreCase("player")) {
+					// "player" kept for compatibility
+					if (type.equalsIgnoreCase("players") || type.equalsIgnoreCase("player")) {
 						executableBy.add(ExecutableBy.PLAYERS);
-					} else if (type.equalsIgnoreCase("blocks") || type.equalsIgnoreCase("block")) {
+					} else if (type.equalsIgnoreCase("operators") || type.equalsIgnoreCase("ops")) {
+						executableBy.add(ExecutableBy.OPERATORS);
+					} else if (type.equalsIgnoreCase("console") || type.equalsIgnoreCase("the console")) {
+						executableBy.add(ExecutableBy.CONSOLE);
+					} else if (type.equalsIgnoreCase("blocks")) {
 						executableBy.add(ExecutableBy.BLOCKS);
 					} else {
 						Skript.error("Invalid command sender type: " + type);
@@ -239,7 +242,7 @@ public SubCommandEntryData(String key, boolean optional, boolean multiple) {
 				return null;
 			}
 			Set<ExecutableBy> parent = parsingData.getExecutorData(ExecutorData::executableBy);
-			if (parent != null && !parent.containsAll(executableBy)) {
+			if (parent != null && !ExecutableBy.isSuperSet(parent, executableBy)) {
 				Skript.error("It is not possible to restrict execution to " + CollectionUtils.toString(executableBy, true) +
 					" as the parent command is only executable by " + CollectionUtils.toString(parent, true) + ".");
 				return null;

src/test/skript/tests/bukkit/command/StructCommand.sk

@@ -30,6 +30,19 @@ parse:
 		command /entries_test_3:
 			subcommand test:
 
+# expect operators to be allowed below players (or other kinds)
+parse:
+	results: {-StructCommand::entries::4::*}
+	code:
+		command /entries_test_4:
+			executable by: players
+			trigger:
+				stop
+			subcommand test:
+				executable by: operators
+				trigger:
+					stop
+
 # expect error for duplicate argument names
 parse:
 	results: {-StructCommand::args::1::*}
@@ -114,6 +127,7 @@ test "StructCommand":
 	assert {-StructCommand::entries::1::*} is {_error_missing_trigger}
 	assert {-StructCommand::entries::2::*} is "It is not possible to restrict execution to the console as the parent command is only executable by players."
 	assert {-StructCommand::entries::3::*} is {_error_missing_trigger} and {_error_missing_trigger}
+	assert {-StructCommand::entries::4::*} is not set
 	assert {-StructCommand::args::1::*} is "The argument name 'x' was already used."
 	assert {-StructCommand::args::2::*} is "text arguments do not support minimum or maximum values."
 	assert {-StructCommand::args::3::*} is not set