Package dev.jorel.commandapi.arguments

Class CommandArgument

java.lang.Object

dev.jorel.commandapi.AbstractArgumentTree<Impl,Argument,CommandSender>

dev.jorel.commandapi.arguments.AbstractArgument<T,Argument<T>,Argument<?>,org.bukkit.command.CommandSender>

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

dev.jorel.commandapi.arguments.CommandArgument

All Implemented Interfaces:

GreedyArgument, BukkitExecutable<Argument<CommandResult>>, ChainableBuilder<Argument<CommandResult>>, PlatformExecutable<Argument<CommandResult>,org.bukkit.command.CommandSender>

public class CommandArgument
extends Argument<CommandResult>
implements GreedyArgument

An argument that represents a command. This allows users to enter the name and arguments of any other command as an argument to this command.

Since:

8.6.0

API Note:

Returns a CommandResult object

Field Summary

Fields

Modifier and Type	Field	Description
protected CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>>	executor

Constructor Summary

Constructors

Constructor	Description
CommandArgument(String nodeName)	Constructs a CommandArgument with the given node name.

Method Summary

Modifier and Type	Method	Description
final Argument<CommandResult>	branchSuggestions(SuggestionsBranch<org.bukkit.command.CommandSender>... branches)	Adds SuggestionsBranch to this CommandArgument.
Argument<CommandResult>	clearExecutors()
CommandAPIArgumentType	getArgumentType()
CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>>	getExecutor()
Class<CommandResult>	getPrimitiveType()
<CommandSourceStack> CommandResult	parseArgument(com.mojang.brigadier.context.CommandContext<CommandSourceStack> cmdCtx, String key, CommandArguments previousArgs)
CommandArgument	replaceSuggestions(ArgumentSuggestions<org.bukkit.command.CommandSender> suggestions)	Replaces the default command suggestions provided by the server with custom suggestions for each argument in the command, starting with the command's name.
final CommandArgument	replaceSuggestions(ArgumentSuggestions<org.bukkit.command.CommandSender>... suggestions)	Replaces the default command suggestions provided by the server with custom suggestions for each argument in the command, starting with the command's name.
void	setExecutor(CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>> arg0)

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

instance

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

combineWith, copyPermissionsAndRequirements, getArgumentPermission, getCombinedArguments, getEntityNames, getIncludedSuggestions, getNodeName, getOverriddenSuggestions, getRawType, getRequirements, hasCombinedArguments, includeSuggestions, isListed, isOptional, setListed, setOptional, toString, withPermission, withPermission, withRequirement

Methods inherited from class dev.jorel.commandapi.AbstractArgumentTree

then

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.jorel.commandapi.BukkitExecutable

executes, executes, executes, executes, executesCommandBlock, executesCommandBlock, executesCommandBlock, executesCommandBlock, executesConsole, executesConsole, executesConsole, executesConsole, executesEntity, executesEntity, executesEntity, executesEntity, executesNative, executesNative, executesNative, executesNative, executesPlayer, executesPlayer, executesPlayer, executesPlayer, executesProxy, executesProxy, executesProxy, executesProxy

Methods inherited from interface dev.jorel.commandapi.PlatformExecutable

getExecutor

Field Details

executor

protected CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>> executor

Constructor Details

CommandArgument

public CommandArgument(String nodeName)

Constructs a CommandArgument with the given node name.

Parameters:

nodeName - the name of the node for this argument

Method Details

replaceSuggestions

@SafeVarargs
public final CommandArgument replaceSuggestions(ArgumentSuggestions<org.bukkit.command.CommandSender>... suggestions)

Replaces the default command suggestions provided by the server with custom suggestions for each argument in the command, starting with the command's name. If a suggestion is null or there isn't any suggestions given for that argument, the suggestions will not be overridden.

Parameters:

suggestions - An array of ArgumentSuggestions representing the suggestions. Use the static methods in ArgumentSuggestions to create these.

Returns:

the current argument

replaceSuggestions

public CommandArgument replaceSuggestions(ArgumentSuggestions<org.bukkit.command.CommandSender> suggestions)

Replaces the default command suggestions provided by the server with custom suggestions for each argument in the command, starting with the command's name. If a suggestion is null or there isn't any suggestions given for that argument, the suggestions will not be overridden.

Overrides:

replaceSuggestions in class AbstractArgument<CommandResult,Argument<CommandResult>,Argument<?>,org.bukkit.command.CommandSender>

Parameters:

suggestions - An array of ArgumentSuggestions representing the suggestions. Use the static methods in ArgumentSuggestions to create these.

Returns:

the current argument

branchSuggestions

@SafeVarargs
public final Argument<CommandResult> branchSuggestions(SuggestionsBranch<org.bukkit.command.CommandSender>... branches)

Adds SuggestionsBranch to this CommandArgument. After going through the suggestions provided by replaceSuggestions(ArgumentSuggestions...) the suggestions of these branches will be used.

Parameters:

branches - An array of SuggestionsBranch representing the branching suggestions. Use SuggestionsBranch.suggest(ArgumentSuggestions...) to start creating these.

Returns:

the current argument

getPrimitiveType

public Class<CommandResult> getPrimitiveType()

Specified by:

getPrimitiveType in class AbstractArgument<CommandResult,Argument<CommandResult>,Argument<?>,org.bukkit.command.CommandSender>

getArgumentType

public CommandAPIArgumentType getArgumentType()

Specified by:

getArgumentType in class AbstractArgument<CommandResult,Argument<CommandResult>,Argument<?>,org.bukkit.command.CommandSender>

parseArgument

public <CommandSourceStack> CommandResult parseArgument(com.mojang.brigadier.context.CommandContext<CommandSourceStack> cmdCtx,
 String key,
 CommandArguments previousArgs)
                                                 throws com.mojang.brigadier.exceptions.CommandSyntaxException

Specified by:

parseArgument in class AbstractArgument<CommandResult,Argument<CommandResult>,Argument<?>,org.bukkit.command.CommandSender>

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException

getExecutor

public CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>> getExecutor()

setExecutor

public void setExecutor(CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>> arg0)

clearExecutors

public Argument<CommandResult> clearExecutors()