org.osbot.rs07.api

Class EntityAPI<E extends Entity>

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.API

org.osbot.rs07.api.CollectionAPI<E>

org.osbot.rs07.api.filter.FilterAPI<E>

org.osbot.rs07.api.EntityAPI<E>

Direct Known Subclasses:

GroundItems, NPCS, Objects, Players

public abstract class EntityAPI<E extends Entity>
extends FilterAPI<E>

Represents a utility class for each of its four implementations.

Field Summary

Fields inherited from class org.osbot.rs07.script.MethodProvider

bank, bot, camera, chatbox, client, colorPicker, combat, configs, depositBox, dialogues, diaries, display, doorHandler, equipment, experienceTracker, favour, grandExchange, graphicObjects, groundItems, hintArrow, inventory, keyboard, logger, logoutTab, magic, map, menu, mouse, npcs, objects, players, prayer, projectiles, quests, settings, skills, store, tabs, trade, walking, widgets, worlds

Constructor Summary

Constructors

Constructor and Description
EntityAPI()

Method Summary

Modifier and Type	Method and Description
E	closest(Area area, int... ids) Gets the closest entity with the specified entity ids contained in the specified area.
E	closest(Area area, java.lang.String... names) Gets the closest entity with the specified entity names contained in the specified area.
E	closest(boolean realDistance, java.util.Collection<E> entities) Gets the closest entity from a collection of entities.
E	closest(boolean realDistance, java.util.Collection<E> entities, int distanceTolerance) Gets the closest entity from a collection of entities.
E	closest(boolean realDistance, Filter<E>... filters) Gets the closest generically specified Entity by using either the Pythagoras algorithm or real distance.
E	closest(boolean realDistance, int... ids) Gets the closest generically specified Entity that matches any of the given ids by using either the Pythagoras algorithm or real distance.
E	closest(boolean realDistance, java.lang.String... names) Gets the closest generically specified Entity that matches any of the given names by either using the Pythagoras algorithm or real distance.
E	closest(java.util.Collection<E> entities) Gets the closest entity from a collection of entities.
E	closest(Filter<E>... filters) Gets the closest generically specified Entity by using the Pythagoras algorithm.
E	closest(int... ids) Gets the closest generically specified Entity that matches any of the given ids by using the Pythagoras algorithm.
E	closest(java.lang.String... names) Gets the closest generically specified Entity that matches any of the given names by using the Pythagoras algorithm.
E	closestThatContains(boolean realDistance, java.lang.String... strings) Gets the closest generically specified Entity that contains any of the specified strings in its name by using either the Pythagoras algorithm or real distance.
E	closestThatContains(java.lang.String... strings) Gets the closest generically specified Entity that contains any of the specified strings in its name by using the Pythagoras algorithm.
abstract java.util.List<E>	get(int x, int y) Gets a list of entities on the specified x and y coordinates on the plane of your current player.
java.util.Iterator<E>	iterator() Returns the iterator to loop through the collection of entities.

Methods inherited from class org.osbot.rs07.api.filter.FilterAPI

filter, filter, singleFilter

Methods inherited from class org.osbot.rs07.api.CollectionAPI

getAll

Methods inherited from class org.osbot.rs07.script.API

initializeModule

Methods inherited from class org.osbot.rs07.script.MethodProvider

exchangeContext, execute, getBank, getBot, getCamera, getChatbox, getClient, getColorPicker, getCombat, getConfigs, getDepositBox, getDialogues, getDiaries, getDisplay, getDoorHandler, getEquipment, getExperienceTracker, getFavour, getGrandExchange, getGraphicObjects, getGroundItems, getHintArrow, getInventory, getKeyboard, getLogoutTab, getMagic, getMap, getMenuAPI, getMouse, getNpcs, getObjects, getPlayers, getPrayer, getProjectiles, getQuests, getSettings, getSkills, getStore, getTabs, getTrade, getWalking, getWidgets, getWorlds, gRandom, gRandom, gRandom, initializeContext, log, log, myPlayer, myPosition, random, random, sleep, stripFormatting, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityAPI

public EntityAPI()

Method Detail

iterator

public java.util.Iterator<E> iterator()

Returns the iterator to loop through the collection of entities.

Returns:

The iterator to iterate through the collection of entities.

closest

public E closest(java.util.Collection<E> entities)

Gets the closest entity from a collection of entities.

Parameters:

entities - The collection of entities.

Returns:

The closest entity using Pythagoras.

closest

public E closest(boolean realDistance,
                 java.util.Collection<E> entities)

Gets the closest entity from a collection of entities.

Parameters:

realDistance - Whether to use real distance, which means the length of the actual path to walk to the entity meaning when no path is found the entity will be ignored and can return null, or the absolute distance.

entities - The collection of entities.

Returns:

The closest entity that's reachable when using real distance, or otherwise the closest using Pythagoras.

closest

public E closest(boolean realDistance,
                 java.util.Collection<E> entities,
                 int distanceTolerance)

Gets the closest entity from a collection of entities.

Parameters:

realDistance - Whether to use real distance, which means the length of the actual path to walk to the entity meaning when no path is found the entity will be ignored and can return null, or the absolute distance.

entities - The collection of entities.

distanceTolerance - The tolerance for distance. Allows the "closest" to be randomly chosen as long as it is within this standard.

Returns:

The closest entity that's reachable when using real distance, or otherwise the closest using Pythagoras.

closest

public E closest(int... ids)

Gets the closest generically specified Entity that matches any of the given ids by using the Pythagoras algorithm.

Parameters:

ids - The ids to look for matches.

Returns:

The closest generically specified Entity that matches any of the given ids by using the Pythagoras algorithm.

closest

public E closest(boolean realDistance,
                 int... ids)

Gets the closest generically specified Entity that matches any of the given ids by using either the Pythagoras algorithm or real distance.

Parameters:

realDistance - Whether to use real distance, which means the length of the actual path to walk to the entity meaning when no path is found the entity will be ignored and can return null, or the absolute distance.

ids - The ids to look for matches.

Returns:

The closest generically specified Entity that matches any of the given ids by using either the Pythagoras algorithm or real distance.

closest

public E closest(java.lang.String... names)

Gets the closest generically specified Entity that matches any of the given names by using the Pythagoras algorithm.

Parameters:

names - The names to look for matches.

Returns:

The closest generically specified Entity that matches any of the given names by using the Pythagoras algorithm.

closest

public E closest(boolean realDistance,
                 java.lang.String... names)

Gets the closest generically specified Entity that matches any of the given names by either using the Pythagoras algorithm or real distance.

Parameters:

realDistance - Whether to use real distance, which means the length of the actual path to walk to the entity meaning when no path is found the entity will be ignored and can return null, or the absolute distance.

names - The names to look for matches.

Returns:

The closest generically specified Entity that match any of the given names by either using the Pythagoras algorithm or real distance.

closestThatContains

public E closestThatContains(java.lang.String... strings)

Gets the closest generically specified Entity that contains any of the specified strings in its name by using the Pythagoras algorithm.

Parameters:

strings - The strings to look for matches.

Returns:

Tthe closest generically specified Entity that contains any of the specified strings in its name by using the Pythagoras algorithm.

closestThatContains

public E closestThatContains(boolean realDistance,
                             java.lang.String... strings)

Gets the closest generically specified Entity that contains any of the specified strings in its name by using either the Pythagoras algorithm or real distance.

Parameters:

realDistance - Whether to use real distance, which means the length of the actual path to walk to the entity meaning when no path is found the entity will be ignored and can return null, or the absolute distance.

strings - The strings to look for matches.

Returns:

The closest generically specified Entity that contains any of the specified strings in its name by using either the Pythagoras algorithm or real distance.

closest

@SafeVarargs
public final E closest(Filter<E>... filters)

Gets the closest generically specified Entity by using the Pythagoras algorithm.

Parameters:

filters - The filters for items to look for.

Returns:

The closest generically specified Entity by using the Pythagoras algorithm.

closest

@SafeVarargs
public final E closest(boolean realDistance,
                                     Filter<E>... filters)

Gets the closest generically specified Entity by using either the Pythagoras algorithm or real distance.

Parameters:

filters - The filters for items to look for.

realDistance - Whether to use real distance, which means the length of the actual path to walk to the entity meaning when no path is found the entity will be ignored and can return null, or the absolute distance.

Returns:

The closest generically specified Entity by using the Pythagoras algorithm or real distance.

closest

public E closest(Area area,
                 java.lang.String... names)

Gets the closest entity with the specified entity names contained in the specified area.

Parameters:

area - The area to look for matches.

names - The names of entities to look for.

Returns:

The closest entity with the specified entity names contained in the specified area.

closest

public E closest(Area area,
                 int... ids)

Gets the closest entity with the specified entity ids contained in the specified area.

Parameters:

area - The area to look for matches.

ids - The ids of entities to look for.

Returns:

The closest entity with the specified entity ids contained in the specified area.

get

public abstract java.util.List<E> get(int x,
                                      int y)

Gets a list of entities on the specified x and y coordinates on the plane of your current player.

Parameters:

x - The x coordinate.

y - The y coordinate.

Returns:

An empty list if there are no entities found on this location, else a list of entities found on this location.