Query

public interface Query<EntityType, QueryType extends Query<EntityType, QueryType>>

An interface for querying entities. Each Query instance should only be executed once. Queries are modified in-place when calling methods such as filter. Therefore the expression {@code query.filter(x -> true) == query} will always be true. No methods will return {@code null} unless otherwise indicated within that method's documentation. Queries are lazily evaluated.

Parameters

<EntityType>

the entity type to query

<QueryType>

the query type

Functions

bank

static BankQuery bank()

Creates a new BankQuery

count

int count()

Executes this query and gets the number of results

equipment

static EquipmentQuery equipment()

Creates a new EquipmentQuery

filter

abstract QueryType filter(Predicate<EntityType> filter)

Applies the specified filter to this query.

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

inventory

static InventoryQuery inventory()

Creates a new InventoryQuery

isAny

boolean isAny()

Executes this query and checks if any result exists

itemDefinitions

static ItemDefinitionQuery itemDefinitions()

Creates a new ItemDefinitionQuery

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.

stream

abstract Stream<EntityType> stream()

Returns this query as a stream.

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

ActionableQuery

ItemDefinitionQuery

CharacterQuery

StackableQuery

NamedQuery

IndexableQuery

ItemDefinableQuery

PositionableQuery

OrientableQuery

IdentifiableQuery

ClickableQuery