Class Location2DArgument

java.lang.Object

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

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

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

dev.jorel.commandapi.arguments.SafeOverrideableArgument<Location2D, Location2D>

dev.jorel.commandapi.arguments.Location2DArgument

All Implemented Interfaces:

SafeOverrideable<Location2D, Location2D, Argument<Location2D>, Argument<?>, org.bukkit.command.CommandSender>, BukkitExecutable<Argument<Location2D>>, ChainableBuilder<Argument<Location2D>>, PlatformExecutable<Argument<Location2D>, org.bukkit.command.CommandSender>

public class Location2DArgument
extends SafeOverrideableArgument<Location2D, Location2D>

An argument that represents the Bukkit Location object in x and z directions

Since:

3.0

API Note:

Returns a Location2D 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
Location2DArgument(String nodeName)	A Location argument.
Location2DArgument(String nodeName, LocationType type)	A Location argument.
Location2DArgument(String nodeName, LocationType type, boolean centerPosition)	A Location argument.

Method Summary

Modifier and Type	Method	Description
Argument<Location2D>	clearExecutors()
CommandAPIArgumentType	getArgumentType()
CommandAPIExecutor<org.bukkit.command.CommandSender, AbstractCommandSender<? extends org.bukkit.command.CommandSender>>	getExecutor()
LocationType	getLocationType()	Returns whether this argument is LocationType.BLOCK_POSITION or LocationType.PRECISE_POSITION
Class<Location2D>	getPrimitiveType()
<CommandSourceStack> Location2D	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

Modifier and Type	Method	Description
static <S> Function<S,String>	fromKey(Function<S, org.bukkit.NamespacedKey> mapper)	Composes a S to a NamespacedKey mapping function to convert S to a String
Function<Location2D, String>	getMapper()

Methods inherited from class Argument

instance

Modifier and Type	Method	Description
Argument<Location2D>	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

Modifier and Type	Method	Description
default Argument<Location2D>	executes(CommandExecutionInfo executor, ExecutorType... types)	Adds an executor to the current command builder
default Argument<Location2D>	executes(CommandExecutor executor, ExecutorType... types)	Adds an executor to the current command builder
default Argument<Location2D>	executes(ResultingCommandExecutionInfo executor, ExecutorType... types)	Adds an executor to the current command builder
default Argument<Location2D>	executes(ResultingCommandExecutor executor, ExecutorType... types)	Adds an executor to the current command builder
default Argument<Location2D>	executesCommandBlock(CommandBlockCommandExecutor executor)	Adds an executor to the current command builder
default Argument<Location2D>	executesCommandBlock(CommandBlockExecutionInfo info)	Adds an executor to the current command builder
default Argument<Location2D>	executesCommandBlock(CommandBlockResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<Location2D>	executesCommandBlock(CommandBlockResultingExecutionInfo info)	Adds an executor to the current command builder
default Argument<Location2D>	executesConsole(ConsoleCommandExecutor executor)	Adds an executor to the current command builder
default Argument<Location2D>	executesConsole(ConsoleExecutionInfo info)	Adds an executor to the current command builder
default Argument<Location2D>	executesConsole(ConsoleResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<Location2D>	executesConsole(ConsoleResultingExecutionInfo info)	Adds an executor to the current command builder
default Argument<Location2D>	executesEntity(EntityCommandExecutor executor)	Adds an executor to the current command builder
default Argument<Location2D>	executesEntity(EntityExecutionInfo info)	Adds an executor to the current command builder
default Argument<Location2D>	executesEntity(EntityResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<Location2D>	executesEntity(EntityResultingExecutionInfo info)	Adds an executor to the current command builder
default Argument<Location2D>	executesFeedbackForwarding(FeedbackForwardingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<Location2D>	executesFeedbackForwarding(FeedbackForwardingExecutionInfo info)	Adds an executor to the current command builder
default Argument<Location2D>	executesFeedbackForwarding(FeedbackForwardingResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<Location2D>	executesFeedbackForwarding(FeedbackForwardingResultingExecutionInfo info)	Adds an executor to the current command builder
default Argument<Location2D>	executesNative(NativeCommandExecutor executor)	Adds an executor to the current command builder
default Argument<Location2D>	executesNative(NativeExecutionInfo info)	Adds an executor to the current command builder
default Argument<Location2D>	executesNative(NativeResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<Location2D>	executesNative(NativeResultingExecutionInfo info)	Adds an executor to the current command builder
default Argument<Location2D>	executesPlayer(PlayerCommandExecutor executor)	Adds an executor to the current command builder
default Argument<Location2D>	executesPlayer(PlayerExecutionInfo info)	Adds an executor to the current command builder
default Argument<Location2D>	executesPlayer(PlayerResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<Location2D>	executesPlayer(PlayerResultingExecutionInfo info)	Adds an executor to the current command builder
default Argument<Location2D>	executesProxy(ProxyCommandExecutor executor)	Adds an executor to the current command builder
default Argument<Location2D>	executesProxy(ProxyExecutionInfo info)	Adds an executor to the current command builder
default Argument<Location2D>	executesProxy(ProxyResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<Location2D>	executesProxy(ProxyResultingExecutionInfo info)	Adds an executor to the current command builder
default Argument<Location2D>	executesRemoteConsole(RemoteConsoleCommandExecutor executor)	Adds an executor to the current command builder
default Argument<Location2D>	executesRemoteConsole(RemoteConsoleExecutionInfo info)	Adds an executor to the current command builder
default Argument<Location2D>	executesRemoteConsole(RemoteConsoleResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<Location2D>	executesRemoteConsole(RemoteConsoleResultingExecutionInfo info)	Adds an executor to the current command builder

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

Location2DArgument

public Location2DArgument(String nodeName)

A Location argument. Represents Minecraft locations in 2D space. Defaults to LocationType.PRECISE_POSITION

Parameters:

nodeName - the name of the node for this argument

Location2DArgument

public Location2DArgument(String nodeName,
 LocationType type)

A Location argument. Represents Minecraft locations in 2D space

Parameters:

nodeName - the name of the node for this argument

type - the location type of this location, either LocationType.BLOCK_POSITION or LocationType.PRECISE_POSITION

Location2DArgument

public Location2DArgument(String nodeName,
 LocationType type,
 boolean centerPosition)

A Location argument. Represents Minecraft locations in 2D space

Parameters:

nodeName - the name of the node for this argument

type - the location type of this location, either LocationType.BLOCK_POSITION or LocationType.PRECISE_POSITION

centerPosition - whether LocationType.PRECISE_POSITION should center the position of the location within a block

Method Details

getLocationType

public LocationType getLocationType()

Returns whether this argument is LocationType.BLOCK_POSITION or LocationType.PRECISE_POSITION

Returns:

the location type of this argument

getPrimitiveType

public Class<Location2D> getPrimitiveType()

Specified by:

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

getArgumentType

public CommandAPIArgumentType getArgumentType()

Specified by:

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

parseArgument

public <CommandSourceStack> Location2D parseArgument(com.mojang.brigadier.context.CommandContext<CommandSourceStack> cmdCtx,
 String key,
 CommandArguments previousArgs)
                                              throws com.mojang.brigadier.exceptions.CommandSyntaxException

Specified by:

parseArgument in class AbstractArgument<Location2D, Argument<Location2D>, 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<Location2D> clearExecutors()