Class PlayerProfileArgument

java.lang.Object

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

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

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

dev.jorel.commandapi.arguments.SafeOverrideableArgument<List, com.destroystokyo.paper.profile.PlayerProfile>

dev.jorel.commandapi.arguments.PlayerProfileArgument

All Implemented Interfaces:

dev.jorel.commandapi.arguments.SafeOverrideable<List, com.destroystokyo.paper.profile.PlayerProfile, dev.jorel.commandapi.arguments.Argument<List>, dev.jorel.commandapi.arguments.Argument<?>, org.bukkit.command.CommandSender>, dev.jorel.commandapi.BukkitExecutable<dev.jorel.commandapi.arguments.Argument<List>>, dev.jorel.commandapi.ChainableBuilder<dev.jorel.commandapi.arguments.Argument<List>>, dev.jorel.commandapi.PlatformExecutable<dev.jorel.commandapi.arguments.Argument<List>, org.bukkit.command.CommandSender>

public class PlayerProfileArgument
extends dev.jorel.commandapi.arguments.SafeOverrideableArgument<List, com.destroystokyo.paper.profile.PlayerProfile>

An argument that represents the Paper PlayerProfile object.

Note that this Argument internally references Mojang's authentication servers to resolve usernames, which gives it a slight performance overhead compared to EntitySelectorArgument.OnePlayer.

Since:

11.0.0

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
PlayerProfileArgument(String nodeName)	A PlayerProfile argument.

Method Summary

Modifier and Type	Method	Description
dev.jorel.commandapi.arguments.Argument<List>	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<List>	getPrimitiveType()
<CommandSourceStack> List<com.destroystokyo.paper.profile.PlayerProfile>	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.SafeOverrideableArgument

fromKey, getMapper

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.ChainableBuilder

instance

Methods inherited from interface dev.jorel.commandapi.PlatformExecutable

getExecutor

Methods inherited from interface dev.jorel.commandapi.arguments.SafeOverrideable

includeSafeSuggestions, includeSuggestions, replaceSafeSuggestions, replaceSuggestions

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

PlayerProfileArgument

public PlayerProfileArgument(String nodeName)

A PlayerProfile argument. Returns a List<com.destroystokyo.paper.profile.PlayerProfile>

Parameters:

nodeName - the name of the node for this argument

Method Details

getPrimitiveType

public Class<List> getPrimitiveType()

Specified by:

getPrimitiveType in class dev.jorel.commandapi.arguments.AbstractArgument<List, dev.jorel.commandapi.arguments.Argument<List>, 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<List, dev.jorel.commandapi.arguments.Argument<List>, dev.jorel.commandapi.arguments.Argument<?>, org.bukkit.command.CommandSender>

parseArgument

public <CommandSourceStack>
List<com.destroystokyo.paper.profile.PlayerProfile> 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<List, dev.jorel.commandapi.arguments.Argument<List>, 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<List> clearExecutors()