simple.api.queries

Class SimpleLocatableQuery<K extends SimpleIdentifiable & SimpleLocatable>

java.lang.Object

simple.api.ClientAccessor<C>

simple.api.queries.SimpleQuery<SimpleLocatableQuery<K>,K,ClientContext>

simple.api.queries.SimpleLocatableQuery<K>

All Implemented Interfaces:

java.lang.Iterable<K>

Direct Known Subclasses:

SimpleGraphicsObjects, SimpleProjectiles

public abstract class SimpleLocatableQuery<K extends SimpleIdentifiable & SimpleLocatable>
extends SimpleQuery<SimpleLocatableQuery<K>,K,ClientContext>

Field Summary

Fields inherited from class simple.api.ClientAccessor

ctx

Method Summary

Modifier and Type	Method and Description
SimpleLocatableQuery<K>	filter(int... ids) Will filter out all items whose id isn't one of the elements inside of the {ids} array
SimpleLocatableQuery<K>	filter(SimpleLocatable... locatables) Will filter out all items whose location doesn't match any of the locatable objects in the {locatables} array
SimpleLocatableQuery<K>	filter(WorldArea area) Will filter out all items who are not inside of the specified area
SimpleLocatableQuery<K>	filter(WorldPoint... points) Will filter out all items whose location are not one of those inside of the array {points}
SimpleLocatableQuery<K>	filterWithin(int distance) Will filter out all items not within specified distance to the local player
SimpleLocatableQuery<K>	filterWithin(WorldPoint worldPoint, int distance) Will filter out all items not within specified distance to said {worldPoint}
SimpleLocatableQuery<K>	nearest() Will sort the query by closest distance to our local player
SimpleLocatableQuery<K>	nearest(SimpleLocatable locatable) Will sort the query by closest distance to the location of said {locatable} object
SimpleLocatableQuery<K>	nearest(WorldPoint point) Will sort the query by closest distance to the specified worldpoint {point}
K	nextNearest() DO NOT USE!!!! Please refrain from using this method as it sorts the query every time you call it and rather use `.nearest().next()` Will sort the query by closest distance to the local player and return the `next#` method from the query

Methods inherited from class simple.api.queries.SimpleQuery

contains, filter, isEmpty, iterator, next, peekNext, populate, population, reverse, shuffle, size, sort, toStream

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

nextNearest

public K nextNearest()

DO NOT USE!!!! Please refrain from using this method as it sorts the query every time you call it and rather use `.nearest().next()` Will sort the query by closest distance to the local player and return the `next#` method from the query

Returns:

the closest item to our local player inside of our query

filter

public SimpleLocatableQuery<K> filter(int... ids)

Will filter out all items whose id isn't one of the elements inside of the {ids} array

Parameters:

ids - array of ids for our filter

Returns:

returns the query of only items whose id's match one of those inside of {ids}

nearest

public SimpleLocatableQuery<K> nearest()

Will sort the query by closest distance to our local player

Returns:

returns a sorted query by closest distance to our local player

nearest

public SimpleLocatableQuery<K> nearest(WorldPoint point)

Will sort the query by closest distance to the specified worldpoint {point}

Parameters:

point - world point to sort our query by

Returns:

returns a sorted query by closest distance to {point}

nearest

public SimpleLocatableQuery<K> nearest(SimpleLocatable locatable)

Will sort the query by closest distance to the location of said {locatable} object

Parameters:

locatable - locatable object to sort our query by

Returns:

returns a sorted query by closest distance to {locatable}

filter

public SimpleLocatableQuery<K> filter(SimpleLocatable... locatables)

Will filter out all items whose location doesn't match any of the locatable objects in the {locatables} array

Parameters:

locatables - array of locatable objects for our filter to check

Returns:

returns query of only items whose location are one of the locatable objects location inside of {locatables}

filter

public SimpleLocatableQuery<K> filter(WorldPoint... points)

Will filter out all items whose location are not one of those inside of the array {points}

Parameters:

points - array of worldpoints for our filter to check

Returns:

returns query of only items whose location are one of the worldpoints inside of {points}

filter

public SimpleLocatableQuery<K> filter(WorldArea area)

Will filter out all items who are not inside of the specified area

Parameters:

area - area for our filter to check

Returns:

returns query of only items inside of the specified area

filterWithin

public SimpleLocatableQuery<K> filterWithin(int distance)

Will filter out all items not within specified distance to the local player

Parameters:

distance - - radius to check around player

Returns:

returns all items within specified distance to the local player

filterWithin

public SimpleLocatableQuery<K> filterWithin(WorldPoint worldPoint,
                                            int distance)

Will filter out all items not within specified distance to said {worldPoint}

Parameters:

distance - - radius to check around {worldPoint}

worldPoint - - point to filter around

Returns:

returns all items within specified distance to said {worldPoint}