Package dev.jorel.commandapi.arguments

Class EntitySelectorArgument.ManyPlayers

java.lang.Object

dev.jorel.commandapi.AbstractArgumentTree<Argument<Collection>,Argument<?>,org.bukkit.command.CommandSender>

dev.jorel.commandapi.arguments.AbstractArgument<Collection,Argument<Collection>,Argument<?>,org.bukkit.command.CommandSender>

dev.jorel.commandapi.arguments.Argument<Collection>

dev.jorel.commandapi.arguments.EntitySelectorArgument.ManyPlayers

All Implemented Interfaces:

BukkitExecutable<Argument<Collection>>, ChainableBuilder<Argument<Collection>>, PlatformExecutable<Argument<Collection>,org.bukkit.command.CommandSender>

Enclosing class:

EntitySelectorArgument

public static class EntitySelectorArgument.ManyPlayers
extends Argument<Collection>

An argument that represents many players

API Note:

Returns a Collection<Player> 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
ManyPlayers(String nodeName)	An argument that represents many players
ManyPlayers(String nodeName, boolean allowEmpty)	An argument that represents many players

Method Summary

Modifier and Type	Method	Description
Argument<Collection>	clearExecutors()
CommandAPIArgumentType	getArgumentType()
List<String>	getEntityNames(Object argument)
CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>>	getExecutor()
Class<Collection>	getPrimitiveType()
<CommandSourceStack> Collection<org.bukkit.entity.Player>	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 dev.jorel.commandapi.arguments.Argument

instance

Methods inherited from class dev.jorel.commandapi.arguments.AbstractArgument

combineWith, copyPermissionsAndRequirements, getArgumentPermission, getCombinedArguments, getHelpString, 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, 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 CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>> executor

Constructor Details

ManyPlayers

public ManyPlayers(String nodeName)

An argument that represents many players

Parameters:

nodeName - the name of the node for this argument

ManyPlayers

public ManyPlayers(String nodeName,
 boolean allowEmpty)

An argument that represents many players

Parameters:

nodeName - the name of the node for this argument * @param allowEmpty whether this entity selector should allow no entities found, or should throw an error instead

Method Details

getPrimitiveType

public Class<Collection> getPrimitiveType()

Specified by:

getPrimitiveType in class AbstractArgument<Collection,Argument<Collection>,Argument<?>,org.bukkit.command.CommandSender>

getArgumentType

public CommandAPIArgumentType getArgumentType()

Specified by:

getArgumentType in class AbstractArgument<Collection,Argument<Collection>,Argument<?>,org.bukkit.command.CommandSender>

parseArgument

public <CommandSourceStack>
Collection<org.bukkit.entity.Player> parseArgument(com.mojang.brigadier.context.CommandContext<CommandSourceStack> cmdCtx,
 String key,
 CommandArguments previousArgs)
                                            throws com.mojang.brigadier.exceptions.CommandSyntaxException

Specified by:

parseArgument in class AbstractArgument<Collection,Argument<Collection>,Argument<?>,org.bukkit.command.CommandSender>

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException

getEntityNames

public List<String> getEntityNames(Object argument)

Overrides:

getEntityNames in class AbstractArgument<Collection,Argument<Collection>,Argument<?>,org.bukkit.command.CommandSender>

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<Collection> clearExecutors()