ItemQuery

public interface ItemQuery<EntityType extends Item, QueryType extends Query<EntityType, QueryType>> implements ClickableQuery<EntityType, QueryType>, IdentifiableQuery<EntityType, QueryType>, NamedQuery<EntityType, QueryType>, IndexableQuery<EntityType, QueryType>, StackableItemDefinableQuery<EntityType, QueryType>, ActionableQuery<EntityType, QueryType>

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

abstract QueryType filter(Predicate<EntityType> filter)

Applies the specified filter to this query.

findClosestToMouse

Optional<EntityType> findClosestToMouse()

Executes this query and gets the closest item to the mouse

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

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

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

isAny

boolean isAny()

Executes this query and checks if any result exists

isBankable

@Deprecated()

QueryType isBankable()

Only match items that are bankable

isGrandExchangeTradeable

QueryType isGrandExchangeTradeable()

Only match items that can be traded on the grand exchange

isHovering

QueryType isHovering()

Only match entities that are being hovered

isMembersOnly

QueryType isMembersOnly()

Only match items that are members only

isNotBankable

@Deprecated()

QueryType isNotBankable()

Only match items that are not bankable

isNoted

QueryType isNoted()

Only match items that are noted

isNotGrandExchangeTradeable

QueryType isNotGrandExchangeTradeable()

Only match items that cannot be traded on the grand exchange

isNotHovering

QueryType isNotHovering()

Only match entities that are not being hovered

isNotMembersOnly

QueryType isNotMembersOnly()

Only match items that are not members only

isNotNoted

QueryType isNotNoted()

Only match items that are not noted

isNotStackable

QueryType isNotStackable()

Only match items that are not stackable

isNotVisible

QueryType isNotVisible()

Only match clickable entities that are not visible

isStackable

QueryType isStackable()

Only match items that are stackable

isVisible

QueryType isVisible()

Only match clickable entities that are visible

itemDefinitions

static ItemDefinitionQuery itemDefinitions()

Creates a new ItemDefinitionQuery

maxPrice

QueryType maxPrice(int max)

Only match items that have at most the specified price.

maxStack

QueryType maxStack(int maxStack)

Only match entities with at most the specified stack size

maxStackPrice

QueryType maxStackPrice(int max)

Only match items that have at most the specified stack price (stack price = price * item stack).

minPrice

QueryType minPrice(int min)

Only match items that have at least the specified price.

minStack

QueryType minStack(int minStack)

Only match entities with at least the specified stack size

minStackPrice

QueryType minStackPrice(int min)

Only match items that have at least the stack price (stack price = price * item stack).

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

nameNotStartsWith

QueryType nameNotStartsWith(Array<String> names)

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

nameStartsWith

QueryType nameStartsWith(Array<String> names)

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

npcs

static NpcQuery npcs()

Creates a new NpcQuery

players

static PlayerQuery players()

Creates a new PlayerQuery

projectiles

static ProjectileQuery projectiles()

Creates a new ProjectileQuery

shop

static ShopItemQuery shop()

Creates a new ShopItemQuery

sorted

abstract QueryType sorted(Comparator<EntityType> comparator)

Orders the query by the specified comparator.

sortedByDistanceToMouse

QueryType sortedByDistanceToMouse()

Sorts this query by distance to the mouse, with closer entities first

stackEquals

QueryType stackEquals(Array<int> stack)

Only match entities who have the specified stack

stackNotEquals

QueryType stackNotEquals(Array<int> stack)

Only match entities who do not have the specified stack

stackWithin

QueryType stackWithin(int minStack, int maxStack)

Only match entities whose stack size is within the specified min/max range

stream

abstract Stream<EntityType> stream()

Returns this query as a stream.

sumStacks

int sumStacks()

Executes this query and sums the stack of all matching items

tiles

static TileQuery tiles()

Creates a new TileQuery

toList

List<EntityType> toList()

Executes this query, and gets the results

trade

static TradeQuery trade()

Creates a new TradeQuery

widgets

static WidgetQuery widgets()

Creates a new WidgetQuery

worlds

static WorldQuery worlds()

Creates a new WorldQuery

Inheritors

ShopItemQuery

InventoryQuery

TradeQuery

WidgetItemQuery

EquipmentQuery

BankQuery