Package dev.jorel.commandapi.arguments

Class LocationArgument

java.lang.Object

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

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

dev.jorel.commandapi.arguments.Argument<org.bukkit.Location>

dev.jorel.commandapi.arguments.SafeOverrideableArgument<org.bukkit.Location,org.bukkit.Location>

dev.jorel.commandapi.arguments.LocationArgument

All Implemented Interfaces:

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

public class LocationArgument
extends SafeOverrideableArgument<org.bukkit.Location,org.bukkit.Location>

An argument that represents the Bukkit Location object

Since:

1.1

API Note:

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

Method Summary

Modifier and Type	Method	Description
Argument<org.bukkit.Location>	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<org.bukkit.Location>	getPrimitiveType()
<CommandSourceStack> org.bukkit.Location	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.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, 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.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 CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>> executor

Constructor Details

LocationArgument

public LocationArgument(String nodeName)

A Location argument. Represents Minecraft locations. Defaults to LocationType.PRECISE_POSITION

Parameters:

nodeName - the name of the node for this argument

LocationArgument

public LocationArgument(String nodeName,
 LocationType type)

A Location argument. Represents Minecraft locations

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

LocationArgument

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

A Location argument. Represents Minecraft locations

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<org.bukkit.Location> getPrimitiveType()

Specified by:

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

getArgumentType

public CommandAPIArgumentType getArgumentType()

Specified by:

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

parseArgument

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

Specified by:

parseArgument in class AbstractArgument<org.bukkit.Location,Argument<org.bukkit.Location>,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<org.bukkit.Location> clearExecutors()