Package net.minestom.server.command.builder.arguments.relative

Class ArgumentRelativeBlockPosition

java.lang.Object

net.minestom.server.command.builder.arguments.Argument<RelativeVec>

net.minestom.server.command.builder.arguments.relative.ArgumentRelativeBlockPosition

public class ArgumentRelativeBlockPosition
extends Argument<RelativeVec>

Represents a block position with 3 integers (x;y;z) which can take relative coordinates.

Example: 5 ~ -3

Field Summary

Fields

Modifier and Type	Field	Description
static final int	INVALID_NUMBER_COUNT_ERROR
static final int	INVALID_NUMBER_ERROR
static final int	MIXED_TYPE_ERROR

Fields inherited from class net.minestom.server.command.builder.arguments.Argument

allowSpace, suggestionType, useRemaining

Constructor Summary

Constructors

Constructor	Description
ArgumentRelativeBlockPosition(@NotNull String id)

Method Summary

Modifier and Type	Method	Description
int	getNumberCount()	Gets the amount of numbers that this relative location needs.
@NotNull RelativeVec	parse(@NotNull CommandSender sender, @NotNull String input)	Parses the given input, and throw an ArgumentSyntaxException if the input cannot be converted to T
ArgumentParserType	parser()
String	toString()

Methods inherited from class net.minestom.server.command.builder.arguments.Argument

allowSpace, equals, filter, getCallback, getDefaultValue, getId, getSuggestionCallback, hasErrorCallback, hashCode, hasSuggestion, isOptional, map, map, nodeProperties, parse, setCallback, setDefaultValue, setDefaultValue, setDefaultValue, setSuggestionCallback, suggestionType, useRemaining

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

INVALID_NUMBER_COUNT_ERROR

public static final int INVALID_NUMBER_COUNT_ERROR

See Also:

• Constant Field Values

INVALID_NUMBER_ERROR

public static final int INVALID_NUMBER_ERROR

See Also:

• Constant Field Values

MIXED_TYPE_ERROR

public static final int MIXED_TYPE_ERROR

See Also:

• Constant Field Values

Constructor Details

ArgumentRelativeBlockPosition

public ArgumentRelativeBlockPosition(@NotNull
 @NotNull String id)

Method Details

parser

public ArgumentParserType parser()

Specified by:

parser in class Argument<RelativeVec>

toString

public String toString()

Overrides:

toString in class Object

parse

@NotNull
public @NotNull RelativeVec parse(@NotNull
 @NotNull CommandSender sender,
 @NotNull
 @NotNull String input)
                           throws ArgumentSyntaxException

Description copied from class: Argument

Parses the given input, and throw an ArgumentSyntaxException if the input cannot be converted to T

Specified by:

parse in class Argument<RelativeVec>

Parameters:

input - the argument to parse

Returns:

the parsed argument

Throws:

ArgumentSyntaxException - if value is not valid

getNumberCount

public int getNumberCount()

Gets the amount of numbers that this relative location needs.

Returns:

the amount of coordinate required