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

ClickableQuery

interface ClickableQuery<EntityType : Clickable?, QueryType : Query<EntityType, QueryType>?> : Query<EntityType, QueryType>

A query to search over clickable entities

Parameters

the entity type

the query type

Inheritors

InteractableQuery

WidgetQuery

ItemQuery

Functions

bank

open fun bank(): BankQuery

Creates a new BankQuery

count

open fun count(): Int

Executes this query and gets the number of results

equipment

open fun equipment(): EquipmentQuery

Creates a new EquipmentQuery

filter

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

Applies the specified filter to this query.

findFirst

open fun findFirst(): Optional<EntityType>

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

findRandom

open fun findRandom(): Optional<EntityType>

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

forEach

open fun forEach(consumer: Consumer<EntityType>)

Executes this query and passes each result to the specified consumer

gameObjects

open fun gameObjects(): GameObjectQuery

Creates a new GameObjectQuery

grandExchangeOffers

open fun grandExchangeOffers(): GrandExchangeOfferQuery

Creates a new GrandExchangeOfferQuery

graphicObjects

open fun graphicObjects(): GraphicObjectQuery

Creates a new GraphicObjectQuery

groundItems

open fun groundItems(): GroundItemQuery

Creates a new GroundItemQuery

inventory

open fun inventory(): InventoryQuery

Creates a new InventoryQuery

isAny

open fun isAny(): Boolean

Executes this query and checks if any result exists

isHovering

open fun isHovering(): QueryType

Only match entities that are being hovered

isNotHovering

open fun isNotHovering(): QueryType

Only match entities that are not being hovered

isNotVisible

open fun isNotVisible(): QueryType

Only match clickable entities that are not visible

isVisible

open fun isVisible(): QueryType

Only match clickable entities that are visible

itemDefinitions

open fun itemDefinitions(): ItemDefinitionQuery

Creates a new ItemDefinitionQuery

npcs

open fun npcs(): NpcQuery

Creates a new NpcQuery

players

open fun players(): PlayerQuery

Creates a new PlayerQuery

projectiles

open fun projectiles(): ProjectileQuery

Creates a new ProjectileQuery

shop

open fun shop(): ShopItemQuery

Creates a new ShopItemQuery

sorted

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

Orders the query by the specified comparator.

stream

abstract fun stream(): Stream<EntityType>

Returns this query as a stream.

tiles

open fun tiles(): TileQuery

Creates a new TileQuery

toList

open fun toList(): List<EntityType>

Executes this query, and gets the results

trade

open fun trade(): TradeQuery

Creates a new TradeQuery

widgets

open fun widgets(): WidgetQuery

Creates a new WidgetQuery

worlds

open fun worlds(): WorldQuery

Creates a new WorldQuery