CharacterQuery

public interface CharacterQuery<EntityType extends Character, QueryType extends Query<EntityType, QueryType>> implements Query<EntityType, QueryType>, NamedQuery<EntityType, QueryType>, InteractableQuery<EntityType, QueryType>, IndexableQuery<EntityType, QueryType>, OrientableQuery<EntityType, QueryType>

A query to search over character entities

Parameters

the entity type

the query type

Functions

bank

static BankQuery bank()

Creates a new BankQuery

count

int count()

Executes this query and gets the number of results

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

abstract 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

hasHitsplat

QueryType hasHitsplat()

Checks if any hitsplat is present

QueryType hasHitsplat(Predicate<Hitsplat> filter)

Checks if any hitsplat is present that matches the filter

hasLineOfSightTo

QueryType hasLineOfSightTo(Positionable other)

Unmaintained.

hasNoHitsplat

QueryType hasNoHitsplat()

Checks if no hitsplat is present

hasOverheadIcon

QueryType hasOverheadIcon()

Only match players who have an overhead icon

inArea

QueryType inArea(Array<Area> area)

Only match entities in the specified areas

indexEquals

QueryType indexEquals(Array<int> index)

Only match entities with the specified index

indexNotEquals

QueryType indexNotEquals(Array<int> index)

Only match entities who do not have the specified index

inventory

static InventoryQuery inventory()

Creates a new InventoryQuery

isAnimating

QueryType isAnimating()

Only match characters who are animating

isAnimation

QueryType isAnimation(Array<int> animation)

Only match characters with any of the specified animations

isAny

boolean isAny()

Executes this query and checks if any result exists

isBeingInteractedWith

QueryType isBeingInteractedWith()

Only match entities that at least one character is interacting with

isFacing

QueryType isFacing(Positionable position)

Only matches characters that are facing the specified position

isFacingMe

QueryType isFacingMe()

Only matches characters that are facing our player

isHealthBarEmpty

QueryType isHealthBarEmpty()

isHealthBarFull

QueryType isHealthBarFull()

isHealthBarNotEmpty

QueryType isHealthBarNotEmpty()

isHealthBarNotFull

QueryType isHealthBarNotFull()

isHealthBarNotVisible

QueryType isHealthBarNotVisible()

Only matches characters who's health bar is not visible

isHealthBarVisible

QueryType isHealthBarVisible()

Only matches characters who's health bar is currently visible

isHovering

QueryType isHovering()

Only match entities that are being hovered

isInLineOfSight

QueryType isInLineOfSight()

Unmaintained.

QueryType isInLineOfSight(Positionable source)

Unmaintained.

isInteractingWith

QueryType isInteractingWith(Array<Character> interacting)

Only match entities that are interacting with any of the specified entities

isInteractingWithCharacter

QueryType isInteractingWithCharacter()

Only match entities that are interacting with another character

isInteractingWithMe

QueryType isInteractingWithMe()

Only matches characters that are interacting with our player

isMoving

QueryType isMoving()

Only matches characters that are moving

isMyPlayerInteractingWith

QueryType isMyPlayerInteractingWith()

Only match entities that my player is interacting with (this limits the query to 0 or 1 results)

isMyPlayerNotInteractingWith

QueryType isMyPlayerNotInteractingWith()

Only match entities that my player is interacting with

isNotAnimating

QueryType isNotAnimating()

Only match characters who are not animating

isNotAnimation

QueryType isNotAnimation(Array<int> animation)

Only match characters who do not have any of the specified animations

isNotBeingInteractedWith

QueryType isNotBeingInteractedWith()

Only match entities that no character is interacting with

isNotHovering

QueryType isNotHovering()

Only match entities that are not being hovered

isNotInteractingWith

QueryType isNotInteractingWith(Array<Character> interacting)

Only match entities that are not interacting with any of the specified entities

isNotInteractingWithCharacter

QueryType isNotInteractingWithCharacter()

Only match entities that are not interacting with another character

isNotMoving

QueryType isNotMoving()

Only matches characters that are not moving

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

QueryType 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

maxHealthBarPercent

QueryType maxHealthBarPercent(double max)

maxLevel

QueryType maxLevel(int maxLevel)

Only matches characters who are at most the specific level

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

minHealthBarPercent

QueryType minHealthBarPercent(double min)

minLevel

QueryType minLevel(int minLevel)

Only matches characters who are at least the specified level

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