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

Class ArgumentEntities

java.lang.Object

net.minestom.server.command.builder.arguments.Argument<java.util.ArrayList<Entity>>

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

public class ArgumentEntities
extends Argument<java.util.ArrayList<Entity>>

Represents the target selector argument. https://minecraft.gamepedia.com/Commands#Target_selectors

Field Summary

Fields

Modifier and Type	Field	Description
static int	INVALID_SYNTAX
static int	ONLY_PLAYERS_ERROR
static int	ONLY_SINGLE_ENTITY_ERROR

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

SUCCESS, UNDEFINED_ERROR

Constructor Summary

Constructors

Constructor	Description
ArgumentEntities(java.lang.String id)

Method Summary

Modifier and Type	Method	Description
int	getConditionResult(java.util.ArrayList<Entity> value)	Called after Argument.parse(String) meaning that value should already represent a valid representation of the input.
int	getCorrectionResult(java.lang.String value)	First method called to check the validity of an input.
boolean	isOnlyPlayers()
boolean	isOnlySingleEntity()
ArgumentEntities	onlyPlayers(boolean onlyPlayers)
java.util.ArrayList<Entity>	parse(java.lang.String value)	Called after Argument.getCorrectionResult(String) returned Argument.SUCCESS.
ArgumentEntities	singleEntity(boolean singleEntity)

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

allowSpace, getCallback, getId, hasErrorCallback, setCallback, useRemaining

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

Constructor Details

ArgumentEntities

public ArgumentEntities(java.lang.String id)

Method Details

singleEntity

public ArgumentEntities singleEntity(boolean singleEntity)

onlyPlayers

public ArgumentEntities onlyPlayers(boolean onlyPlayers)

getCorrectionResult

public int getCorrectionResult(@NotNull java.lang.String value)

Description copied from class: Argument

First method called to check the validity of an input.

If Argument.allowSpace() is enabled, the value will be incremented by the next word until it returns Argument.SUCCESS, meaning that you need to be sure to check the inexpensive operations first (eg the number of brackets, the first and last char, etc...).

Specified by:

getCorrectionResult in class Argument<java.util.ArrayList<Entity>>

Parameters:

value - The received argument

Returns:

the error code or Argument.SUCCESS

parse

@NotNull public java.util.ArrayList<Entity> parse(@NotNull java.lang.String value)

Description copied from class: Argument

Called after Argument.getCorrectionResult(String) returned Argument.SUCCESS.

The correction being correct means that value shouldn't be verified again, you can assume that no exception will occur when converting it to the correct type.

Specified by:

parse in class Argument<java.util.ArrayList<Entity>>

Parameters:

value - The correct argument which does not need to be verified again

Returns:

The parsed argument

getConditionResult

public int getConditionResult(@NotNull java.util.ArrayList<Entity> value)

Description copied from class: Argument

Called after Argument.parse(String) meaning that value should already represent a valid representation of the input.

The condition result has for goal to check the optional conditions that are user configurable (eg min/max values for a number, a specific material for an item, etc...).

Specified by:

getConditionResult in class Argument<java.util.ArrayList<Entity>>

Parameters:

value - The parsed argument

Returns:

the error code or Argument.SUCCESS

isOnlySingleEntity

public boolean isOnlySingleEntity()

isOnlyPlayers

public boolean isOnlyPlayers()