Add additional command event values

Author: APickledWalrus

src/main/java/ch/njol/skript/expressions/ExprCommandSender.java

@@ -34,7 +34,9 @@ protected void loadSelf(SkriptAddon addon) {
 			ExprArgument::register,
 			ExprCmdCooldownInfo::register,
 			ExprCommand::register,
+			ExprCommandExecutor::register,
 			ExprCommandInfo::register,
+			ExprCommandSender::register,
 			syntaxRegistry -> StructCommand.register(addon, syntaxRegistry)
 		);
 	}

src/main/java/org/skriptlang/skript/bukkit/command/CommandModule.java

@@ -1,10 +1,15 @@
 package org.skriptlang.skript.bukkit.command.custom;
 
+import io.papermc.paper.command.brigadier.CommandSourceStack;
+import org.bukkit.Location;
 import org.bukkit.command.CommandSender;
+import org.bukkit.entity.Entity;
 import org.bukkit.event.Event;
 import org.bukkit.event.HandlerList;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
 
@@ -15,34 +20,78 @@ public class ScriptCommandEvent extends Event {
 
 	private final String label;
 	private final String rawInput;
+	private final ScriptCommandExecutor commandExecutor;
 	private final CommandSender sender;
-	private final ScriptCommandExecutor executor;
+	private final @Nullable Entity executor;
+	private final Location location;
 
 	final Map<String, Object> arguments = new HashMap<>();
 
-	public ScriptCommandEvent(String label, String rawInput, CommandSender sender, ScriptCommandExecutor executor) {
+	public ScriptCommandEvent(String label, String rawInput, ScriptCommandExecutor commandExecutor, CommandSourceStack source) {
 		this.label = label;
 		this.rawInput = rawInput;
-		this.sender = sender;
-		this.executor = executor;
+		this.commandExecutor = commandExecutor;
+		this.sender = source.getSender();
+		this.executor = source.getExecutor();
+		this.location = source.getLocation();
 	}
 
+	/**
+	 * @return The label of the executed command.
+	 */
 	public String getLabel() {
 		return label;
 	}
 
+	/**
+	 * @return The full raw input being executed.
+	 */
 	public String getRawInput() {
 		return rawInput;
 	}
 
+	/**
+	 * @return The sender is the thing that initiated/triggered the execution of the command.
+	 * It differs to {@link #getExecutor()} in that the executor can be changed by a command, e.g. {@code /execute}.
+	 */
 	public CommandSender getSender() {
 		return sender;
 	}
 
-	public ScriptCommandExecutor getExecutor() {
+	/**
+	 * @return The entity that executes the command.
+	 * May not always be {@link #getSender()} as the executor of a command can be changed to a different entity than the one that triggered the command.
+	 */
+	public @Nullable Entity getExecutor() {
 		return executor;
 	}
 
+	/**
+	 * @return The location that the command is being executed at.
+	 */
+	public Location getLocation() {
+		return location;
+	}
+
+	/**
+	 * @return The command executor being used to execute this command (perform logic).
+	 */
+	public ScriptCommandExecutor getCommandExecutor() {
+		return commandExecutor;
+	}
+
+	/**
+	 * @return A map of all available arguments and their values.
+	 */
+	public Map<String, Object> getArguments() {
+		return Collections.unmodifiableMap(arguments);
+	}
+
+	/**
+	 * Obtains an argument by its name.
+	 * @param name The name of the argument.
+	 * @return The value of the argument.
+	 */
 	public Object getArgument(String name) {
 		return arguments.get(name);
 	}

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

@@ -52,12 +52,12 @@ public ScriptCommandExecutor(Trigger trigger, List<ArgumentData<?>> arguments, @
 	}
 
 	public int execute(CommandContext<CommandSourceStack> context) throws CommandSyntaxException {
-		CommandSender sender = context.getSource().getSender();
+		CommandSourceStack source = context.getSource();
 		ScriptCommandEvent commandEvent =
-			new ScriptCommandEvent(context.getNodes().getFirst().getNode().getName(), context.getInput(), sender, this);
+			new ScriptCommandEvent(context.getNodes().getFirst().getNode().getName(), context.getInput(), this, source);
 
 		// final validations
-		if (cooldownManager != null && !cooldownManager.checkExecution(commandEvent, sender)) {
+		if (cooldownManager != null && !cooldownManager.checkExecution(commandEvent, source.getSender())) {
 			return Command.SINGLE_SUCCESS;
 		}
 

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

@@ -64,8 +64,8 @@ public Class<? extends Event>[] supportedEvents() {
 	@Override
 	protected void execute(Event event) {
 		if (event instanceof ScriptCommandEvent commandEvent) {
-			assert commandEvent.getExecutor().getCooldownManager() != null;
-			commandEvent.getExecutor().getCooldownManager()
+			assert commandEvent.getCommandExecutor().getCooldownManager() != null;
+			commandEvent.getCommandExecutor().getCooldownManager()
 				.setStartDate(event, commandEvent.getSender(), cancel ? null : Date.now());
 		}
 	}

src/main/java/org/skriptlang/skript/bukkit/command/elements/effects/EffCancelCooldown.java

@@ -79,7 +79,7 @@ protected Object[] get(Event event) {
 			return (Object[]) Array.newInstance(getReturnType(), 0);
 		}
 
-		CooldownManager cooldownManager = commandEvent.getExecutor().getCooldownManager();
+		CooldownManager cooldownManager = commandEvent.getCommandExecutor().getCooldownManager();
 		assert cooldownManager != null;
 
 		return switch (type) {
@@ -130,7 +130,7 @@ public void change(Event event, Object @Nullable [] delta, ChangeMode mode) {
 			return;
 		}
 
-		CooldownManager cooldownManager = commandEvent.getExecutor().getCooldownManager();
+		CooldownManager cooldownManager = commandEvent.getCommandExecutor().getCooldownManager();
 		assert cooldownManager != null;
 
 		Date startDate = cooldownManager.getStartDate(event, commandEvent.getSender());

src/main/java/org/skriptlang/skript/bukkit/command/elements/expressions/ExprCmdCooldownInfo.java

@@ -0,0 +1,75 @@
+package org.skriptlang.skript.bukkit.command.elements.expressions;
+
+import ch.njol.skript.doc.Description;
+import ch.njol.skript.doc.Example;
+import ch.njol.skript.doc.Name;
+import ch.njol.skript.doc.Since;
+import ch.njol.skript.lang.EventRestrictedSyntax;
+import ch.njol.skript.lang.Expression;
+import ch.njol.skript.lang.SkriptParser.ParseResult;
+import ch.njol.skript.lang.util.SimpleExpression;
+import ch.njol.util.Kleenean;
+import org.bukkit.entity.Entity;
+import org.bukkit.event.Event;
+import org.jetbrains.annotations.Nullable;
+import org.skriptlang.skript.bukkit.command.custom.ScriptCommandEvent;
+import org.skriptlang.skript.registration.SyntaxInfo;
+import org.skriptlang.skript.registration.SyntaxRegistry;
+
+@Name("Command Executor")
+@Description("""
+	The executor of a command.
+	This differs from the command sender in that the executor may not be the thing that triggered/initiated the command.
+	The executor of a command is often changed to be different from the command sender by using a vanilla command such as "/execute".
+	""")
+@Example("""
+	command /balance:
+		# This works if you do "/execute as <player> run balance"
+		# It will send the output to the command sender, but it will be as if "<player>" was the thing executing it.
+		send "Your balance is %{balance::%uuid of the executor%}%" to the sender
+	""")
+@Since("INSERT VERSION")
+public class ExprCommandExecutor extends SimpleExpression<Entity> implements EventRestrictedSyntax {
+
+	public static void register(SyntaxRegistry syntaxRegistry) {
+		syntaxRegistry.register(SyntaxRegistry.EXPRESSION,
+			SyntaxInfo.Expression.simple(ExprCommandExecutor.class, ExprCommandExecutor::new, Entity.class,
+				"[the] [command['s]] executor"));
+	}
+
+	@Override
+	public boolean init(Expression<?>[] expressions, int matchedPattern, Kleenean isDelayed, ParseResult parseResult) {
+		return true;
+	}
+
+	@Override
+	public Class<? extends Event>[] supportedEvents() {
+		//noinspection unchecked
+		return new Class[]{ScriptCommandEvent.class};
+	}
+
+	@Override
+	protected Entity[] get(Event event) {
+		Entity executor = null;
+		if (event instanceof ScriptCommandEvent scriptCommandEvent) {
+			executor = scriptCommandEvent.getExecutor();
+		}
+		return executor == null ? new Entity[0] : new Entity[]{executor};
+	}
+
+	@Override
+	public boolean isSingle() {
+		return true;
+	}
+
+	@Override
+	public Class<? extends Entity> getReturnType() {
+		return Entity.class;
+	}
+
+	@Override
+	public String toString(@Nullable Event event, boolean debug) {
+		return "the command executor";
+	}
+
+}

src/main/java/org/skriptlang/skript/bukkit/command/elements/expressions/ExprCommandExecutor.java

@@ -0,0 +1,39 @@
+package org.skriptlang.skript.bukkit.command.elements.expressions;
+
+import org.bukkit.command.CommandSender;
+
+import ch.njol.skript.doc.Description;
+import ch.njol.skript.doc.Events;
+import ch.njol.skript.doc.Example;
+import ch.njol.skript.doc.Name;
+import ch.njol.skript.doc.Since;
+import ch.njol.skript.expressions.base.EventValueExpression;
+import org.skriptlang.skript.registration.SyntaxRegistry;
+
+@Name("Command Sender")
+@Description("""
+	The sender of a command. \
+	This differs from the command executor in that this is always the thing that originally triggered/initiated the command. \
+	It cannot be changed by commands like "/execute". \
+	""")
+@Example("make the command sender execute \"/say hi!\"")
+@Example("""
+	on command:
+		log "%sender% used command /%command% %arguments%" to "commands.log"
+	""")
+@Since("2.0")
+@Events("command")
+public class ExprCommandSender extends EventValueExpression<CommandSender> {
+
+	public static void register(SyntaxRegistry syntaxRegistry) {
+		syntaxRegistry.register(SyntaxRegistry.EXPRESSION,
+			infoBuilder(ExprCommandSender.class, CommandSender.class, "[command['s]] sender")
+				.supplier(ExprCommandSender::new)
+				.build());
+	}
+
+	public ExprCommandSender() {
+		super(CommandSender.class);
+	}
+
+}

src/main/java/org/skriptlang/skript/bukkit/command/elements/expressions/ExprCommandSender.java

@@ -4,8 +4,13 @@
 import ch.njol.skript.config.SectionNode;
 import ch.njol.skript.lang.Literal;
 import ch.njol.skript.lang.SkriptParser.ParseResult;
+import ch.njol.skript.registrations.Classes;
 import com.mojang.brigadier.tree.LiteralCommandNode;
 import io.papermc.paper.command.brigadier.CommandSourceStack;
+import org.bukkit.Location;
+import org.bukkit.World;
+import org.bukkit.block.Block;
+import org.bukkit.command.BlockCommandSender;
 import org.bukkit.command.CommandSender;
 import org.bukkit.event.Event;
 import org.jetbrains.annotations.Nullable;
@@ -33,6 +38,14 @@ public static void register(SkriptAddon addon, SyntaxRegistry syntaxRegistry) {
 
 		EventValueRegistry evRegistry = addon.registry(EventValueRegistry.class);
 		evRegistry.register(EventValue.simple(ScriptCommandEvent.class, CommandSender.class, ScriptCommandEvent::getSender));
+		evRegistry.register(EventValue.simple(ScriptCommandEvent.class, String[].class,
+			event -> event.getArguments().values().stream()
+				.map(Classes::toString)
+				.toArray(String[]::new)));
+		evRegistry.register(EventValue.simple(ScriptCommandEvent.class, Block.class,
+			event -> event.getSender() instanceof BlockCommandSender sender ? sender.getBlock() : null));
+		evRegistry.register(EventValue.simple(ScriptCommandEvent.class, Location.class, ScriptCommandEvent::getLocation));
+		evRegistry.register(EventValue.simple(ScriptCommandEvent.class, World.class, event -> event.getLocation().getWorld()));
 	}
 
 	private static final SubCommandEntryData ROOT_ENTRY_DATA =