Package com.epicbot.api.shared.methods

Interface IObjectsAPI

public interface IObjectsAPI

Field Summary

Fields

Modifier and Type	Field	Description
static final Predicate<SceneObject>	ACCEPT_ALL
static final int	DEFAULT_QUERY_RADIUS	The default radius/distance used in getAll(int, Predicate).
static final Predicate<SceneObject>	DENY_ALL

Method Summary

Modifier and Type	Method	Description
List<SceneObject>	getAll()	Gets all objects in the current scene.
List<SceneObject>	getAll(int range, Predicate<SceneObject> filter)	Gets all objects within a certain range matching the given filter.
List<SceneObject>	getAll(SceneObjectQueryRequest request)
List<SceneObject>	getAll(Predicate<SceneObject> filter)	Gets all objects matching the given filter.
List<SceneObject>	getAt(Locatable locatable)	Gets all objects at at the given location.
List<SceneObject>	getAt(Locatable locatable, int mask)	Gets all objects at at the given location.
List<SceneObject>	getAt(Locatable locatable, int mask, Predicate<SceneObject> filter)	Gets all objects at the given location matching the given filter.
List<SceneObject>	getAt(Locatable locatable, Predicate<SceneObject> filter)	Gets all objects at the given location matching the given filter.
SceneObject	getTopAt(Locatable locatable)	Gets the top object at the given location.
SceneObject	getTopAt(Locatable locatable, Predicate<SceneObject> filter)	Gets the top object at the given location matching the given filter.
SceneObjectQueryBuilder	query()

Field Details

ACCEPT_ALL

static final Predicate<SceneObject> ACCEPT_ALL

DENY_ALL

static final Predicate<SceneObject> DENY_ALL

DEFAULT_QUERY_RADIUS

static final int DEFAULT_QUERY_RADIUS

The default radius/distance used in getAll(int, Predicate).

See Also:

• Constant Field Values

Method Details

getAll

List<SceneObject> getAll()

Gets all objects in the current scene.

Returns:

list of objects

getAll

List<SceneObject> getAll(Predicate<SceneObject> filter)

Gets all objects matching the given filter.

Parameters:

filter - the filter

Returns:

list of objects

getAll

List<SceneObject> getAll(int range,
 Predicate<SceneObject> filter)

Gets all objects within a certain range matching the given filter.

Parameters:

range - the radius, defaults to 26

filter - the filter

Returns:

list of objects

getAll

List<SceneObject> getAll(SceneObjectQueryRequest request)

getAt

List<SceneObject> getAt(Locatable locatable)

Gets all objects at at the given location.

Parameters:

locatable - the location

Returns:

list of objects

getAt

List<SceneObject> getAt(Locatable locatable,
 Predicate<SceneObject> filter)

Gets all objects at the given location matching the given filter.

Parameters:

locatable - the location

filter - the filter

Returns:

list of objects

getAt

List<SceneObject> getAt(Locatable locatable,
 int mask)

Gets all objects at at the given location.

Parameters:

locatable - the location

mask - the type flags or -1

Returns:

list of objects

getAt

List<SceneObject> getAt(Locatable locatable,
 int mask,
 Predicate<SceneObject> filter)

Gets all objects at the given location matching the given filter.

Parameters:

locatable - the location

mask - the type flags or -1

filter - the filter

Returns:

list of objects

getTopAt

SceneObject getTopAt(Locatable locatable)

Gets the top object at the given location.

Parameters:

locatable - the location

Returns:

the top object or null

getTopAt

SceneObject getTopAt(Locatable locatable,
 Predicate<SceneObject> filter)

Gets the top object at the given location matching the given filter.

Parameters:

locatable - the location

filter - the filter

Returns:

the top object or null

query

SceneObjectQueryBuilder query()