Class ChatColorArgument

java.lang.Object

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

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

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

dev.jorel.commandapi.arguments.SafeOverrideableArgument<net.kyori.adventure.text.format.NamedTextColor, net.kyori.adventure.text.format.NamedTextColor>

dev.jorel.commandapi.arguments.ChatColorArgument

All Implemented Interfaces:

SafeOverrideable<net.kyori.adventure.text.format.NamedTextColor, net.kyori.adventure.text.format.NamedTextColor, Argument<net.kyori.adventure.text.format.NamedTextColor>, Argument<?>, org.bukkit.command.CommandSender>, BukkitExecutable<Argument<net.kyori.adventure.text.format.NamedTextColor>>, ChainableBuilder<Argument<net.kyori.adventure.text.format.NamedTextColor>>, PlatformExecutable<Argument<net.kyori.adventure.text.format.NamedTextColor>, org.bukkit.command.CommandSender>

public class ChatColorArgument
extends SafeOverrideableArgument<net.kyori.adventure.text.format.NamedTextColor, net.kyori.adventure.text.format.NamedTextColor>

An argument that represents the Bukkit ChatColor object

Since:

1.1

API Note:

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

Method Summary

Modifier and Type	Method	Description
Argument<net.kyori.adventure.text.format.NamedTextColor>	clearExecutors()
CommandAPIArgumentType	getArgumentType()
CommandAPIExecutor<org.bukkit.command.CommandSender, AbstractCommandSender<? extends org.bukkit.command.CommandSender>>	getExecutor()
Class<net.kyori.adventure.text.format.NamedTextColor>	getPrimitiveType()
<CommandSourceStack> net.kyori.adventure.text.format.NamedTextColor	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 SafeOverrideableArgument

fromKey, getMapper

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

Methods inherited from interface SafeOverrideable

includeSafeSuggestions, includeSuggestions, replaceSafeSuggestions, replaceSuggestions

Field Details

executor

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

Constructor Details

ChatColorArgument

public ChatColorArgument(String nodeName)

Constructs a ChatColor argument with a given node name. Represents a color or formatting for chat

Parameters:

nodeName - the name of the node for argument

Method Details

getPrimitiveType

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

Specified by:

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

getArgumentType

public CommandAPIArgumentType getArgumentType()

Specified by:

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

parseArgument

public <CommandSourceStack>
net.kyori.adventure.text.format.NamedTextColor 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.format.NamedTextColor, Argument<net.kyori.adventure.text.format.NamedTextColor>, 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.format.NamedTextColor> clearExecutors()