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

ItemQuery

Functions

actionContains

open fun actionContains(actions: Array<String>): QueryType

Checks if any of the actions of this entity contains any of the specified actions, case insensitive

actionEquals

open fun actionEquals(actions: Array<String>): QueryType

Checks if any of the actions of this entity equal any of the specified actions, case sensitive

actionNotContains

open fun actionNotContains(actions: Array<String>): QueryType

Checks if none of the actions of this entity contains any of the specified actions, case insensitive

actionNotEquals

open fun actionNotEquals(actions: Array<String>): QueryType

Checks if none of the actions of this entity equal any of the specified actions, case sensitive

bank

open fun bank(): BankQuery

Creates a new BankQuery

count

open fun count(): Int

Executes this query and gets the number of results

distinctById

open fun distinctById(): QueryType

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

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.

findClosestToMouse

open fun findClosestToMouse(): Optional<EntityType>

Executes this query and gets the closest item to the mouse

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

idEquals

open fun idEquals(id: Array<Int>): QueryType

Only match entities with the specified id

idNotEquals

open fun idNotEquals(id: Array<Int>): QueryType

Only match entities who do not have the specified id

indexEquals

open fun indexEquals(index: Array<Int>): QueryType

Only match entities with the specified index

indexNotEquals

open fun indexNotEquals(index: Array<Int>): QueryType

Only match entities who do not have the specified index

inventory

open fun inventory(): InventoryQuery

Creates a new InventoryQuery

isAny

open fun isAny(): Boolean

Executes this query and checks if any result exists

isBankable

open fun ~~isBankable~~(): QueryType

Only match items that are bankable

isGrandExchangeTradeable

open fun isGrandExchangeTradeable(): QueryType

Only match items that can be traded on the grand exchange

isHovering

open fun isHovering(): QueryType

Only match entities that are being hovered

isMembersOnly

open fun isMembersOnly(): QueryType

Only match items that are members only

isNotBankable

open fun ~~isNotBankable~~(): QueryType

Only match items that are not bankable

isNoted

open fun isNoted(): QueryType

Only match items that are noted

isNotGrandExchangeTradeable

open fun isNotGrandExchangeTradeable(): QueryType

Only match items that cannot be traded on the grand exchange

isNotHovering

open fun isNotHovering(): QueryType

Only match entities that are not being hovered

isNotMembersOnly

open fun isNotMembersOnly(): QueryType

Only match items that are not members only

isNotNoted

open fun isNotNoted(): QueryType

Only match items that are not noted

isNotStackable

open fun isNotStackable(): QueryType

Only match items that are not stackable

isNotVisible

open fun isNotVisible(): QueryType

Only match clickable entities that are not visible

isStackable

open fun isStackable(): QueryType

Only match items that are stackable

isVisible

open fun isVisible(): QueryType

Only match clickable entities that are visible

itemDefinitions

open fun itemDefinitions(): ItemDefinitionQuery

Creates a new ItemDefinitionQuery

maxPrice

open fun maxPrice(max: Int): QueryType

Only match items that have at most the specified price.

maxStack

open fun maxStack(maxStack: Int): QueryType

Only match entities with at most the specified stack size

maxStackPrice

open fun maxStackPrice(max: Int): QueryType

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

minPrice

open fun minPrice(min: Int): QueryType

Only match items that have at least the specified price.

minStack

open fun minStack(minStack: Int): QueryType

Only match entities with at least the specified stack size

minStackPrice

open fun minStackPrice(min: Int): QueryType

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

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.

sortedByDistanceToMouse

open fun sortedByDistanceToMouse(): QueryType

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

stackEquals

open fun stackEquals(stack: Array<Int>): QueryType

Only match entities who have the specified stack

stackNotEquals

open fun stackNotEquals(stack: Array<Int>): QueryType

Only match entities who do not have the specified stack

stackWithin

open fun stackWithin(minStack: Int, maxStack: Int): QueryType

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

stream

abstract fun stream(): Stream<EntityType>

Returns this query as a stream.

sumStacks

open fun sumStacks(): Int

Executes this query and sums the stack of all matching items

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

ItemQuery

Inheritors

Functions