script-sdk/org.tribot.script.sdk.query/Query

Query

interface Query<EntityType, QueryType : 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 query.filter(x -> true) == query will always be true. No methods will return null unless otherwise indicated within that method's documentation. Queries are lazily evaluated.

Parameters

<EntityType>

the entity type to query

<QueryType>

the query type

Inheritors

ItemDefinableQuery

PositionableQuery

IdentifiableQuery

OrientableQuery

ItemDefinitionQuery

ActionableQuery

Functions

open fun bank(): BankQuery

Creates a new BankQuery

open fun count(): Int

Executes this query and gets the number of results

open fun equipment(): EquipmentQuery

Creates a new EquipmentQuery

abstract fun filter(filter: Predicate<EntityType>): QueryType

Applies the specified filter to this query.

open fun findFirst(): Optional<EntityType>

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

open fun findRandom(): Optional<EntityType>

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

open fun forEach(consumer: Consumer<EntityType>)

Executes this query and passes each result to the specified consumer

open fun gameObjects(): GameObjectQuery

Creates a new GameObjectQuery

grandExchangeOffers

open fun grandExchangeOffers(): GrandExchangeOfferQuery

Creates a new GrandExchangeOfferQuery

open fun graphicObjects(): GraphicObjectQuery

Creates a new GraphicObjectQuery

open fun groundItems(): GroundItemQuery

Creates a new GroundItemQuery

open fun inventory(): InventoryQuery

Creates a new InventoryQuery

open fun isAny(): Boolean

Executes this query and checks if any result exists

itemDefinitions

open fun itemDefinitions(): ItemDefinitionQuery

Creates a new ItemDefinitionQuery

open fun npcs(): NpcQuery

Creates a new NpcQuery

open fun players(): PlayerQuery

Creates a new PlayerQuery

open fun projectiles(): ProjectileQuery

Creates a new ProjectileQuery

open fun shop(): ShopItemQuery

Creates a new ShopItemQuery

abstract fun sorted(comparator: Comparator<EntityType>): QueryType

Orders the query by the specified comparator.

abstract fun stream(): Stream<EntityType>

Returns this query as a stream.

open fun tiles(): TileQuery

Creates a new TileQuery

open fun toList(): List<EntityType>

Executes this query, and gets the results

open fun trade(): TradeQuery

Creates a new TradeQuery

open fun widgets(): WidgetQuery

Creates a new WidgetQuery

open fun worlds(): WorldQuery

Creates a new WorldQuery