Package dev.jorel.commandapi.arguments

Class ChatArgument

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<net.md_5.bungee.api.chat.BaseComponent[]>

dev.jorel.commandapi.arguments.ChatArgument

All Implemented Interfaces:

GreedyArgument, Previewable<ChatArgument,net.md_5.bungee.api.chat.BaseComponent[]>, BukkitExecutable<Argument<net.md_5.bungee.api.chat.BaseComponent[]>>, ChainableBuilder<Argument<net.md_5.bungee.api.chat.BaseComponent[]>>, PlatformExecutable<Argument<net.md_5.bungee.api.chat.BaseComponent[]>,org.bukkit.command.CommandSender>

public class ChatArgument
extends Argument<net.md_5.bungee.api.chat.BaseComponent[]>
implements GreedyArgument, Previewable<ChatArgument,net.md_5.bungee.api.chat.BaseComponent[]>

An argument that represents chat with entity selectors

Since:

3.0

API Note:

Returns a BaseComponent[] 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
ChatArgument(String nodeName)	Constructs a Chat argument with a given node name.

Method Summary

Modifier and Type	Method	Description
Argument<net.md_5.bungee.api.chat.BaseComponent[]>	clearExecutors()
CommandAPIArgumentType	getArgumentType()
CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>>	getExecutor()
Optional<PreviewableFunction<net.md_5.bungee.api.chat.BaseComponent[]>>	getPreview()
Class<net.md_5.bungee.api.chat.BaseComponent[]>	getPrimitiveType()
boolean	isLegacy()
<CommandSourceStack> net.md_5.bungee.api.chat.BaseComponent[]	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)
ChatArgument	usePreview(boolean usePreview)
ChatArgument	withPreview(PreviewableFunction<net.md_5.bungee.api.chat.BaseComponent[]> preview)

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, replaceSuggestions, 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

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.md_5.bungee.api.chat.BaseComponent[]> getPrimitiveType()

Specified by:

getPrimitiveType in class AbstractArgument<net.md_5.bungee.api.chat.BaseComponent[],Argument<net.md_5.bungee.api.chat.BaseComponent[]>,Argument<?>,org.bukkit.command.CommandSender>

getArgumentType

public CommandAPIArgumentType getArgumentType()

Specified by:

getArgumentType in class AbstractArgument<net.md_5.bungee.api.chat.BaseComponent[],Argument<net.md_5.bungee.api.chat.BaseComponent[]>,Argument<?>,org.bukkit.command.CommandSender>

parseArgument

public <CommandSourceStack>
net.md_5.bungee.api.chat.BaseComponent[] 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.md_5.bungee.api.chat.BaseComponent[],Argument<net.md_5.bungee.api.chat.BaseComponent[]>,Argument<?>,org.bukkit.command.CommandSender>

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException

withPreview

public ChatArgument withPreview(PreviewableFunction<net.md_5.bungee.api.chat.BaseComponent[]> preview)

Specified by:

withPreview in interface Previewable<ChatArgument,net.md_5.bungee.api.chat.BaseComponent[]>

getPreview

public Optional<PreviewableFunction<net.md_5.bungee.api.chat.BaseComponent[]>> getPreview()

Specified by:

getPreview in interface Previewable<ChatArgument,net.md_5.bungee.api.chat.BaseComponent[]>

isLegacy

public boolean isLegacy()

Specified by:

isLegacy in interface Previewable<ChatArgument,net.md_5.bungee.api.chat.BaseComponent[]>

usePreview

public ChatArgument usePreview(boolean usePreview)

Specified by:

usePreview in interface Previewable<ChatArgument,net.md_5.bungee.api.chat.BaseComponent[]>

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.md_5.bungee.api.chat.BaseComponent[]> clearExecutors()