Package dev.jorel.commandapi.arguments

Record Class EntitySelector

java.lang.Object

java.lang.Record

dev.jorel.commandapi.arguments.EntitySelector

public record EntitySelector(int maxResults, boolean includesEntities, EntitySelector.Order order, boolean selfSelector, String playerName, Predicate<org.bukkit.entity.Entity> entityCheck, UUID entityUUID, org.bukkit.entity.EntityType type)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EntitySelector.Order

Field Summary

Fields

Modifier and Type	Field	Description
static final EntitySelector.Order	ORDER_ARBITRARY
static final EntitySelector.Order	ORDER_FURTHEST
static final EntitySelector.Order	ORDER_NEAREST
static final EntitySelector.Order	ORDER_RANDOM

Constructor Summary

Constructors

Constructor	Description
EntitySelector(int maxResults, boolean includesEntities, EntitySelector.Order order, boolean selfSelector, String playerName, Predicate<org.bukkit.entity.Entity> entityCheck, UUID entityUUID, org.bukkit.entity.EntityType type)	Creates an instance of a EntitySelector record class.

Method Summary

Modifier and Type	Method	Description
Predicate<org.bukkit.entity.Entity>	entityCheck()	Returns the value of the entityCheck record component.
UUID	entityUUID()	Returns the value of the entityUUID record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<? extends org.bukkit.entity.Entity>	findEntities(MockCommandSource source)
List<org.bukkit.entity.Player>	findPlayers(MockCommandSource source)
final int	hashCode()	Returns a hash code value for this object.
boolean	includesEntities()	Returns the value of the includesEntities record component.
int	maxResults()	Returns the value of the maxResults record component.
EntitySelector.Order	order()	Returns the value of the order record component.
String	playerName()	Returns the value of the playerName record component.
boolean	selfSelector()	Returns the value of the selfSelector record component.
final String	toString()	Returns a string representation of this record class.
org.bukkit.entity.EntityType	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

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

Field Details

ORDER_ARBITRARY

public static final EntitySelector.Order ORDER_ARBITRARY

ORDER_NEAREST

public static final EntitySelector.Order ORDER_NEAREST

ORDER_FURTHEST

public static final EntitySelector.Order ORDER_FURTHEST

ORDER_RANDOM

public static final EntitySelector.Order ORDER_RANDOM

Constructor Details

EntitySelector

public EntitySelector(int maxResults,
 boolean includesEntities,
 EntitySelector.Order order,
 boolean selfSelector,
 String playerName,
 Predicate<org.bukkit.entity.Entity> entityCheck,
 UUID entityUUID,
 org.bukkit.entity.EntityType type)

Creates an instance of a EntitySelector record class.

Parameters:

maxResults - the value for the maxResults record component

includesEntities - the value for the includesEntities record component

order - the value for the order record component

selfSelector - the value for the selfSelector record component

playerName - the value for the playerName record component

entityCheck - the value for the entityCheck record component

entityUUID - the value for the entityUUID record component

type - the value for the type record component

Method Details

findEntities

public List<? extends org.bukkit.entity.Entity> findEntities(MockCommandSource source)

findPlayers

public List<org.bukkit.entity.Player> findPlayers(MockCommandSource source)

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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

maxResults

public int maxResults()

Returns the value of the maxResults record component.

Returns:

the value of the maxResults record component

includesEntities

public boolean includesEntities()

Returns the value of the includesEntities record component.

Returns:

the value of the includesEntities record component

order

public EntitySelector.Order order()

Returns the value of the order record component.

Returns:

the value of the order record component

selfSelector

public boolean selfSelector()

Returns the value of the selfSelector record component.

Returns:

the value of the selfSelector record component

playerName

public String playerName()

Returns the value of the playerName record component.

Returns:

the value of the playerName record component

entityCheck

public Predicate<org.bukkit.entity.Entity> entityCheck()

Returns the value of the entityCheck record component.

Returns:

the value of the entityCheck record component

entityUUID

public UUID entityUUID()

Returns the value of the entityUUID record component.

Returns:

the value of the entityUUID record component

type

public org.bukkit.entity.EntityType type()

Returns the value of the type record component.

Returns:

the value of the type record component