Package com.epicbot.api.shared.query.result

Class LocatableEntityQueryResult<T extends LocatableEntity>

java.lang.Object

com.epicbot.api.shared.query.result.QueryResult<T>

com.epicbot.api.shared.query.result.LocatableEntityQueryResult<T>

All Implemented Interfaces:

Iterable<T>, Collection<T>

public class LocatableEntityQueryResult<T extends LocatableEntity>
extends QueryResult<T>

Field Summary

Fields inherited from class com.epicbot.api.shared.query.result.QueryResult

ctx

Constructor Summary

Constructors

Constructor	Description
LocatableEntityQueryResult(List<T> objects, APIContext ctx, DistanceFunction distanceFunction)

Method Summary

Modifier and Type	Method	Description
LocatableEntityQueryResult<T>	chebyshev()	Sets the distance function to Chebyshev, which is the same as tile distance.
LocatableEntityQueryResult<T>	euclidean()	Sets the distance function to Euclidean, which is the straight-line distance between two points.
T	nearest()
T	nearest(double near, double diff)	Get the nearest entity with allowed variation.
List<T>	nearestList()
T	nearestTo(Locatable locatable)
T	nearestTo(Locatable locatable, double near, double diff)	Gets the nearest entity with allowed variation.
LocatableEntityQueryResult<T>	sort(Tile tile)

Methods inherited from class com.epicbot.api.shared.query.result.QueryResult

add, addAll, clear, contains, containsAll, first, get, isEmpty, iterator, last, limit, limit, random, remove, removeAll, retainAll, reverse, shuffle, size, sort, toArray, toArray, toList

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Constructor Details

LocatableEntityQueryResult

public LocatableEntityQueryResult(List<T> objects,
 APIContext ctx,
 DistanceFunction distanceFunction)

Method Details

chebyshev

public LocatableEntityQueryResult<T> chebyshev()

Sets the distance function to Chebyshev, which is the same as tile distance.

Returns:

this

See Also:

• ICalculationsAPI.tileDistanceBetween(Locatable, Locatable)

euclidean

public LocatableEntityQueryResult<T> euclidean()

Sets the distance function to Euclidean, which is the straight-line distance between two points.

Returns:

this

See Also:

• ICalculationsAPI.distanceBetween(Locatable, Locatable)

nearest

public T nearest()

nearest

public T nearest(double near,
 double diff)

Get the nearest entity with allowed variation.

Parameters:

near - the minimum distance before variation is considered (e.g. when near is 5 and diff is 1, an object with distance 6 is allowed)

diff - the allowed difference between closest and current object being considered

Returns:

nearestTo

public T nearestTo(Locatable locatable)

nearestTo

public T nearestTo(Locatable locatable,
 double near,
 double diff)

Gets the nearest entity with allowed variation.

Parameters:

near - the minimum distance before variation is considered (e.g. when near is 5 and diff is 1, an object with distance 6 is allowed)

diff - the allowed difference between closest and current object being considered

Returns:

the nearest entity with allowed variation

nearestList

public List<T> nearestList()

sort

public LocatableEntityQueryResult<T> sort(Tile tile)