Class ArgumentEntity

java.lang.Object

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

net.minestom.server.command.builder.arguments.minecraft.ArgumentEntity

public class ArgumentEntity
extends Argument<EntityFinder>

Represents the target selector argument. https://minecraft.wiki/w/Target_selectors

Field Summary

Fields

Modifier and Type	Field	Description
static final int	INVALID_ARGUMENT_NAME
static final int	INVALID_ARGUMENT_VALUE
static final int	INVALID_SYNTAX
static final int	ONLY_PLAYERS_ERROR
static final int	ONLY_SINGLE_ENTITY_ERROR

Fields inherited from class Argument

allowSpace, suggestionType, useRemaining

Constructor Summary

Constructors

Constructor	Description
ArgumentEntity(String id)

Method Summary

Modifier and Type	Method	Description
boolean	isOnlyPlayers()
boolean	isOnlySingleEntity()
byte @Nullable []	nodeProperties()
ArgumentEntity	onlyPlayers(boolean onlyPlayers)
EntityFinder	parse(CommandSender sender, String input)	Parses the given input, and throw an ArgumentSyntaxException if the input cannot be converted to T
ArgumentParserType	parser()
ArgumentEntity	singleEntity(boolean singleEntity)
static EntityFinder	staticParse(CommandSender sender, String input, boolean onlySingleEntity, boolean onlyPlayers)	Deprecated. use Argument.parse(CommandSender, Argument)
String	toString()

Methods inherited from class Argument

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

Methods inherited from class Object

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

Field Details

INVALID_SYNTAX

public static final int INVALID_SYNTAX

See Also:

• Constant Field Values

ONLY_SINGLE_ENTITY_ERROR

public static final int ONLY_SINGLE_ENTITY_ERROR

See Also:

• Constant Field Values

ONLY_PLAYERS_ERROR

public static final int ONLY_PLAYERS_ERROR

See Also:

• Constant Field Values

INVALID_ARGUMENT_NAME

public static final int INVALID_ARGUMENT_NAME

See Also:

• Constant Field Values

INVALID_ARGUMENT_VALUE

public static final int INVALID_ARGUMENT_VALUE

See Also:

• Constant Field Values

Constructor Details

ArgumentEntity

public ArgumentEntity(String id)

Method Details

singleEntity

public ArgumentEntity singleEntity(boolean singleEntity)

onlyPlayers

public ArgumentEntity onlyPlayers(boolean onlyPlayers)

parse

public EntityFinder parse(CommandSender sender,
 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<EntityFinder>

Parameters:

input - the argument to parse

Returns:

the parsed argument

Throws:

ArgumentSyntaxException - if value is not valid

parser

public ArgumentParserType parser()

Specified by:

parser in class Argument<EntityFinder>

nodeProperties

public byte @Nullable [] nodeProperties()

Overrides:

nodeProperties in class Argument<EntityFinder>

staticParse

@Deprecated
public static EntityFinder staticParse(CommandSender sender,
 String input,
 boolean onlySingleEntity,
 boolean onlyPlayers)
                                throws ArgumentSyntaxException

Deprecated.

use Argument.parse(CommandSender, Argument)

Throws:

ArgumentSyntaxException

isOnlySingleEntity

public boolean isOnlySingleEntity()

isOnlyPlayers

public boolean isOnlyPlayers()

toString

public String toString()

Overrides:

toString in class Object