Package com.epicbot.api.shared.query

Class LocatableEntityQueryBuilder<T extends LocatableEntity,Q extends LocatableEntityQueryBuilder<T,Q,R,RQ>,R extends LocatableEntityQueryResult<T>,RQ extends LocatableEntityQueryRequest<T>>

java.lang.Object

com.epicbot.api.shared.query.AbstractQueryBuilder<T,Q,R,RQ>

com.epicbot.api.shared.query.RenderableQueryBuilder<T,Q,R,RQ>

com.epicbot.api.shared.query.LocatableEntityQueryBuilder<T,Q,R,RQ>

Direct Known Subclasses:

GameEntityQueryBuilder, ProjectileQueryBuilder

public abstract class LocatableEntityQueryBuilder<T extends LocatableEntity,Q extends LocatableEntityQueryBuilder<T,Q,R,RQ>,R extends LocatableEntityQueryResult<T>,RQ extends LocatableEntityQueryRequest<T>>
extends RenderableQueryBuilder<T,Q,R,RQ>

Field Summary

Fields inherited from class com.epicbot.api.shared.query.RenderableQueryBuilder

INVISIBLE_FILTER, VISIBLE_FILTER

Fields inherited from class com.epicbot.api.shared.query.AbstractQueryBuilder

ctx, request

Constructor Summary

Constructors

Constructor	Description
LocatableEntityQueryBuilder(APIContext ctx)

Method Summary

Modifier and Type	Method	Description
Q	distance(double maximum)
Q	distance(double minimum, double maximum)
Q	distance(Locatable other, double maximum)
Q	distance(Locatable other, double minimum, double maximum)
Q	id(int... ids)
Q	located(Locatable... locatables)	Checks if the entity is located on ONE of the given tiles.
Q	modelId(int... modelIds)
Q	notLocated(Locatable... locatables)	Checks if the entity is NOT located on ANY of the given tiles.
Q	notWithin(Area... areas)	Checks if the entity is NOT located in ANY of the given areas.
Q	reachable()
Q	reachableFrom(Locatable locatable)
R	results()
Q	unreachable()
Q	unreachableFrom(Locatable locatable)
Q	within(Area... areas)	Checks if the entity is located in ONE of the given areas.

Methods inherited from class com.epicbot.api.shared.query.RenderableQueryBuilder

contains, invisible, visible

Methods inherited from class com.epicbot.api.shared.query.AbstractQueryBuilder

accepts, asList, asSet, filter, getRequest, request

Methods inherited from class java.lang.Object

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

Constructor Detail

LocatableEntityQueryBuilder

public LocatableEntityQueryBuilder(APIContext ctx)

Method Detail

results

public R results()

Overrides:

results in class AbstractQueryBuilder<T extends LocatableEntity,Q extends LocatableEntityQueryBuilder<T,Q,R,RQ>,R extends LocatableEntityQueryResult<T>,RQ extends LocatableEntityQueryRequest<T>>

id

public Q id(int... ids)

modelId

public Q modelId(int... modelIds)

distance

public Q distance(double maximum)

distance

public Q distance(double minimum,
                  double maximum)

distance

public final Q distance(Locatable other,
                        double maximum)

distance

public final Q distance(Locatable other,
                        double minimum,
                        double maximum)

reachable

public Q reachable()

reachableFrom

public Q reachableFrom(Locatable locatable)

unreachable

public Q unreachable()

unreachableFrom

public Q unreachableFrom(Locatable locatable)

located

public final Q located(Locatable... locatables)

Checks if the entity is located on ONE of the given tiles.

Parameters:

locatables - the locatables

Returns:

this

notLocated

public final Q notLocated(Locatable... locatables)

Checks if the entity is NOT located on ANY of the given tiles.

Parameters:

locatables - the locatables

Returns:

this

within

public final Q within(Area... areas)

Checks if the entity is located in ONE of the given areas.

Parameters:

areas - the areas to check

Returns:

this

notWithin

public final Q notWithin(Area... areas)

Checks if the entity is NOT located in ANY of the given areas.

Parameters:

areas - the areas to check

Returns:

this