Class ScriptCommandExecutor

java.lang.Object

org.skriptlang.skript.bukkit.command.custom.ScriptCommandExecutor

@Internal
public class ScriptCommandExecutor
extends Object

An executor for Brigadier commands.

Constructor Summary

Constructors

Constructor	Description
ScriptCommandExecutor(Trigger trigger, List<ArgumentData<?>> arguments, @Nullable CooldownManager cooldownManager)

Method Summary

Modifier and Type	Method	Description
int	execute(com.mojang.brigadier.context.CommandContext<io.papermc.paper.command.brigadier.CommandSourceStack> context)
static @Nullable Object	getArgument(ArgumentData<?> argument, Set<String> providedArguments, com.mojang.brigadier.context.CommandContext<io.papermc.paper.command.brigadier.CommandSourceStack> context, ScriptCommandExecutionEvent commandEvent)	Utility method for mapping a ArgumentData to its real value given context.
static Map<ArgumentData<?>, Object>	getArguments(List<ArgumentData<?>> arguments, com.mojang.brigadier.context.CommandContext<io.papermc.paper.command.brigadier.CommandSourceStack> context, ScriptCommandExecutionEvent commandEvent)	Utility method for mapping a list of ArgumentDatas to their real values given context.
@Nullable CooldownManager	getCooldownManager()
static Set<String>	getProvidedArguments(com.mojang.brigadier.context.CommandContext<io.papermc.paper.command.brigadier.CommandSourceStack> context)	Obtains all arguments with available values in the provided context.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ScriptCommandExecutor

@Internal
public ScriptCommandExecutor(Trigger trigger,
 List<ArgumentData<?>> arguments,
 @Nullable
 @Nullable CooldownManager cooldownManager)

Method Details

getProvidedArguments

public static Set<String> getProvidedArguments(com.mojang.brigadier.context.CommandContext<io.papermc.paper.command.brigadier.CommandSourceStack> context)

Obtains all arguments with available values in the provided context.

Parameters:

context - Command context for obtaining provided arguments.

Returns:

A set of the names of arguments that have available values.

getArguments

public static Map<ArgumentData<?>, Object> getArguments(List<ArgumentData<?>> arguments,
 com.mojang.brigadier.context.CommandContext<io.papermc.paper.command.brigadier.CommandSourceStack> context,
 ScriptCommandExecutionEvent commandEvent)
                                                 throws com.mojang.brigadier.exceptions.CommandSyntaxException

Utility method for mapping a list of ArgumentDatas to their real values given context.

Parameters:

arguments - Arguments to map to values.

context - Command context for obtaining argument values.

commandEvent - Event context for resolving default values.

Returns:

A map of arguments to their values. Arguments that fail to resolve to a value are not included.

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException - If an error occurs while resolving certain arguments.

getArgument

@Nullable
public static @Nullable Object getArgument(ArgumentData<?> argument,
 Set<String> providedArguments,
 com.mojang.brigadier.context.CommandContext<io.papermc.paper.command.brigadier.CommandSourceStack> context,
 ScriptCommandExecutionEvent commandEvent)
                                    throws com.mojang.brigadier.exceptions.CommandSyntaxException

Utility method for mapping a ArgumentData to its real value given context.

Parameters:

argument - The argument to map to a value.

providedArguments - A set of arguments known to be provided in the context.

context - Command context for obtaining argument values.

commandEvent - Event context for resolving default values.

Returns:

The real value of argument given context. Null if argument was not provided, and it does not have a default value.

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException - If an error occurs while resolving this argument.

getCooldownManager

@Nullable
public @Nullable CooldownManager getCooldownManager()

execute

public int execute(com.mojang.brigadier.context.CommandContext<io.papermc.paper.command.brigadier.CommandSourceStack> context)
            throws com.mojang.brigadier.exceptions.CommandSyntaxException

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException