CommandAPI 9.6.0
An API for the command UI introduced in Minecraft 1.13
dev.jorel.commandapi.arguments.SafeOverrideableArgument< T, S > Class Template Referenceabstract

An interface declaring methods required to override argument suggestions. More...

+ Inheritance diagram for dev.jorel.commandapi.arguments.SafeOverrideableArgument< T, S >:

Public Member Functions

Function< S, String > getMapper ()
 
Argument< T > instance ()
 Returns the instance of this class with the class Impl. More...
 
boolean isListed ()
 Returns true if this argument will be listed in the Object args[] of the command executor. More...
 
boolean isOptional ()
 Returns true if this argument will be optional when executing the command this argument is included in. More...
 
abstract Class< T > getPrimitiveType ()
 Returns the primitive type of the current Argument. More...
 
abstract CommandAPIArgumentType getArgumentType ()
 Returns the argument type for this argument. More...
 
final ArgumentType<?> getRawType ()
 Returns the NMS or brigadier type for this argument. More...
 
final String getNodeName ()
 Returns the name of this argument's node. More...
 
abstract< Source > T parseArgument (CommandContext< Source > cmdCtx, String key, CommandArguments previousArgs) throws CommandSyntaxException
 Parses an argument, returning the specific Bukkit object that the argument represents. More...
 
Impl includeSuggestions (ArgumentSuggestions< CommandSender > suggestions)
 Include suggestions to add to the list of default suggestions represented by this argument. More...
 
Optional< ArgumentSuggestions< CommandSender > > getIncludedSuggestions ()
 Returns an optional function which produces an array of suggestions which should be added to existing suggestions. More...
 
Impl replaceSuggestions (ArgumentSuggestions< CommandSender > suggestions)
 Replace the suggestions of this argument. More...
 
final Optional< ArgumentSuggestions< CommandSender > > getOverriddenSuggestions ()
 Returns an optional function that maps the command sender to an IStringTooltip array of suggestions for the current command. More...
 
final Impl withPermission (CommandPermission permission)
 Assigns the given permission as a requirement to execute this command. More...
 
final Impl withPermission (String permission)
 Assigns the given permission as a requirement to execute this command. More...
 
final CommandPermission getArgumentPermission ()
 Returns the permission required to run this command. More...
 
final Predicate< CommandSender > getRequirements ()
 Returns the requirements required to run this command. More...
 
final Impl withRequirement (Predicate< CommandSender > requirement)
 Adds a requirement that has to be satisfied to use this argument. More...
 
Impl setListed (boolean listed)
 Sets whether this argument will be listed in the Object args[] of the command executor. More...
 
Impl setOptional (boolean optional)
 Sets whether this argument will be optional when executing the command this argument is included in. More...
 
List< ArgumentgetCombinedArguments ()
 Returns a list of arguments linked to this argument. More...
 
boolean hasCombinedArguments ()
 Returns true if this argument has linked arguments. More...
 
final Impl combineWith (Argument... combinedArguments)
 Adds combined arguments to this argument. More...
 
List< String > getEntityNames (Object argument)
 Gets a list of entity names for the current provided argument. More...
 
void copyPermissionsAndRequirements (Argument argument)
 Copies permissions and requirements from the provided argument to this argument This also resets additional permissions and requirements. More...
 
String getHelpString ()
 
String toString ()
 
default Impl executes (CommandExecutor executor, ExecutorType... types)
 Adds an executor to the current command builder. More...
 
default Impl executes (CommandExecutionInfo executor, ExecutorType... types)
 Adds an executor to the current command builder. More...
 
default Impl executes (ResultingCommandExecutor executor, ExecutorType... types)
 Adds an executor to the current command builder. More...
 
default Impl executes (ResultingCommandExecutionInfo executor, ExecutorType... types)
 Adds an executor to the current command builder. More...
 
default Impl executesPlayer (PlayerCommandExecutor executor)
 Adds an executor to the current command builder. More...
 
default Impl executesPlayer (PlayerExecutionInfo info)
 Adds an executor to the current command builder. More...
 
default Impl executesPlayer (PlayerResultingCommandExecutor executor)
 Adds an executor to the current command builder. More...
 
default Impl executesPlayer (PlayerResultingExecutionInfo info)
 Adds an executor to the current command builder. More...
 
default Impl executesEntity (EntityCommandExecutor executor)
 Adds an executor to the current command builder. More...
 
default Impl executesEntity (EntityExecutionInfo info)
 Adds an executor to the current command builder. More...
 
default Impl executesEntity (EntityResultingCommandExecutor executor)
 Adds an executor to the current command builder. More...
 
default Impl executesEntity (EntityResultingExecutionInfo info)
 Adds an executor to the current command builder. More...
 
default Impl executesProxy (ProxyCommandExecutor executor)
 Adds an executor to the current command builder. More...
 
default Impl executesProxy (ProxyExecutionInfo info)
 Adds an executor to the current command builder. More...
 
default Impl executesProxy (ProxyResultingCommandExecutor executor)
 Adds an executor to the current command builder. More...
 
default Impl executesProxy (ProxyResultingExecutionInfo info)
 Adds an executor to the current command builder. More...
 
default Impl executesCommandBlock (CommandBlockCommandExecutor executor)
 Adds an executor to the current command builder. More...
 
default Impl executesCommandBlock (CommandBlockExecutionInfo info)
 Adds an executor to the current command builder. More...
 
default Impl executesCommandBlock (CommandBlockResultingCommandExecutor executor)
 Adds an executor to the current command builder. More...
 
default Impl executesCommandBlock (CommandBlockResultingExecutionInfo info)
 Adds an executor to the current command builder. More...
 
default Impl executesConsole (ConsoleCommandExecutor executor)
 Adds an executor to the current command builder. More...
 
default Impl executesConsole (ConsoleExecutionInfo info)
 Adds an executor to the current command builder. More...
 
default Impl executesConsole (ConsoleResultingCommandExecutor executor)
 Adds an executor to the current command builder. More...
 
default Impl executesConsole (ConsoleResultingExecutionInfo info)
 Adds an executor to the current command builder. More...
 
default Impl executesNative (NativeCommandExecutor executor)
 Adds an executor to the current command builder. More...
 
default Impl executesNative (NativeExecutionInfo info)
 Adds an executor to the current command builder. More...
 
default Impl executesNative (NativeResultingCommandExecutor executor)
 Adds an executor to the current command builder. More...
 
default Impl executesNative (NativeResultingExecutionInfo info)
 Adds an executor to the current command builder. More...
 
default Impl executesRemoteConsole (RemoteConsoleCommandExecutor executor)
 Adds an executor to the current command builder. More...
 
default Impl executesRemoteConsole (RemoteConsoleExecutionInfo info)
 Adds an executor to the current command builder. More...
 
default Impl executesRemoteConsole (RemoteConsoleResultingCommandExecutor executor)
 Adds an executor to the current command builder. More...
 
default Impl executesRemoteConsole (RemoteConsoleResultingExecutionInfo info)
 Adds an executor to the current command builder. More...
 
default Impl executesFeedbackForwarding (FeedbackForwardingCommandExecutor executor)
 Adds an executor to the current command builder. More...
 
default Impl executesFeedbackForwarding (FeedbackForwardingExecutionInfo info)
 Adds an executor to the current command builder. More...
 
default Impl executesFeedbackForwarding (FeedbackForwardingResultingCommandExecutor executor)
 Adds an executor to the current command builder. More...
 
default Impl executesFeedbackForwarding (FeedbackForwardingResultingExecutionInfo info)
 Adds an executor to the current command builder. More...
 
CommandAPIExecutor< CommandSender, AbstractCommandSender<? extends CommandSender > > getExecutor ()
 
Impl replaceSuggestions (ArgumentSuggestions< CommandSender > suggestions)
 
Impl includeSuggestions (ArgumentSuggestions< CommandSender > suggestions)
 
default Impl replaceSafeSuggestions (SafeSuggestions< S, CommandSender > suggestions)
 Replaces the suggestions with a safe SafeSuggestions object. More...
 
default Impl includeSafeSuggestions (SafeSuggestions< S, CommandSender > suggestions)
 Includes the suggestions provided with the existing suggestions for this argument. More...
 

Static Public Member Functions

static< S > Function< S, String > fromKey (Function< S, NamespacedKey > mapper)
 

Protected Member Functions

 SafeOverrideableArgument (String nodeName, ArgumentType<?> rawType, Function< S, String > mapper)
 Instantiates this argument and assigns the mapper to the provided mapper. More...
 

Detailed Description

An interface declaring methods required to override argument suggestions.

Parameters
<T>The type of the underlying object that this argument casts to
<S>A custom type which is represented by this argument. For example, a StringArgument will have a custom type String

Constructor & Destructor Documentation

◆ SafeOverrideableArgument()

dev.jorel.commandapi.arguments.SafeOverrideableArgument< T, S >.SafeOverrideableArgument ( String  nodeName,
ArgumentType<?>  rawType,
Function< S, String >  mapper 
)
protected

Instantiates this argument and assigns the mapper to the provided mapper.

Parameters
nodeNamethe node name of this argument
rawTypethe NMS raw argument type of this argument
mapperthe mapping function that maps this argument type to a string for suggestions

Member Function Documentation

◆ combineWith()

final Impl dev.jorel.commandapi.arguments.AbstractArgument< T, Impl, Argument, CommandSender >.combineWith ( Argument...  combinedArguments)
inherited

Adds combined arguments to this argument.

Combined arguments are used to have required arguments after optional arguments by ignoring they exist until they are added to the arguments array for registration.

This method also causes permissions and requirements from this argument to be copied over to the arguments you want to combine this argument with. Their permissions and requirements will be ignored.

Parameters
combinedArgumentsThe arguments to combine to this argument
Returns
this current argument

◆ copyPermissionsAndRequirements()

void dev.jorel.commandapi.arguments.AbstractArgument< T, Impl, Argument, CommandSender >.copyPermissionsAndRequirements ( Argument  argument)
inherited

Copies permissions and requirements from the provided argument to this argument This also resets additional permissions and requirements.

Parameters
argumentThe argument to copy permissions and requirements from

◆ executes() [1/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executes ( CommandExecutionInfo  executor,
ExecutorType...  types 
)
inherited

Adds an executor to the current command builder.

Parameters
executorA lambda of type (BukkitCommandExecutionInfo) -> () that will be executed when the command is run
typesA list of executor types to use this executes method for.
Returns
this command builder

◆ executes() [2/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executes ( CommandExecutor  executor,
ExecutorType...  types 
)
inherited

Adds an executor to the current command builder.

Parameters
executorA lambda of type (CommandSender, Object[]) -> () that will be executed when the command is run
typesA list of executor types to use this executes method for.
Returns
this command builder

◆ executes() [3/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executes ( ResultingCommandExecutionInfo  executor,
ExecutorType...  types 
)
inherited

Adds an executor to the current command builder.

Parameters
executorA lambda of type (BukkitCommandExecutionInfo) -> int that will be executed when the command is run
typesA list of executor types to use this executes method for.
Returns
this command builder

◆ executes() [4/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executes ( ResultingCommandExecutor  executor,
ExecutorType...  types 
)
inherited

Adds an executor to the current command builder.

Parameters
executorA lambda of type (CommandSender, CommandArguments) -> int that will be executed when the command is run
typesA list of executor types to use this executes method for.
Returns
this command builder

◆ executesCommandBlock() [1/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesCommandBlock ( CommandBlockCommandExecutor  executor)
inherited

Adds an executor to the current command builder.

Parameters
executorA lambda of type (BlockCommandSender, CommandArguments) -> () that will be executed when the command is run
Returns
this command builder

◆ executesCommandBlock() [2/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesCommandBlock ( CommandBlockExecutionInfo  info)
inherited

Adds an executor to the current command builder.

Parameters
infoA lambda of type (ExecutionInfo) -> () that will be executed when the command is run
Returns
this command builder

◆ executesCommandBlock() [3/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesCommandBlock ( CommandBlockResultingCommandExecutor  executor)
inherited

Adds an executor to the current command builder.

Parameters
executorA lambda of type (BlockCommandSender, CommandArguments) -> int that will be executed when the command is run
Returns
this command builder

◆ executesCommandBlock() [4/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesCommandBlock ( CommandBlockResultingExecutionInfo  info)
inherited

Adds an executor to the current command builder.

Parameters
infoA lambda of type (ExecutionInfo) -> int that will be executed when the command is run
Returns
this command builder

◆ executesConsole() [1/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesConsole ( ConsoleCommandExecutor  executor)
inherited

Adds an executor to the current command builder.

Parameters
executorA lambda of type (ConsoleCommandSender, CommandArguments) -> () that will be executed when the command is run
Returns
this command builder

◆ executesConsole() [2/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesConsole ( ConsoleExecutionInfo  info)
inherited

Adds an executor to the current command builder.

Parameters
infoA lambda of type (ExecutionInfo) -> () that will be executed when the command is run
Returns
this command builder

◆ executesConsole() [3/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesConsole ( ConsoleResultingCommandExecutor  executor)
inherited

Adds an executor to the current command builder.

Parameters
executorA lambda of type (ConsoleCommandSender, CommandArguments) -> int that will be executed when the command is run
Returns
this command builder

◆ executesConsole() [4/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesConsole ( ConsoleResultingExecutionInfo  info)
inherited

Adds an executor to the current command builder.

Parameters
infoA lambda of type (ExecutionInfo) -> int that will be executed when the command is run
Returns
this command builder

◆ executesEntity() [1/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesEntity ( EntityCommandExecutor  executor)
inherited

Adds an executor to the current command builder.

Parameters
executorA lambda of type (Entity, CommandArguments) -> () that will be executed when the command is run
Returns
this command builder

◆ executesEntity() [2/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesEntity ( EntityExecutionInfo  info)
inherited

Adds an executor to the current command builder.

Parameters
infoA lambda of type (ExecutionInfo) -> () that will be executed when the command is run
Returns
this command builder

◆ executesEntity() [3/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesEntity ( EntityResultingCommandExecutor  executor)
inherited

Adds an executor to the current command builder.

Parameters
executorA lambda of type (Entity, CommandArguments) -> int that will be executed when the command is run
Returns
this command builder

◆ executesEntity() [4/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesEntity ( EntityResultingExecutionInfo  info)
inherited

Adds an executor to the current command builder.

Parameters
infoA lambda of type (ExecutionInfo) -> int that will be executed when the command is run
Returns
this command builder

◆ executesFeedbackForwarding() [1/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesFeedbackForwarding ( FeedbackForwardingCommandExecutor  executor)
inherited

Adds an executor to the current command builder.

Parameters
executorA lambda of type (FeedbackForwardingCommandExecutor, CommandArguments) -> () that will be executed when the command is run
Returns
this command builder

◆ executesFeedbackForwarding() [2/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesFeedbackForwarding ( FeedbackForwardingExecutionInfo  info)
inherited

Adds an executor to the current command builder.

Parameters
infoA lambda of type (ExecutionInfo) -> () that will be executed when the command is run
Returns
this command builder

◆ executesFeedbackForwarding() [3/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesFeedbackForwarding ( FeedbackForwardingResultingCommandExecutor  executor)
inherited

Adds an executor to the current command builder.

Parameters
executorA lambda of type (FeedbackForwardingCommandExecutor, CommandArguments) -> int that will be executed when the command is run
Returns
this command builder

◆ executesFeedbackForwarding() [4/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesFeedbackForwarding ( FeedbackForwardingResultingExecutionInfo  info)
inherited

Adds an executor to the current command builder.

Parameters
infoA lambda of type (ExecutionInfo) -> int that will be executed when the command is run
Returns
this command builder

◆ executesNative() [1/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesNative ( NativeCommandExecutor  executor)
inherited

Adds an executor to the current command builder.

Parameters
executorA lambda of type (NativeCommandExecutor, CommandArguments) -> () that will be executed when the command is run
Returns
this command builder

◆ executesNative() [2/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesNative ( NativeExecutionInfo  info)
inherited

Adds an executor to the current command builder.

Parameters
infoA lambda of type (ExecutionInfo) -> () that will be executed when the command is run
Returns
this command builder

◆ executesNative() [3/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesNative ( NativeResultingCommandExecutor  executor)
inherited

Adds an executor to the current command builder.

Parameters
executorA lambda of type (NativeCommandExecutor, CommandArguments) -> int that will be executed when the command is run
Returns
this command builder

◆ executesNative() [4/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesNative ( NativeResultingExecutionInfo  info)
inherited

Adds an executor to the current command builder.

Parameters
infoA lambda of type (ExecutionInfo) -> int that will be executed when the command is run
Returns
this command builder

◆ executesPlayer() [1/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesPlayer ( PlayerCommandExecutor  executor)
inherited

Adds an executor to the current command builder.

Parameters
executorA lambda of type (Player, CommandArguments) -> () that will be executed when the command is run
Returns
this command builder

◆ executesPlayer() [2/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesPlayer ( PlayerExecutionInfo  info)
inherited

Adds an executor to the current command builder.

Parameters
infoA lambda of type (ExecutionInfo) -> () that will be executed when the command is run
Returns
this command builder

◆ executesPlayer() [3/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesPlayer ( PlayerResultingCommandExecutor  executor)
inherited

Adds an executor to the current command builder.

Parameters
executorA lambda of type (Player, CommandArguments) -> int that will be executed when the command is run
Returns
this command builder

◆ executesPlayer() [4/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesPlayer ( PlayerResultingExecutionInfo  info)
inherited

Adds an executor to the current command builder.

Parameters
infoA lambda of type (ExecutionInfo) -> int that will be executed when the command is run
Returns
this command builder

◆ executesProxy() [1/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesProxy ( ProxyCommandExecutor  executor)
inherited

Adds an executor to the current command builder.

Parameters
executorA lambda of type (Entity, CommandArguments) -> () that will be executed when the command is run
Returns
this command builder

◆ executesProxy() [2/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesProxy ( ProxyExecutionInfo  info)
inherited

Adds an executor to the current command builder.

Parameters
infoA lambda of type (ExecutionInfo) -> () that will be executed when the command is run
Returns
this command builder

◆ executesProxy() [3/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesProxy ( ProxyResultingCommandExecutor  executor)
inherited

Adds an executor to the current command builder.

Parameters
executorA lambda of type (Entity, CommandArguments) -> int that will be executed when the command is run
Returns
this command builder

◆ executesProxy() [4/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesProxy ( ProxyResultingExecutionInfo  info)
inherited

Adds an executor to the current command builder.

Parameters
infoA lambda of type (ExecutionInfo) -> int that will be executed when the command is run
Returns
this command builder

◆ executesRemoteConsole() [1/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesRemoteConsole ( RemoteConsoleCommandExecutor  executor)
inherited

Adds an executor to the current command builder.

Parameters
executorA lambda of type (RemoteConsoleCommandExecutor, CommandArguments) -> () that will be executed when the command is run
Returns
this command builder

◆ executesRemoteConsole() [2/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesRemoteConsole ( RemoteConsoleExecutionInfo  info)
inherited

Adds an executor to the current command builder.

Parameters
infoA lambda of type (ExecutionInfo) -> () that will be executed when the command is run
Returns
this command builder

◆ executesRemoteConsole() [3/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesRemoteConsole ( RemoteConsoleResultingCommandExecutor  executor)
inherited

Adds an executor to the current command builder.

Parameters
executorA lambda of type (RemoteConsoleResultingCommandExecutor, CommandArguments) -> int that will be executed when the command is run
Returns
this command builder

◆ executesRemoteConsole() [4/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesRemoteConsole ( RemoteConsoleResultingExecutionInfo  info)
inherited

Adds an executor to the current command builder.

Parameters
infoA lambda of type (ExecutionInfo) -> int that will be executed when the command is run
Returns
this command builder

◆ fromKey()

static< S > Function< S, String > dev.jorel.commandapi.arguments.SafeOverrideableArgument< T, S >.fromKey ( Function< S, NamespacedKey >  mapper)
static

Composes a S to a NamespacedKey mapping function to convert S to a String

Parameters
mapperthe mapping function from S to NamespacedKey
Returns
a composed function that converts S to String

◆ getArgumentPermission()

final CommandPermission dev.jorel.commandapi.arguments.AbstractArgument< T, Impl, Argument, CommandSender >.getArgumentPermission ( )
inherited

Returns the permission required to run this command.

Returns
the permission required to run this command

◆ getArgumentType()

abstract CommandAPIArgumentType dev.jorel.commandapi.arguments.AbstractArgument< T, Impl, Argument, CommandSender >.getArgumentType ( )
abstractinherited

Returns the argument type for this argument.

Returns
the argument type for this argument

◆ getCombinedArguments()

List< Argument > dev.jorel.commandapi.arguments.AbstractArgument< T, Impl, Argument, CommandSender >.getCombinedArguments ( )
inherited

Returns a list of arguments linked to this argument.

Returns
A list of arguments linked to this argument

◆ getEntityNames()

List< String > dev.jorel.commandapi.arguments.AbstractArgument< T, Impl, Argument, CommandSender >.getEntityNames ( Object  argument)
inherited

Gets a list of entity names for the current provided argument.

This is expected to be implemented by EntitySelectorArgument in Bukkit, see EntitySelectorArgument#getEntityNames(Object)

Parameters
argumenta parsed (Bukkit) object representing the entity selector type. This is either a List, an Entity or a Player
Returns
a list of strings representing the names of the entity or entities from argument

◆ getIncludedSuggestions()

Optional< ArgumentSuggestions< CommandSender > > dev.jorel.commandapi.arguments.AbstractArgument< T, Impl, Argument, CommandSender >.getIncludedSuggestions ( )
inherited

Returns an optional function which produces an array of suggestions which should be added to existing suggestions.

Returns
An Optional containing a function which generates suggestions

◆ getNodeName()

final String dev.jorel.commandapi.arguments.AbstractArgument< T, Impl, Argument, CommandSender >.getNodeName ( )
inherited

Returns the name of this argument's node.

Returns
the name of this argument's node

◆ getOverriddenSuggestions()

final Optional< ArgumentSuggestions< CommandSender > > dev.jorel.commandapi.arguments.AbstractArgument< T, Impl, Argument, CommandSender >.getOverriddenSuggestions ( )
inherited

Returns an optional function that maps the command sender to an IStringTooltip array of suggestions for the current command.

Returns
a function that provides suggestions, or Optional.empty() if there are no overridden suggestions.

◆ getPrimitiveType()

abstract Class< T > dev.jorel.commandapi.arguments.AbstractArgument< T, Impl, Argument, CommandSender >.getPrimitiveType ( )
abstractinherited

Returns the primitive type of the current Argument.

After executing a command, this argument should yield an object of this returned class.

Returns
the type that this argument yields when the command is run

◆ getRawType()

final ArgumentType<?> dev.jorel.commandapi.arguments.AbstractArgument< T, Impl, Argument, CommandSender >.getRawType ( )
inherited

Returns the NMS or brigadier type for this argument.

Returns
the NMS or brigadier type for this argument

◆ getRequirements()

final Predicate< CommandSender > dev.jorel.commandapi.arguments.AbstractArgument< T, Impl, Argument, CommandSender >.getRequirements ( )
inherited

Returns the requirements required to run this command.

Returns
the requirements required to run this command

◆ hasCombinedArguments()

boolean dev.jorel.commandapi.arguments.AbstractArgument< T, Impl, Argument, CommandSender >.hasCombinedArguments ( )
inherited

Returns true if this argument has linked arguments.

Returns
true if this argument has linked arguments

◆ includeSafeSuggestions()

default Impl dev.jorel.commandapi.arguments.SafeOverrideable< T, S, Impl, Argument, CommandSender >.includeSafeSuggestions ( SafeSuggestions< S, CommandSender >  suggestions)
inherited

Includes the suggestions provided with the existing suggestions for this argument.

Use the static methods in SafeSuggestions to create safe suggestions.

Parameters
suggestionsThe safe suggestions to use
Returns
the current argument

◆ includeSuggestions()

Impl dev.jorel.commandapi.arguments.AbstractArgument< T, Impl, Argument, CommandSender >.includeSuggestions ( ArgumentSuggestions< CommandSender >  suggestions)
inherited

Include suggestions to add to the list of default suggestions represented by this argument.

Parameters
suggestionsAn ArgumentSuggestions object representing the suggestions. Use the Static methods on ArgumentSuggestions to create these.
Returns
the current argument

◆ instance()

Argument< T > dev.jorel.commandapi.arguments.Argument< T >.instance ( )
inherited

Returns the instance of this class with the class Impl.

Used for chaining builder methods.

Implements dev.jorel.commandapi.ChainableBuilder< Impl >.

◆ isListed()

boolean dev.jorel.commandapi.arguments.AbstractArgument< T, Impl, Argument, CommandSender >.isListed ( )
inherited

Returns true if this argument will be listed in the Object args[] of the command executor.

Returns
true if this argument will be listed in the Object args[] of the command executor

◆ isOptional()

boolean dev.jorel.commandapi.arguments.AbstractArgument< T, Impl, Argument, CommandSender >.isOptional ( )
inherited

Returns true if this argument will be optional when executing the command this argument is included in.

Returns
true if this argument will be optional when executing the command this argument is included in

◆ parseArgument()

abstract< Source > T dev.jorel.commandapi.arguments.AbstractArgument< T, Impl, Argument, CommandSender >.parseArgument ( CommandContext< Source >  cmdCtx,
String  key,
CommandArguments  previousArgs 
) throws CommandSyntaxException
abstractinherited

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

Parameters
<Source>the command source type
cmdCtxthe context which ran this command
keythe name of the argument node
previousArgsa CommandArguments object holding previous parsed arguments
Returns
the parsed object represented by this argument
Exceptions
CommandSyntaxExceptionif parsing fails

◆ replaceSafeSuggestions()

default Impl dev.jorel.commandapi.arguments.SafeOverrideable< T, S, Impl, Argument, CommandSender >.replaceSafeSuggestions ( SafeSuggestions< S, CommandSender >  suggestions)
inherited

Replaces the suggestions with a safe SafeSuggestions object.

Use the static methods in SafeSuggestions to create safe suggestions.

Parameters
suggestionsThe safe suggestions to use
Returns
the current argument

◆ replaceSuggestions()

Impl dev.jorel.commandapi.arguments.AbstractArgument< T, Impl, Argument, CommandSender >.replaceSuggestions ( ArgumentSuggestions< CommandSender >  suggestions)
inherited

Replace the suggestions of this argument.

Parameters
suggestionsAn ArgumentSuggestions object representing the suggestions. Use the static methods in ArgumentSuggestions to create these.
Returns
the current argument

◆ setListed()

Impl dev.jorel.commandapi.arguments.AbstractArgument< T, Impl, Argument, CommandSender >.setListed ( boolean  listed)
inherited

Sets whether this argument will be listed in the Object args[] of the command executor.

Parameters
listedif true, this argument will be included in the Object args[] of the command executor
Returns
this current argument

◆ setOptional()

Impl dev.jorel.commandapi.arguments.AbstractArgument< T, Impl, Argument, CommandSender >.setOptional ( boolean  optional)
inherited

Sets whether this argument will be optional when executing the command this argument is included in.

Parameters
optionalif true, this argument will be optional when executing the command this argument is included in
Returns
this current argument

◆ withPermission() [1/2]

final Impl dev.jorel.commandapi.arguments.AbstractArgument< T, Impl, Argument, CommandSender >.withPermission ( CommandPermission  permission)
inherited

Assigns the given permission as a requirement to execute this command.

Parameters
permissionthe permission required to execute this command
Returns
this current argument

◆ withPermission() [2/2]

final Impl dev.jorel.commandapi.arguments.AbstractArgument< T, Impl, Argument, CommandSender >.withPermission ( String  permission)
inherited

Assigns the given permission as a requirement to execute this command.

Parameters
permissionthe permission required to execute this command
Returns
this current argument

◆ withRequirement()

final Impl dev.jorel.commandapi.arguments.AbstractArgument< T, Impl, Argument, CommandSender >.withRequirement ( Predicate< CommandSender >  requirement)
inherited

Adds a requirement that has to be satisfied to use this argument.

This method can be used multiple times and each use of this method will AND its requirement with the previously declared ones

Parameters
requirementthe predicate that must be satisfied to use this argument
Returns
this current argument