WidgetQuery

public class WidgetQuery extends StreamBackedQuery<Widget, WidgetQuery> implements ActionableQuery<Widget, WidgetQuery>, ClickableQuery<Widget, WidgetQuery>, IndexableQuery<Widget, WidgetQuery>

A query to search over entities of type Widget

Functions

actionContains

QueryType actionContains(Array<String> actions)

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

actionEquals

QueryType actionEquals(Array<String> actions)

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

actionNotContains

QueryType actionNotContains(Array<String> actions)

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

actionNotEquals

QueryType actionNotEquals(Array<String> actions)

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

animationEquals

WidgetQuery animationEquals(Array<int> animationId)

Only match widgets whose animation id does not exactly equal any of the specified animation ids

animationNotEquals

WidgetQuery animationNotEquals(Array<int> animationId)

Only match widgets whose animation id does not exactly equal any of the specified animation ids

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

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

hasChildren

WidgetQuery hasChildren()

Only match widgets who have children

heightEquals

WidgetQuery heightEquals(Array<int> height)

Only match widgets whose height exactly equals one of the specified heights

heightNotEquals

WidgetQuery heightNotEquals(Array<int> height)

Only match widgets whose height does not exactly equal any of the specified heights

indexEquals

QueryType indexEquals(Array<int> index)

Only match entities with the specified index

indexNotEquals

QueryType indexNotEquals(Array<int> index)

Only match entities who do not have the specified index

inIndexPath

WidgetQuery inIndexPath(Array<int> indexPath)

Adds the specified index path as one of the roots that will be searched.

inRoots

WidgetQuery inRoots(Array<int> roots)

See how inIndexPath works - this is equivalent to:

    for (int i : roots) {
        inIndexPath(i);
    }

inventory

static InventoryQuery inventory()

Creates a new InventoryQuery

isAnimating

WidgetQuery isAnimating()

Only match widgets that are animating

isAny

boolean isAny()

Executes this query and checks if any result exists

isDepth

WidgetQuery isDepth(Array<int> depth)

Requires that any matching widget be of the specified depth (depth is {@code widget.getIndexPath().length)}

isHovering

QueryType isHovering()

Only match entities that are being hovered

isItem

WidgetQuery isItem()

Only matches widgets that represent an item

isItemTable

WidgetQuery isItemTable()

Only matches widgets that represent an item table

isNotAnimating

WidgetQuery isNotAnimating()

Only match widgets that are not animating

isNotDepth

WidgetQuery isNotDepth(Array<int> depth)

Requires that any matching widget not be of the specified depth (depth is {@code widget.getIndexPath().length)}

isNotHovering

QueryType isNotHovering()

Only match entities that are not being hovered

isNotVisible

QueryType isNotVisible()

Only match clickable entities that are not visible

isVisible

QueryType isVisible()

Only match clickable entities that are visible

itemDefinitions

static ItemDefinitionQuery itemDefinitions()

Creates a new ItemDefinitionQuery

maxHeight

WidgetQuery maxHeight(int height)

Only match widgets whose height is at most the specified max height

maxWidth

WidgetQuery maxWidth(int width)

Only match widgets whose width is at most the specified max width

minHeight

WidgetQuery minHeight(int height)

Only match widgets whose height is at least the specified min height

minWidth

WidgetQuery minWidth(int width)

Only match widgets whose width is at least the specified min width

modelIdEquals

WidgetQuery modelIdEquals(Array<int> modelId)

Only match widgets with the specified model id

modelIdNotEquals

WidgetQuery modelIdNotEquals(Array<int> modelId)

Only match widgets without the specified model id

nameContains

WidgetQuery nameContains(Array<String> name)

Only matches widgets whose name contains any of the specified names

nameEquals

WidgetQuery nameEquals(Array<String> name)

Only matches widgets whose name equals any of the specified names

nameNotContains

WidgetQuery nameNotContains(Array<String> name)

Only matches widgets whose name does not contain any of the specified names

nameNotEquals

WidgetQuery nameNotEquals(Array<String> name)

Only matches widgets whose name does not equal any of the specified names

npcs

static NpcQuery npcs()

Creates a new NpcQuery

players

static PlayerQuery players()

Creates a new PlayerQuery

positionEquals

WidgetQuery positionEquals(Array<Point> p)

Only match widgets whose position equals one of the specified points

positionNotEquals

WidgetQuery positionNotEquals(Array<Point> p)

Only match widgets whose position does not equal one of the specified points

projectiles

static ProjectileQuery projectiles()

Creates a new ProjectileQuery

shop

static ShopItemQuery shop()

Creates a new ShopItemQuery

sorted

QueryType sorted(Comparator<EntityType> comparator)

Orders the query by the specified comparator.

stream

Stream<EntityType> stream()

Returns this query as a stream.

textColorEquals

WidgetQuery textColorEquals(Array<int> color)

Only match widgets with the specified text color

textColorNotEquals

WidgetQuery textColorNotEquals(Array<int> color)

Only match widgets without the specified text color

textContains

WidgetQuery textContains(Array<String> text)

Only matches widgets whose text contains any of the specified texts

textEquals

WidgetQuery textEquals(Array<String> text)

Only matches widgets whose text equals any of the specified texts

textNotContains

WidgetQuery textNotContains(Array<String> text)

Only matches widgets whose text does not contain any of the specified texts

textNotEquals

WidgetQuery textNotEquals(Array<String> text)

Only matches widgets whose text does not equal any of the specified texts

textureIdEquals

WidgetQuery textureIdEquals(Array<int> textureId)

Only match widgets with the specified texture id

textureIdNotEquals

WidgetQuery textureIdNotEquals(Array<int> textureId)

Only match widgets without the specified texture id

tiles

static TileQuery tiles()

Creates a new TileQuery

toItemQuery

WidgetItemQuery toItemQuery()

Converts this widget query to an widget item query that will match any of the widgets of this query, but the entity to search over is in the form of an org.tribot.script.sdk.interfaces.Item.

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

widthEquals

WidgetQuery widthEquals(Array<int> width)

Only match widgets whose width exactly equals one of the specified widths

widthNotEquals

WidgetQuery widthNotEquals(Array<int> width)

Only match widgets whose width does not exactly equal any of the specified widths

worlds

static WorldQuery worlds()

Creates a new WorldQuery

WidgetQuery

See also

Functions