Package dev.jorel.commandapi.arguments

Class CustomArgument<T,B>

java.lang.Object

dev.jorel.commandapi.ArgumentTree

dev.jorel.commandapi.arguments.Argument<T>

dev.jorel.commandapi.arguments.CustomArgument<T,B>

Type Parameters:

T - the return type of this custom argument when it is used

B - the return type of the underlying base argument base. For example, this would be Integer for an IntegerArgument

public class CustomArgument<T,B>
extends Argument<T>

An argument that represents any custom object

API Note:

Returns a CustomArgument object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CustomArgument.CustomArgumentException	An exception used to create command-related errors for the CustomArgument
static final record	CustomArgument.CustomArgumentInfo<B>	A record which contains information which can be passed to the custom argument's parser.
static interface	CustomArgument.CustomArgumentInfoParser<T,B>	A FunctionalInterface that takes in a CustomArgument.CustomArgumentInfo, returns T and can throw a CustomArgument.CustomArgumentException
static class	CustomArgument.MessageBuilder	MessageBuilder is used to create error messages for invalid argument inputs

Field Summary

Fields

Modifier and Type	Field	Description
protected CustomCommandExecutor<?>	executor	The CustomCommandExecutor for this executable implementation

Constructor Summary

Constructors

Constructor	Description
CustomArgument(Argument<B> base, CustomArgument.CustomArgumentInfoParser<T,B> parser)	Creates a CustomArgument with a valid parser, with an underlying base argument as its parsing implementation.
CustomArgument(String nodeName, CustomArgument.CustomArgumentInfoParser<T,String> parser)	Deprecated, for removal: This API element is subject to removal in a future version. Use CustomArgument(Argument, CustomArgumentInfoParser) with TextArgument instead
CustomArgument(String nodeName, CustomArgument.CustomArgumentInfoParser<T,String> parser, boolean keyed)	Deprecated, for removal: This API element is subject to removal in a future version. Use CustomArgument(Argument, CustomArgumentInfoParser) with TextArgument or NamespacedKeyArgument instead

Method Summary

Modifier and Type	Method	Description
ArgumentTree	clearExecutors()	Clear all executors from the current command builder
ArgumentTree	executes(CommandExecutor executor, ExecutorType... types)	Adds an executor to the current command builder
ArgumentTree	executes(ResultingCommandExecutor executor, ExecutorType... types)	Adds an executor to the current command builder
ArgumentTree	executesCommandBlock(CommandBlockCommandExecutor executor)	Adds an executor to the current command builder
ArgumentTree	executesCommandBlock(CommandBlockResultingCommandExecutor executor)	Adds an executor to the current command builder
ArgumentTree	executesConsole(ConsoleCommandExecutor executor)	Adds an executor to the current command builder
ArgumentTree	executesConsole(ConsoleResultingCommandExecutor executor)	Adds an executor to the current command builder
ArgumentTree	executesEntity(EntityCommandExecutor executor)	Adds an executor to the current command builder
ArgumentTree	executesEntity(EntityResultingCommandExecutor executor)	Adds an executor to the current command builder
ArgumentTree	executesNative(NativeCommandExecutor executor)	Adds an executor to the current command builder
ArgumentTree	executesNative(NativeResultingCommandExecutor executor)	Adds an executor to the current command builder
ArgumentTree	executesPlayer(PlayerCommandExecutor executor)	Adds an executor to the current command builder
ArgumentTree	executesPlayer(PlayerResultingCommandExecutor executor)	Adds an executor to the current command builder
ArgumentTree	executesProxy(ProxyCommandExecutor executor)	Adds an executor to the current command builder
ArgumentTree	executesProxy(ProxyResultingCommandExecutor executor)	Adds an executor to the current command builder
CommandAPIArgumentType	getArgumentType()	Returns the argument type for this argument.
CustomCommandExecutor<? extends org.bukkit.command.CommandSender>	getExecutor()	Returns the executors that this command has
Class<T>	getPrimitiveType()	Returns the primitive type of the current Argument.
<CommandListenerWrapper> T	parseArgument(NMS<CommandListenerWrapper> nms, com.mojang.brigadier.context.CommandContext<CommandListenerWrapper> cmdCtx, String key, Object[] previousArgs)	Parses an argument, returning the specific Bukkit object that the argument represents.
void	setExecutor(CustomCommandExecutor<? extends org.bukkit.command.CommandSender> executor)	Sets the executors for this command

Methods inherited from class dev.jorel.commandapi.arguments.Argument

getArgumentPermission, getEntityNames, getIncludedSuggestions, getNodeName, getOverriddenSuggestions, getRawType, getRequirements, includeSuggestions, includeSuggestions, includeSuggestionsT, isListed, replaceSuggestions, replaceSuggestions, replaceSuggestionsT, setListed, withPermission, withPermission, withRequirement

Methods inherited from class dev.jorel.commandapi.ArgumentTree

then

Methods inherited from class java.lang.Object

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

Field Details

executor

protected CustomCommandExecutor<?> executor

The CustomCommandExecutor for this executable implementation

Constructor Details

CustomArgument

@Deprecated(forRemoval=true)
public CustomArgument(String nodeName,
 CustomArgument.CustomArgumentInfoParser<T,String> parser)

Deprecated, for removal: This API element is subject to removal in a future version.

Use CustomArgument(Argument, CustomArgumentInfoParser) with TextArgument instead

Creates a CustomArgument with a valid parser, defaults to non-keyed argument

Parameters:

nodeName - the name of the node for this argument

parser - A CustomArgument.CustomArgumentInfo parser object which includes information such as the command sender, previously declared arguments and current input. This parser should return an object of your choice.

CustomArgument

@Deprecated(forRemoval=true)
public CustomArgument(String nodeName,
 CustomArgument.CustomArgumentInfoParser<T,String> parser,
 boolean keyed)

Deprecated, for removal: This API element is subject to removal in a future version.

Use CustomArgument(Argument, CustomArgumentInfoParser) with TextArgument or NamespacedKeyArgument instead

Creates a CustomArgument with a valid parser, defaults to non-keyed argument

Parameters:

nodeName - the name of the node for this argument

parser - A CustomArgument.CustomArgumentInfo parser object which includes information such as the command sender, previously declared arguments and current input. This parser should return an object of your choice.

keyed - Whether this argument can accept Minecraft's NamespacedKey as valid arguments

CustomArgument

public CustomArgument(Argument<B> base,
 CustomArgument.CustomArgumentInfoParser<T,B> parser)

Creates a CustomArgument with a valid parser, with an underlying base argument as its parsing implementation.

Parameters:

base - the base argument to use for this custom argument. This base argument will represent the parsing implementation for client side and server side parsing. This base argument cannot be a LiteralArgument or MultiLiteralArgument

parser - A CustomArgument.CustomArgumentInfo parser object which includes information such as the command sender, previously declared arguments and current input. This parser should return an object of your choice.

<T> the return type of this custom argument when it is used
<B> the return type of the underlying base argument base. For example, this would be Integer for an IntegerArgument

Method Details

getPrimitiveType

public Class<T> getPrimitiveType()

Description copied from class: Argument

Returns the primitive type of the current Argument. After executing a command, this argument should yield an object of this returned class.

Specified by:

getPrimitiveType in class Argument<T>

Returns:

the type that this argument yields when the command is run

getArgumentType

public CommandAPIArgumentType getArgumentType()

Description copied from class: Argument

Returns the argument type for this argument.

Specified by:

getArgumentType in class Argument<T>

Returns:

the argument type for this argument

parseArgument

public <CommandListenerWrapper> T parseArgument(NMS<CommandListenerWrapper> nms,
 com.mojang.brigadier.context.CommandContext<CommandListenerWrapper> cmdCtx,
 String key,
 Object[] previousArgs)
                                         throws com.mojang.brigadier.exceptions.CommandSyntaxException

Description copied from class: Argument

Parses an argument, returning the specific Bukkit object that the argument represents. This is intended for use by the internals of the CommandAPI and isn't expected to be used outside the CommandAPI

Specified by:

parseArgument in class Argument<T>

Type Parameters:

CommandListenerWrapper - the command source type

Parameters:

nms - an instance of NMS

cmdCtx - the context which ran this command

key - the name of the argument node

previousArgs - an array of previously declared arguments

Returns:

the parsed object represented by this argument

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException - if parsing fails

executes

public ArgumentTree executes(CommandExecutor executor,
 ExecutorType... types)

Adds an executor to the current command builder

Parameters:

executor - A lambda of type (CommandSender, Object[]) -> () that will be executed when the command is run

types - A list of executor types to use this executes method for.

Returns:

this command builder

executes

public ArgumentTree executes(ResultingCommandExecutor executor,
 ExecutorType... types)

Adds an executor to the current command builder

Parameters:

executor - A lambda of type (CommandSender, Object[]) -> int that will be executed when the command is run

types - A list of executor types to use this executes method for.

Returns:

this command builder

executesPlayer

public ArgumentTree executesPlayer(PlayerCommandExecutor executor)

Adds an executor to the current command builder

Parameters:

executor - A lambda of type (Player, Object[]) -> () that will be executed when the command is run

Returns:

this command builder

executesPlayer

public ArgumentTree executesPlayer(PlayerResultingCommandExecutor executor)

Adds an executor to the current command builder

Parameters:

executor - A lambda of type (Player, Object[]) -> int that will be executed when the command is run

Returns:

this command builder

executesEntity

public ArgumentTree executesEntity(EntityCommandExecutor executor)

Adds an executor to the current command builder

Parameters:

executor - A lambda of type (Entity, Object[]) -> () that will be executed when the command is run

Returns:

this command builder

executesEntity

public ArgumentTree executesEntity(EntityResultingCommandExecutor executor)

Adds an executor to the current command builder

Parameters:

executor - A lambda of type (Entity, Object[]) -> int that will be executed when the command is run

Returns:

this command builder

executesProxy

public ArgumentTree executesProxy(ProxyCommandExecutor executor)

Adds an executor to the current command builder

Parameters:

executor - A lambda of type (Entity, Object[]) -> () that will be executed when the command is run

Returns:

this command builder

executesProxy

public ArgumentTree executesProxy(ProxyResultingCommandExecutor executor)

Adds an executor to the current command builder

Parameters:

executor - A lambda of type (Entity, Object[]) -> int that will be executed when the command is run

Returns:

this command builder

executesCommandBlock

public ArgumentTree executesCommandBlock(CommandBlockCommandExecutor executor)

Adds an executor to the current command builder

Parameters:

executor - A lambda of type (BlockCommandSender, Object[]) -> () that will be executed when the command is run

Returns:

this command builder

executesCommandBlock

public ArgumentTree executesCommandBlock(CommandBlockResultingCommandExecutor executor)

Adds an executor to the current command builder

Parameters:

executor - A lambda of type (BlockCommandSender, Object[]) -> int that will be executed when the command is run

Returns:

this command builder

executesConsole

public ArgumentTree executesConsole(ConsoleCommandExecutor executor)

Adds an executor to the current command builder

Parameters:

executor - A lambda of type (BlockCommandSender, Object[]) -> () that will be executed when the command is run

Returns:

this command builder

executesConsole

public ArgumentTree executesConsole(ConsoleResultingCommandExecutor executor)

Adds an executor to the current command builder

Parameters:

executor - A lambda of type (BlockCommandSender, Object[]) -> int that will be executed when the command is run

Returns:

this command builder

executesNative

public ArgumentTree executesNative(NativeCommandExecutor executor)

Adds an executor to the current command builder

Parameters:

executor - A lambda of type (NativeCommandExecutor, Object[]) -> () that will be executed when the command is run

Returns:

this command builder

executesNative

public ArgumentTree executesNative(NativeResultingCommandExecutor executor)

Adds an executor to the current command builder

Parameters:

executor - A lambda of type (NativeCommandExecutor, Object[]) -> int that will be executed when the command is run

Returns:

this command builder

getExecutor

public CustomCommandExecutor<? extends org.bukkit.command.CommandSender> getExecutor()

Returns the executors that this command has

Returns:

the executors that this command has

setExecutor

public void setExecutor(CustomCommandExecutor<? extends org.bukkit.command.CommandSender> executor)

Sets the executors for this command

Parameters:

executor - the executors for this command

clearExecutors

public ArgumentTree clearExecutors()

Clear all executors from the current command builder

Returns:

this command builder