Module net.minestom.server

Package net.minestom.server.utils.entity

Class EntityFinder

java.lang.Object

net.minestom.server.utils.entity.EntityFinder

public class EntityFinder
extends Object

Represents a query which can be call to find one or multiple entities. It is based on the target selectors used in commands.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EntityFinder.EntitySort
static enum	EntityFinder.TargetSelector
static enum	EntityFinder.ToggleableType

Constructor Summary

Constructors

Constructor	Description
EntityFinder()

Method Summary

Modifier and Type	Method	Description
List<Entity>	find(CommandSender sender)
List<Entity>	find(@Nullable Instance instance, @Nullable Entity self)	Find a list of entities (could be empty) based on the conditions
@Nullable Entity	findFirstEntity(CommandSender sender)
@Nullable Entity	findFirstEntity(@Nullable Instance instance, @Nullable Entity self)
@Nullable Player	findFirstPlayer(CommandSender sender)
@Nullable Player	findFirstPlayer(@Nullable Instance instance, @Nullable Entity self)	Shortcut of find(Instance, Entity) to retrieve the first player element in the list.
EntityFinder	setConstantName(String constantName)
EntityFinder	setConstantUuid(UUID constantUuid)
EntityFinder	setDifference(float dx, float dy, float dz)
EntityFinder	setDistance(Range.Int distance)
EntityFinder	setEntity(EntityType entityType, EntityFinder.ToggleableType toggleableType)
EntityFinder	setEntitySort(EntityFinder.EntitySort entitySort)
EntityFinder	setGameMode(GameMode gameMode, EntityFinder.ToggleableType toggleableType)
EntityFinder	setLevel(Range.Int level)
EntityFinder	setLimit(int limit)
EntityFinder	setName(String name, EntityFinder.ToggleableType toggleableType)
EntityFinder	setStartPosition(Point startPosition)
EntityFinder	setTargetSelector(EntityFinder.TargetSelector targetSelector)
EntityFinder	setUuid(UUID uuid, EntityFinder.ToggleableType toggleableType)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EntityFinder

public EntityFinder()

Method Details

setTargetSelector

public EntityFinder setTargetSelector(EntityFinder.TargetSelector targetSelector)

setEntitySort

public EntityFinder setEntitySort(EntityFinder.EntitySort entitySort)

setStartPosition

public EntityFinder setStartPosition(Point startPosition)

setDistance

public EntityFinder setDistance(Range.Int distance)

setLimit

public EntityFinder setLimit(int limit)

setLevel

public EntityFinder setLevel(Range.Int level)

setEntity

public EntityFinder setEntity(EntityType entityType,
 EntityFinder.ToggleableType toggleableType)

setConstantName

public EntityFinder setConstantName(String constantName)

setConstantUuid

public EntityFinder setConstantUuid(UUID constantUuid)

setName

public EntityFinder setName(String name,
 EntityFinder.ToggleableType toggleableType)

setUuid

public EntityFinder setUuid(UUID uuid,
 EntityFinder.ToggleableType toggleableType)

setGameMode

public EntityFinder setGameMode(GameMode gameMode,
 EntityFinder.ToggleableType toggleableType)

setDifference

public EntityFinder setDifference(float dx,
 float dy,
 float dz)

find

public List<Entity> find(@Nullable
 @Nullable Instance instance,
 @Nullable
 @Nullable Entity self)

Find a list of entities (could be empty) based on the conditions

Parameters:

instance - the instance to search from, null if the query can be executed using global data (all online players)

self - the source of the query, null if not any

Returns:

all entities validating the conditions, can be empty

find

public List<Entity> find(CommandSender sender)

findFirstPlayer

@Nullable
public @Nullable Player findFirstPlayer(@Nullable
 @Nullable Instance instance,
 @Nullable
 @Nullable Entity self)

Shortcut of find(Instance, Entity) to retrieve the first player element in the list.

Returns:

the first player returned by find(Instance, Entity)

See Also:

• find(Instance, Entity)

findFirstPlayer

@Nullable
public @Nullable Player findFirstPlayer(CommandSender sender)

findFirstEntity

@Nullable
public @Nullable Entity findFirstEntity(@Nullable
 @Nullable Instance instance,
 @Nullable
 @Nullable Entity self)

findFirstEntity

@Nullable
public @Nullable Entity findFirstEntity(CommandSender sender)