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

NamedQuery

interface NamedQuery<EntityType : Named?, QueryType : Query<EntityType, QueryType>?> : Query<EntityType, QueryType>

Inheritors

Functions

bank

open fun bank(): BankQuery

Creates a new BankQuery

count

open fun count(): Int

Executes this query and gets the number of results

distinctByName

open fun distinctByName(): QueryType

Removes duplicate entities from this query based on the name (keeps the first match, removes the rest)

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

itemDefinitions

open fun itemDefinitions(): ItemDefinitionQuery

Creates a new ItemDefinitionQuery

nameContains

open fun nameContains(names: Array<String>): QueryType

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

nameEquals

open fun nameEquals(names: Array<String>): QueryType

Only match entities with the specified names, case sensitive

nameNotContains

open fun nameNotContains(names: Array<String>): QueryType

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

nameNotEquals

open fun nameNotEquals(names: Array<String>): QueryType

Only match entities whose name does not equal any of the specified names, case sensitive

nameNotStartsWith

open fun nameNotStartsWith(names: Array<String>): QueryType

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

nameStartsWith

open fun nameStartsWith(names: Array<String>): QueryType

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

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