Class ChatComponentArgument

java.lang.Object

dev.jorel.commandapi.AbstractArgumentTree<Argument<net.kyori.adventure.text.Component>, Argument<?>, org.bukkit.command.CommandSender>

dev.jorel.commandapi.arguments.AbstractArgument<net.kyori.adventure.text.Component, Argument<net.kyori.adventure.text.Component>, Argument<?>, org.bukkit.command.CommandSender>

dev.jorel.commandapi.arguments.Argument<net.kyori.adventure.text.Component>

dev.jorel.commandapi.arguments.ChatComponentArgument

All Implemented Interfaces:

BukkitExecutable<Argument<net.kyori.adventure.text.Component>>, ChainableBuilder<Argument<net.kyori.adventure.text.Component>>, PlatformExecutable<Argument<net.kyori.adventure.text.Component>, org.bukkit.command.CommandSender>

public class ChatComponentArgument
extends Argument<net.kyori.adventure.text.Component>

An argument that represents raw JSON text

Since:

5.10

API Note:

Returns a Component 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
ChatComponentArgument(String nodeName)	Constructs a ChatComponent argument with a given node name.

Method Summary

Modifier and Type	Method	Description
Argument<net.kyori.adventure.text.Component>	clearExecutors()
CommandAPIArgumentType	getArgumentType()
CommandAPIExecutor<org.bukkit.command.CommandSender, AbstractCommandSender<? extends org.bukkit.command.CommandSender>>	getExecutor()
Class<net.kyori.adventure.text.Component>	getPrimitiveType()
<CommandSourceStack> net.kyori.adventure.text.Component	parseArgument(com.mojang.brigadier.context.CommandContext<CommandSourceStack> cmdCtx, String key, CommandArguments previousArgs)
void	setExecutor(CommandAPIExecutor<org.bukkit.command.CommandSender, AbstractCommandSender<? extends org.bukkit.command.CommandSender>> arg0)

Methods inherited from class Argument

instance

Methods inherited from class 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 AbstractArgumentTree

then, thenNested, thenNested

Methods inherited from class Object

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

Methods inherited from interface 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 PlatformExecutable

getExecutor

Field Details

executor

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

Constructor Details

ChatComponentArgument

public ChatComponentArgument(String nodeName)

Constructs a ChatComponent argument with a given node name. Represents raw JSON text, used in Book MetaData, Chat and other various areas of Minecraft

Parameters:

nodeName - the name of the node for argument

See Also:

• Raw JSON text

Method Details

getPrimitiveType

public Class<net.kyori.adventure.text.Component> getPrimitiveType()

Specified by:

getPrimitiveType in class AbstractArgument<net.kyori.adventure.text.Component, Argument<net.kyori.adventure.text.Component>, Argument<?>, org.bukkit.command.CommandSender>

getArgumentType

public CommandAPIArgumentType getArgumentType()

Specified by:

getArgumentType in class AbstractArgument<net.kyori.adventure.text.Component, Argument<net.kyori.adventure.text.Component>, Argument<?>, org.bukkit.command.CommandSender>

parseArgument

public <CommandSourceStack>
net.kyori.adventure.text.Component parseArgument(com.mojang.brigadier.context.CommandContext<CommandSourceStack> cmdCtx,
 String key,
 CommandArguments previousArgs)
                                          throws com.mojang.brigadier.exceptions.CommandSyntaxException

Specified by:

parseArgument in class AbstractArgument<net.kyori.adventure.text.Component, Argument<net.kyori.adventure.text.Component>, 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<net.kyori.adventure.text.Component> clearExecutors()