GameObjectQuery

public class GameObjectQuery extends StreamBackedQuery<GameObject, GameObjectQuery> implements ActionableQuery<GameObject, GameObjectQuery>, InteractableQuery<GameObject, GameObjectQuery>, IdentifiableQuery<GameObject, GameObjectQuery>, NamedQuery<GameObject, GameObjectQuery>, OrientableQuery<GameObject, GameObjectQuery>

A query to search over entities of type GameObject

Functions

actionContains

QueryType actionContains(Array<String> actions)

Checks if any of the actions of this entity contains any of the specified actions, case insensitive

actionEquals

QueryType actionEquals(Array<String> actions)

Checks if any of the actions of this entity equal any of the specified actions, case sensitive

actionNotContains

QueryType actionNotContains(Array<String> actions)

Checks if none of the actions of this entity contains any of the specified actions, case insensitive

actionNotEquals

QueryType actionNotEquals(Array<String> actions)

Checks if none of the actions of this entity equal any of the specified actions, case sensitive

bank

static BankQuery bank()

Creates a new BankQuery

count

int count()

Executes this query and gets the number of results

distinctById

QueryType distinctById()

Removes duplicate entities from this query based on the id (keeps the first match, removes the rest)

distinctByName

QueryType distinctByName()

Removes duplicate entities from this query based on the name (keeps the first match, removes the rest)

equipment

static EquipmentQuery equipment()

Creates a new EquipmentQuery

filter

QueryType filter(Predicate<EntityType> filter)

Applies the specified filter to this query.

findBestInteractable

Optional<EntityType> findBestInteractable()

Orders the best entity according to PreferredTargetSelector (the element with the minimum cost)

findClosest

Optional<EntityType> findClosest()

Executes this query and gets the closest matching entity to our player

findClosestByPathDistance

Optional<EntityType> findClosestByPathDistance()

Executes this query and gets the closest matching entity to our player, based on path distance (the distance it would take to actually walk there based on the surrounding obstacles/collision)

findFirst

Optional<EntityType> findFirst()

Executes this query, and gets the first result if it exists

findRandom

Optional<EntityType> findRandom()

Executes this query, and selects a random result based on a uniform distribution

forEach

void forEach(Consumer<EntityType> consumer)

Executes this query and passes each result to the specified consumer

gameObjects

static GameObjectQuery gameObjects()

Creates a new GameObjectQuery

grandExchangeOffers

static GrandExchangeOfferQuery grandExchangeOffers()

Creates a new GrandExchangeOfferQuery

graphicObjects

static GraphicObjectQuery graphicObjects()

Creates a new GraphicObjectQuery

groundItems

static GroundItemQuery groundItems()

Creates a new GroundItemQuery

hasLineOfSightTo

QueryType hasLineOfSightTo(Positionable other)

Unmaintained.

idEquals

QueryType idEquals(Array<int> id)

Only match entities with the specified id

idNotEquals

QueryType idNotEquals(Array<int> id)

Only match entities who do not have the specified id

inArea

GameObjectQuery inArea(Array<Area> areas)

Only match entities in the specified areas

inventory

static InventoryQuery inventory()

Creates a new InventoryQuery

isAny

boolean isAny()

Executes this query and checks if any result exists

isHovering

QueryType isHovering()

Only match entities that are being hovered

isInLineOfSight

QueryType isInLineOfSight()

Unmaintained.

QueryType isInLineOfSight(Positionable source)

Unmaintained.

isInteractive

GameObjectQuery isInteractive()

Only match game objects that are interactive

isNotHovering

QueryType isNotHovering()

Only match entities that are not being hovered

isNotInteractive

GameObjectQuery isNotInteractive()

Only match game objects that are not interactive

isNotVisible

QueryType isNotVisible()

Only match clickable entities that are not visible

isOnMinimap

QueryType isOnMinimap()

Only match entities that are on the minimap

isReachable

QueryType isReachable()

Only match entities that are reachable via canReach obtained from createMap

isVisible

QueryType isVisible()

Only match clickable entities that are visible

itemDefinitions

static ItemDefinitionQuery itemDefinitions()

Creates a new ItemDefinitionQuery

maxDistance

GameObjectQuery maxDistance(double maxDistance)

Only match entities who are at most the specified distance away from our player

QueryType maxDistance(Positionable source, double maxDistance)

Only match entities who are at most the specified distance away from the specified location

maxPathDistance

QueryType maxPathDistance(double maxDistance)

Only match entities who are at most the specified path distance away from our player (the distance it would take to actually walk there based on the surrounding obstacles/collision)

minDistance

QueryType minDistance(double min)

Only match entities who are at least the specified distance away from our player

QueryType minDistance(Positionable source, double min)

Only match entities who are at least the specified distance away from the specified location

minPathDistance

QueryType minPathDistance(double min)

Only match entities who are at least the specified path distance away from our player (the distance it would take to actually walk there based on the surrounding obstacles/collision)

nameContains

QueryType nameContains(Array<String> names)

Only match entities whose name contains any of the specified names, case insensitive

nameEquals

QueryType nameEquals(Array<String> names)

Only match entities with the specified names, case sensitive

nameNotContains

QueryType nameNotContains(Array<String> names)

Only match entities whose name does not contains any of the specified names, case insensitive

nameNotEquals

QueryType nameNotEquals(Array<String> names)

Only match entities whose name does not equal any of the specified names, case sensitive