Package dev.jorel.commandapi.arguments

Record Class EntitySelectorArgumentType

java.lang.Object

java.lang.Record

dev.jorel.commandapi.arguments.EntitySelectorArgumentType

All Implemented Interfaces:

com.mojang.brigadier.arguments.ArgumentType<EntitySelector>

public record EntitySelectorArgumentType(boolean singleTarget, boolean playersOnly)
extends Record
implements com.mojang.brigadier.arguments.ArgumentType<EntitySelector>

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.brigadier.exceptions.SimpleCommandExceptionType	ERROR_NOT_SINGLE_ENTITY
static final com.mojang.brigadier.exceptions.SimpleCommandExceptionType	ERROR_NOT_SINGLE_PLAYER
static final com.mojang.brigadier.exceptions.SimpleCommandExceptionType	ERROR_ONLY_PLAYERS_ALLOWED
static final com.mojang.brigadier.exceptions.SimpleCommandExceptionType	NO_ENTITIES_FOUND
static final com.mojang.brigadier.exceptions.SimpleCommandExceptionType	NO_PLAYERS_FOUND

Constructor Summary

Constructors

Constructor	Description
EntitySelectorArgumentType(boolean singleTarget, boolean playersOnly)	Creates an instance of a EntitySelectorArgumentType record class.

Method Summary

Modifier and Type	Method	Description
static EntitySelectorArgumentType	entities()
static EntitySelectorArgumentType	entity()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static List<? extends org.bukkit.entity.Entity>	findManyEntities(com.mojang.brigadier.context.CommandContext<MockCommandSource> cmdCtx, String key, boolean allowEmpty)
static List<org.bukkit.entity.Player>	findManyPlayers(com.mojang.brigadier.context.CommandContext<MockCommandSource> cmdCtx, String key, boolean allowEmpty)
static org.bukkit.entity.Entity	findSingleEntity(com.mojang.brigadier.context.CommandContext<MockCommandSource> cmdCtx, String key)
static org.bukkit.entity.Player	findSinglePlayer(com.mojang.brigadier.context.CommandContext<MockCommandSource> cmdCtx, String key)
final int	hashCode()	Returns a hash code value for this object.
<S> CompletableFuture<com.mojang.brigadier.suggestion.Suggestions>	listSuggestions(com.mojang.brigadier.context.CommandContext<S> context, com.mojang.brigadier.suggestion.SuggestionsBuilder builder)
EntitySelector	parse(com.mojang.brigadier.StringReader reader)
static EntitySelectorArgumentType	player()
static EntitySelectorArgumentType	players()
boolean	playersOnly()	Returns the value of the playersOnly record component.
boolean	singleTarget()	Returns the value of the singleTarget record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mojang.brigadier.arguments.ArgumentType

getExamples

Field Details

ERROR_NOT_SINGLE_ENTITY

public static final com.mojang.brigadier.exceptions.SimpleCommandExceptionType ERROR_NOT_SINGLE_ENTITY

ERROR_NOT_SINGLE_PLAYER

public static final com.mojang.brigadier.exceptions.SimpleCommandExceptionType ERROR_NOT_SINGLE_PLAYER

ERROR_ONLY_PLAYERS_ALLOWED

public static final com.mojang.brigadier.exceptions.SimpleCommandExceptionType ERROR_ONLY_PLAYERS_ALLOWED

NO_ENTITIES_FOUND

public static final com.mojang.brigadier.exceptions.SimpleCommandExceptionType NO_ENTITIES_FOUND

NO_PLAYERS_FOUND

public static final com.mojang.brigadier.exceptions.SimpleCommandExceptionType NO_PLAYERS_FOUND

Constructor Details

EntitySelectorArgumentType

public EntitySelectorArgumentType(boolean singleTarget,
 boolean playersOnly)

Creates an instance of a EntitySelectorArgumentType record class.

Parameters:

singleTarget - the value for the singleTarget record component

playersOnly - the value for the playersOnly record component

Method Details

entities

public static EntitySelectorArgumentType entities()

players

public static EntitySelectorArgumentType players()

entity

public static EntitySelectorArgumentType entity()

player

public static EntitySelectorArgumentType player()

parse

public EntitySelector parse(com.mojang.brigadier.StringReader reader)
                     throws com.mojang.brigadier.exceptions.CommandSyntaxException

Specified by:

parse in interface com.mojang.brigadier.arguments.ArgumentType<EntitySelector>

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException

listSuggestions

public <S>
CompletableFuture<com.mojang.brigadier.suggestion.Suggestions> listSuggestions(com.mojang.brigadier.context.CommandContext<S> context,
 com.mojang.brigadier.suggestion.SuggestionsBuilder builder)

Specified by:

listSuggestions in interface com.mojang.brigadier.arguments.ArgumentType<EntitySelector>

findManyEntities

public static List<? extends org.bukkit.entity.Entity> findManyEntities(com.mojang.brigadier.context.CommandContext<MockCommandSource> cmdCtx,
 String key,
 boolean allowEmpty)
                                                                 throws com.mojang.brigadier.exceptions.CommandSyntaxException

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException

findManyPlayers

public static List<org.bukkit.entity.Player> findManyPlayers(com.mojang.brigadier.context.CommandContext<MockCommandSource> cmdCtx,
 String key,
 boolean allowEmpty)
                                                      throws com.mojang.brigadier.exceptions.CommandSyntaxException

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException

findSingleEntity

public static org.bukkit.entity.Entity findSingleEntity(com.mojang.brigadier.context.CommandContext<MockCommandSource> cmdCtx,
 String key)
                                                 throws com.mojang.brigadier.exceptions.CommandSyntaxException

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException

findSinglePlayer

public static org.bukkit.entity.Player findSinglePlayer(com.mojang.brigadier.context.CommandContext<MockCommandSource> cmdCtx,
 String key)
                                                 throws com.mojang.brigadier.exceptions.CommandSyntaxException

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

singleTarget

public boolean singleTarget()

Returns the value of the singleTarget record component.

Returns:

the value of the singleTarget record component

playersOnly

public boolean playersOnly()

Returns the value of the playersOnly record component.

Returns:

the value of the playersOnly record component