Class ChatArgument

java.lang.Object
dev.jorel.commandapi.AbstractArgumentTree<dev.jorel.commandapi.arguments.Argument<net.kyori.adventure.chat.SignedMessage>, dev.jorel.commandapi.arguments.Argument<?>, org.bukkit.command.CommandSender>
dev.jorel.commandapi.arguments.AbstractArgument<net.kyori.adventure.chat.SignedMessage, dev.jorel.commandapi.arguments.Argument<net.kyori.adventure.chat.SignedMessage>, dev.jorel.commandapi.arguments.Argument<?>, org.bukkit.command.CommandSender>
dev.jorel.commandapi.arguments.Argument<net.kyori.adventure.chat.SignedMessage>
dev.jorel.commandapi.arguments.ChatArgument
All Implemented Interfaces:
dev.jorel.commandapi.arguments.GreedyArgument, dev.jorel.commandapi.BukkitExecutable<dev.jorel.commandapi.arguments.Argument<net.kyori.adventure.chat.SignedMessage>>, dev.jorel.commandapi.ChainableBuilder<dev.jorel.commandapi.arguments.Argument<net.kyori.adventure.chat.SignedMessage>>, dev.jorel.commandapi.PlatformExecutable<dev.jorel.commandapi.arguments.Argument<net.kyori.adventure.chat.SignedMessage>, org.bukkit.command.CommandSender>
public class ChatArgument extends dev.jorel.commandapi.arguments.Argument<net.kyori.adventure.chat.SignedMessage> implements dev.jorel.commandapi.arguments.GreedyArgument
An argument that represents chat with entity selectors
Since:
5.10
API Note:
Returns a SignedMessage object

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected dev.jorel.commandapi.CommandAPIExecutor<org.bukkit.command.CommandSender, dev.jorel.commandapi.commandsenders.AbstractCommandSender<? extends org.bukkit.command.CommandSender>>
    executor
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    ChatArgument(String nodeName)
    Constructs a Chat argument with a given node name.

  • Method Summary

    Modifier and Type
    Method
    Description
    dev.jorel.commandapi.arguments.Argument<net.kyori.adventure.chat.SignedMessage>
    clearExecutors()
     
    dev.jorel.commandapi.arguments.CommandAPIArgumentType
    getArgumentType()
     
    dev.jorel.commandapi.CommandAPIExecutor<org.bukkit.command.CommandSender, dev.jorel.commandapi.commandsenders.AbstractCommandSender<? extends org.bukkit.command.CommandSender>>
    getExecutor()
     
    Class<net.kyori.adventure.chat.SignedMessage>
    getPrimitiveType()
     
    <CommandSourceStack>
    net.kyori.adventure.chat.SignedMessage
    parseArgument(com.mojang.brigadier.context.CommandContext<CommandSourceStack> cmdCtx, String key, dev.jorel.commandapi.executors.CommandArguments previousArgs)
     
    void
    setExecutor(dev.jorel.commandapi.CommandAPIExecutor<org.bukkit.command.CommandSender, dev.jorel.commandapi.commandsenders.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, getHelpString, getIncludedSuggestions, getNodeName, getOverriddenSuggestions, getRawType, getRawTypeSupplier, getRequirements, hasCombinedArguments, includeSuggestions, isListed, isOptional, replaceSuggestions, setListed, setOptional, toString, withPermission, withPermission, withRequirement

    Methods inherited from class dev.jorel.commandapi.AbstractArgumentTree

    then, thenNested, thenNested

    Methods inherited from class 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, executesFeedbackForwarding, executesFeedbackForwarding, executesFeedbackForwarding, executesFeedbackForwarding, executesNative, executesNative, executesNative, executesNative, executesPlayer, executesPlayer, executesPlayer, executesPlayer, executesProxy, executesProxy, executesProxy, executesProxy, executesRemoteConsole, executesRemoteConsole, executesRemoteConsole, executesRemoteConsole

    Methods inherited from interface dev.jorel.commandapi.PlatformExecutable

    getExecutor

  • Field Details

    • executor

      protected dev.jorel.commandapi.CommandAPIExecutor<org.bukkit.command.CommandSender, dev.jorel.commandapi.commandsenders.AbstractCommandSender<? extends org.bukkit.command.CommandSender>> executor

  • Constructor Details

    • ChatArgument

      public ChatArgument(String nodeName)
      Constructs a Chat argument with a given node name. Represents fancy greedy strings that can parse entity selectors
      Parameters:
      nodeName - the name of the node for argument

  • Method Details

    • getPrimitiveType

      public Class<net.kyori.adventure.chat.SignedMessage> getPrimitiveType()
      Specified by:
      getPrimitiveType in class dev.jorel.commandapi.arguments.AbstractArgument<net.kyori.adventure.chat.SignedMessage, dev.jorel.commandapi.arguments.Argument<net.kyori.adventure.chat.SignedMessage>, dev.jorel.commandapi.arguments.Argument<?>, org.bukkit.command.CommandSender>

    • getArgumentType

      public dev.jorel.commandapi.arguments.CommandAPIArgumentType getArgumentType()
      Specified by:
      getArgumentType in class dev.jorel.commandapi.arguments.AbstractArgument<net.kyori.adventure.chat.SignedMessage, dev.jorel.commandapi.arguments.Argument<net.kyori.adventure.chat.SignedMessage>, dev.jorel.commandapi.arguments.Argument<?>, org.bukkit.command.CommandSender>

    • parseArgument

      public <CommandSourceStack> net.kyori.adventure.chat.SignedMessage parseArgument(com.mojang.brigadier.context.CommandContext<CommandSourceStack> cmdCtx, String key, dev.jorel.commandapi.executors.CommandArguments previousArgs) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      parseArgument in class dev.jorel.commandapi.arguments.AbstractArgument<net.kyori.adventure.chat.SignedMessage, dev.jorel.commandapi.arguments.Argument<net.kyori.adventure.chat.SignedMessage>, dev.jorel.commandapi.arguments.Argument<?>, org.bukkit.command.CommandSender>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getExecutor

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

    • setExecutor

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

    • clearExecutors

      public dev.jorel.commandapi.arguments.Argument<net.kyori.adventure.chat.SignedMessage> clearExecutors()