Package dev.jorel.commandapi.arguments

Class Argument<T>

java.lang.Object
dev.jorel.commandapi.ArgumentTree
dev.jorel.commandapi.arguments.Argument<T>
Type Parameters:
T - The type of the underlying object that this argument casts to
Direct Known Subclasses:
AdventureChatArgument, AdventureChatComponentArgument, BlockPredicateArgument, BlockStateArgument, ChatArgument, ChatComponentArgument, CustomArgument, EntitySelectorArgument, ItemStackPredicateArgument, ListArgument, LiteralArgument, MultiLiteralArgument, ObjectiveCriteriaArgument, SafeOverrideableArgument, ScoreHolderArgument, StringArgument, TextArgument
public abstract class Argument<T> extends ArgumentTree
The core abstract class for Command API arguments

  • Field Details

    • executor

      protected CustomCommandExecutor<?> executor
      The CustomCommandExecutor for this executable implementation

  • Constructor Details

    • Argument

      protected Argument(String nodeName, com.mojang.brigadier.arguments.ArgumentType<?> rawType)
      Constructs an argument with a given NMS/brigadier type.
      Parameters:
      nodeName - the name to assign to this argument node
      rawType - the NMS or brigadier type to be used for this argument

  • Method Details

    • getPrimitiveType

      public abstract Class<T> getPrimitiveType()
      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

    • getArgumentType

      public abstract CommandAPIArgumentType getArgumentType()
      Returns the argument type for this argument.
      Returns:
      the argument type for this argument

    • getRawType

      public final com.mojang.brigadier.arguments.ArgumentType<?> getRawType()
      Returns the NMS or brigadier type for this argument.
      Returns:
      the NMS or brigadier type for this argument

    • getNodeName

      public final String getNodeName()
      Returns the name of this argument's node
      Returns:
      the name of this argument's node

    • parseArgument

      public abstract <CommandSourceStack> T parseArgument(NMS<CommandSourceStack> nms, com.mojang.brigadier.context.CommandContext<CommandSourceStack> cmdCtx, String key, Object[] previousArgs) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      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
      Type Parameters:
      CommandSourceStack - 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

    • includeSuggestions

      public Argument<T> includeSuggestions(ArgumentSuggestions suggestions)
      Include suggestions to add to the list of default suggestions represented by this argument.
      Parameters:
      suggestions - An ArgumentSuggestions object representing the suggestions. Use the Static methods on ArgumentSuggestions to create these.
      Returns:
      the current argument

    • includeSuggestions

      @Deprecated(forRemoval=true) public Argument<T> includeSuggestions(Function<SuggestionInfo,String[]> suggestions)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use includeSuggestions(ArgumentSuggestions) instead
      Include suggestions to add to the list of default suggestions represented by this argument.
      Parameters:
      suggestions - a function that takes in SuggestionInfo which includes information about the current state at the time the suggestions are run and returns a String[] of suggestions to add
      Returns:
      the current argument

    • includeSuggestionsT

      @Deprecated(forRemoval=true) public Argument<T> includeSuggestionsT(Function<SuggestionInfo,IStringTooltip[]> suggestions)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use includeSuggestions(ArgumentSuggestions) instead
      Include suggestions to add to the list of default suggestions represented by this argument.
      Parameters:
      suggestions - a function that takes in SuggestionInfo which includes information about the current state at the time the suggestions are run and returns an IStringTooltip[] of suggestions (with tooltips) to add
      Returns:
      the current argument

    • getIncludedSuggestions

      public Optional<ArgumentSuggestions> getIncludedSuggestions()
      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

    • replaceSuggestions

      public Argument<T> replaceSuggestions(ArgumentSuggestions suggestions)
      Replace the suggestions of this argument.
      Parameters:
      suggestions - An ArgumentSuggestions object representing the suggestions. Use the static methods in ArgumentSuggestions to create these.
      Returns:
      the current argument

    • replaceSuggestions

      @Deprecated(forRemoval=true) public Argument<T> replaceSuggestions(Function<SuggestionInfo,String[]> suggestions)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use replaceSuggestions(ArgumentSuggestions) instead
      Replaces the suggestions of this argument with an array of suggestions.
      Parameters:
      suggestions - a function that takes in SuggestionInfo and returns a String of suggestions
      Returns:
      the current argument

    • replaceSuggestionsT

      @Deprecated(forRemoval=true) public Argument<T> replaceSuggestionsT(Function<SuggestionInfo,IStringTooltip[]> suggestions)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use replaceSuggestions(ArgumentSuggestions) instead
      Replaces the suggestions of this argument with an array of suggestions with tooltips.
      Parameters:
      suggestions - a function that takes in SuggestionInfo and returns a IStringTooltip of suggestions
      Returns:
      the current argument

    • getOverriddenSuggestions

      public final Optional<ArgumentSuggestions> getOverriddenSuggestions()
      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.

    • withPermission

      public final Argument<T> withPermission(CommandPermission permission)
      Assigns the given permission as a requirement to execute this command.
      Parameters:
      permission - the permission required to execute this command
      Returns:
      this current argument

    • withPermission

      public final Argument<T> withPermission(String permission)
      Assigns the given permission as a requirement to execute this command.
      Parameters:
      permission - the permission required to execute this command
      Returns:
      this current argument

    • getArgumentPermission

      public final CommandPermission getArgumentPermission()
      Returns the permission required to run this command
      Returns:
      the permission required to run this command

    • getRequirements

      public final Predicate<org.bukkit.command.CommandSender> getRequirements()
      Returns the requirements required to run this command
      Returns:
      the requirements required to run this command

    • withRequirement

      public final Argument<T> withRequirement(Predicate<org.bukkit.command.CommandSender> requirement)
      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:
      requirement - the predicate that must be satisfied to use this argument
      Returns:
      this current argument

    • isListed

      public boolean isListed()
      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

    • setListed

      public Argument<T> setListed(boolean listed)
      Sets whether this argument will be listed in the Object args[] of the command executor
      Parameters:
      listed - if true, this argument will be included in the Object args[] of the command executor
      Returns:
      this current argument

    • getEntityNames

      public List<String> getEntityNames(Object argument)
      Gets a list of entity names for the current provided argument. This is expected to be implemented by EntitySelectorArgument, see EntitySelectorArgument.getEntityNames(Object)
      Parameters:
      argument - a 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

    • 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