org.osbot.rs07.api

Class Widgets

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.API

org.osbot.rs07.api.CollectionAPI<E>

org.osbot.rs07.api.filter.FilterAPI<RS2Widget>

org.osbot.rs07.api.Widgets

public class Widgets
extends FilterAPI<RS2Widget>

Represents the API regarding widget (previously called interfaces) functionality.

Field Summary

Fields inherited from class org.osbot.rs07.script.MethodProvider

bank, bot, camera, chatbox, client, colorPicker, combat, configs, depositBox, dialogues, diaries, display, doorHandler, equipment, experienceTracker, favour, grandExchange, graphicObjects, groundItems, hintArrow, inventory, keyboard, logger, logoutTab, magic, map, menu, mouse, npcs, objects, players, prayer, projectiles, quests, settings, skills, store, tabs, trade, walking, widgets, worlds

Constructor Summary

Constructors

Constructor and Description
Widgets()

Method Summary

Modifier and Type	Method and Description
boolean	closeOpenInterface() Closes the currently open widget (first level), if any.
java.util.List<RS2Widget>	containingActions(int rootId, java.lang.String... actions) Gets all widgets for a given parent containing the actions
java.util.List<RS2Widget>	containingSprite(int sprite) Checks all widgets (second and third level) for the specified sprite.
java.util.List<RS2Widget>	containingSprite(int rootId, int sprite) Checks all widgets (second and third level) for the specified parent id (first level) for the specified sprite.
java.util.List<RS2Widget>	containingText(boolean ignoreChatbox, java.lang.String... texts) Checks all widgets (second and third level) for a matching text.
java.util.List<RS2Widget>	containingText(int rootId, java.lang.String... texts) Checks all the widgets (second and third level) for the specified parent id (first level) for a matching text.
java.util.List<RS2Widget>	containingText(java.lang.String... texts)
java.util.List<RS2Widget>	filter(Filter<RS2Widget>... filters) Filters the widgets
java.util.List<RS2Widget>	filter(int[] rootIds, Filter<RS2Widget>... filters) Filters the widgets for the given root ids.
java.util.List<RS2Widget>	filter(int rootId, Filter<RS2Widget>... filters) Filters the widgets for the given root id.
RS2Widget	get(int rootId, int childId) Returns the widget (second level) for the specified parent and child id.
RS2Widget	get(int rootId, int childId, int subChildId) Returns the widget (third level) for the specified parent, child and subchild id.
java.util.List<java.lang.Integer>	getActiveWidgetRoots() Gets all active widget root ids
java.util.List<RS2Widget>	getAll() Gets all the second and third level widgets (the childs of all parents + the sub childs of all childs).
RS2Widget	getCloseInterface() Gets the widget that closes an open interface
boolean[]	getValid() Gets the array of booleans determining the validity of the first level widgets.
RS2Widget	getWidgetContainingAction(int rootId, java.lang.String... actions) Gets the first widget from a root widget containing a specific action
RS2Widget	getWidgetContainingAction(java.lang.String... actions) Gets the first widget containing a specific action
RS2Widget	getWidgetContainingSprite(int sprite) Checks all widgets (second and third level) for the specified sprite.
RS2Widget	getWidgetContainingSprite(int rootId, int sprite) Checks all widgets (second and third level) for the specified parent id (first level) for the specified sprite.
RS2Widget	getWidgetContainingText(boolean ignoreChatbox, java.lang.String... texts) Checks all widgets excluding Chatbox messages.
RS2Widget	getWidgetContainingText(int rootId, java.lang.String... texts) Checks all widgets under the root id.
RS2Widget	getWidgetContainingText(java.lang.String... texts) Checks all widgets excluding Chatbox messages.
RS2Widget[]	getWidgets(int rootId) Returns all the child widgets (second level) for the specified parent id.
RS2Widget[]	getWidgets(int rootId, int childId) Returns all the child widgets (third level) for the specified parent and child id.
void	initializeModule()
boolean	interact(int rootId, int childId, int subChildId, java.lang.String action) Interacts with a specific child widget (third level).
boolean	interact(int rootId, int childId, java.lang.String action) Interacts with a specific child widget (second level).
boolean	intertact(RS2Widget[] widgets, java.lang.String action) Identifies the widget to interact with based on the action and attempts to interact with it
boolean	isValid(int rootId) Checks if getValid() returns true for the given root widget id
boolean	isVisible(int rootId) Determines whether the first level widget is visible by checking if any child widgets (second level) are visible.
boolean	isVisible(int rootId, int childId) Determines whether the second level widget is visible.
boolean	isVisible(int rootId, int childId, int subChildId) Determines whether the third level widget is visible.
boolean	isVisible(RS2Widget[] widgets) Determines whether any of the given widgets are visible.
java.util.List<RS2Widget>	matchingTextColour(int rootId, int textColor) Checks all widgets (second and third level) for the specified parent id (first level) for the specified text colour.
RS2Widget	refresh(RS2Widget widget) This methods can be used to refresh the accessor instance of a stored widget instance.
RS2Widget	singleFilter(Filter<RS2Widget>... filters) Filters the widgets
RS2Widget	singleFilter(int[] rootIds, Filter<RS2Widget>... filters) Filters the widgets for the given root id.
RS2Widget	singleFilter(int rootId, Filter<RS2Widget>... filters) Filters the widgets for the given root id.

Methods inherited from class org.osbot.rs07.api.filter.FilterAPI

filter, singleFilter

Methods inherited from class org.osbot.rs07.script.MethodProvider

exchangeContext, execute, getBank, getBot, getCamera, getChatbox, getClient, getColorPicker, getCombat, getConfigs, getDepositBox, getDialogues, getDiaries, getDisplay, getDoorHandler, getEquipment, getExperienceTracker, getFavour, getGrandExchange, getGraphicObjects, getGroundItems, getHintArrow, getInventory, getKeyboard, getLogoutTab, getMagic, getMap, getMenuAPI, getMouse, getNpcs, getObjects, getPlayers, getPrayer, getProjectiles, getQuests, getSettings, getSkills, getStore, getTabs, getTrade, getWalking, getWidgets, getWorlds, gRandom, gRandom, gRandom, initializeContext, log, log, myPlayer, myPosition, random, random, sleep, stripFormatting, warn

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Widgets

public Widgets()

Method Detail

refresh

public RS2Widget refresh(RS2Widget widget)

This methods can be used to refresh the accessor instance of a stored widget instance. For example when you have logged out but cache a static reference to a certain widget (example, logout button or auto retaliate button), the accessor instance will be outdated. Remember that certain interfaces can only be read from the client when drawn on screen, so refreshing might return a null value if the widget is not drawn or the client keeps to reference to it anymore.

Parameters:

widget - The widget to refresh.

Returns:

A widget or null.

getWidgets

public RS2Widget[] getWidgets(int rootId)

Returns all the child widgets (second level) for the specified parent id.

Parameters:

rootId - The id of the first level widget.

Returns:

The child widgets (second level) for the specified parent id.

getActiveWidgetRoots

public java.util.List<java.lang.Integer> getActiveWidgetRoots()

Gets all active widget root ids

Returns:

All active widget root ids

getWidgets

public RS2Widget[] getWidgets(int rootId,
                              int childId)

Returns all the child widgets (third level) for the specified parent and child id.

Parameters:

rootId - The id of the first level widget.

childId - The id of the second level widget.

Returns:

The child widgets (third level) for the specified parent and child id.

get

public RS2Widget get(int rootId,
                     int childId)

Returns the widget (second level) for the specified parent and child id.

Parameters:

rootId - The id of the first level widget.

childId - The id of the second level widget.

Returns:

The second level widget.

get

public RS2Widget get(int rootId,
                     int childId,
                     int subChildId)

Returns the widget (third level) for the specified parent, child and subchild id.

Parameters:

rootId - The id of the first level widget.

childId - The id of the second level widget.

subChildId - The id of the third level widget.

Returns:

The third level widget.

getValid

public boolean[] getValid()

Gets the array of booleans determining the validity of the first level widgets. Use RS2Widget.isVisible() to make sure any specific widget is visible.

Returns:

The array of booleans determining the validity of the first level widgets.

isValid

public boolean isValid(int rootId)

Checks if getValid() returns true for the given root widget id

Parameters:

rootId - The root widget id

Returns:

getValid()[rootId]

isVisible

public boolean isVisible(RS2Widget[] widgets)

Determines whether any of the given widgets are visible.

Parameters:

widgets - The widgets to check for visibility.

Returns:

True if any of the widgets are visible.

isVisible

public boolean isVisible(int rootId)

Determines whether the first level widget is visible by checking if any child widgets (second level) are visible.

Parameters:

rootId - The id of the first level widget.

Returns:

True if any of the child widgets (second level) are visible.

isVisible

public boolean isVisible(int rootId,
                         int childId)

Determines whether the second level widget is visible.

Parameters:

rootId - The id of the first level widget.

childId - The id of the second level widget.

Returns:

True if the second level widget is visible.

isVisible

public boolean isVisible(int rootId,
                         int childId,
                         int subChildId)

Determines whether the third level widget is visible.

Parameters:

rootId - The id of the first level widget.

childId - The id of the second level widget.

subChildId - The id of the third level widget.

Returns:

True if the third level widget is visible.

getAll

public java.util.List<RS2Widget> getAll()

Gets all the second and third level widgets (the childs of all parents + the sub childs of all childs).

Specified by:

getAll in class CollectionAPI<RS2Widget>

Returns:

The second and third level widgets (the childs of all parents + the sub childs of all childs).

getCloseInterface

public RS2Widget getCloseInterface()

Gets the widget that closes an open interface

Returns:

The widget that closes an open interface

closeOpenInterface

public boolean closeOpenInterface()

Closes the currently open widget (first level), if any.

Returns:

True if we closed a widget (first level) or if there are no open widgets.

intertact

public boolean intertact(RS2Widget[] widgets,
                         java.lang.String action)

Identifies the widget to interact with based on the action and attempts to interact with it

Parameters:

widgets - The group of widgets to check from

action - The action to perform

Returns:

True if the widget has been identified and interacted with

interact

public boolean interact(int rootId,
                        int childId,
                        java.lang.String action)

Interacts with a specific child widget (second level).

Parameters:

rootId - The id of the first level widget.

childId - The id of the second level widget.

action - The action to interact with.

Returns:

If this event was executed successfully.

interact

public boolean interact(int rootId,
                        int childId,
                        int subChildId,
                        java.lang.String action)

Interacts with a specific child widget (third level).

Parameters:

rootId - The id of the first level widget.

childId - The id of the second level widget.

subChildId - The id of the third level widget.

action - The action to interact with.

Returns:

If this event was executed successfully.

containingActions

public java.util.List<RS2Widget> containingActions(int rootId,
                                                   java.lang.String... actions)

Gets all widgets for a given parent containing the actions

Parameters:

rootId - The id of the parent widget

actions - The actions to check for

Returns:

All widgets for a given parent containing the actions

getWidgetContainingAction

public RS2Widget getWidgetContainingAction(java.lang.String... actions)

Gets the first widget containing a specific action

Parameters:

actions - The actions to search for

Returns:

The first widget containing a specific action

getWidgetContainingAction

public RS2Widget getWidgetContainingAction(int rootId,
                                           java.lang.String... actions)

Gets the first widget from a root widget containing a specific action

Parameters:

rootId - The parent widget (first level) id to search

actions - The actions to search for

Returns:

The first widget from a root widget containing a specific action

getWidgetContainingText

public RS2Widget getWidgetContainingText(int rootId,
                                         java.lang.String... texts)

Checks all widgets under the root id.

Parameters:

rootId - The parent widget (first level) id to search.

texts - The widget text(s) to search for.

Returns:

The first widget result containing at least one of the texts.

getWidgetContainingText

public RS2Widget getWidgetContainingText(java.lang.String... texts)

Checks all widgets excluding Chatbox messages.

Parameters:

texts - The widget text(s) to search for.

Returns:

The first widget result containing at least one of the texts.

getWidgetContainingText

public RS2Widget getWidgetContainingText(boolean ignoreChatbox,
                                         java.lang.String... texts)

Checks all widgets excluding Chatbox messages.

Parameters:

ignoreChatbox - True to ignore all chatbox related widgets

texts - The widget text(s) to search for.

Returns:

The first widget result containing at least one of the texts.

containingText

public java.util.List<RS2Widget> containingText(java.lang.String... texts)

Returns:

containingText(boolean, String...) with ignoreChatbox true

containingText

public java.util.List<RS2Widget> containingText(boolean ignoreChatbox,
                                                java.lang.String... texts)

Checks all widgets (second and third level) for a matching text. NOTE: This method will only return widgets that are being drawn!
NOTE2: This method will not return any widgets from parent 137 (first level).

Parameters:

ignoreChatbox - True to ignore all chatbox related widgets

texts - The text/pattern to look for. Each widget only has to contain ONE of the specified text.

Returns:

The results.

containingText

public java.util.List<RS2Widget> containingText(int rootId,
                                                java.lang.String... texts)

Checks all the widgets (second and third level) for the specified parent id (first level) for a matching text. NOTE: This method will only return widgets that are being drawn!

Parameters:

rootId - The parent widget (first level) id to search.

texts - The text/pattern to look for. Each widget only has to contain ONE of the specified text.

Returns:

The results.

containingSprite

public java.util.List<RS2Widget> containingSprite(int sprite)

Checks all widgets (second and third level) for the specified sprite. NOTE: only returns visible widgets.

Parameters:

sprite - The sprite to search for.

Returns:

The list of all widgets containing the specified sprite.

containingSprite

public java.util.List<RS2Widget> containingSprite(int rootId,
                                                  int sprite)

Checks all widgets (second and third level) for the specified parent id (first level) for the specified sprite. NOTE: only returns visible widgets.

Parameters:

rootId - The id of the first level widget.

sprite - The sprite to search for.

Returns:

The list of all widgets containing the specified sprite.

getWidgetContainingSprite

public RS2Widget getWidgetContainingSprite(int sprite)

Checks all widgets (second and third level) for the specified sprite. NOTE: only returns visible widgets.

Parameters:

sprite - The sprite to search for.

Returns:

The first widget containing the specified sprite.

getWidgetContainingSprite

public RS2Widget getWidgetContainingSprite(int rootId,
                                           int sprite)

Checks all widgets (second and third level) for the specified parent id (first level) for the specified sprite. NOTE: only returns visible widgets.

Parameters:

rootId - The id of the first level widget.

sprite - The sprite to search for.

Returns:

The first widget containing the specified sprite.

matchingTextColour

public java.util.List<RS2Widget> matchingTextColour(int rootId,
                                                    int textColor)

Checks all widgets (second and third level) for the specified parent id (first level) for the specified text colour. NOTE: only returns visible widgets.

Parameters:

rootId - The id of the first level widget.

textColor - The text colors to match.

Returns:

The list of all widgets matching the specified text colour.

singleFilter

@SafeVarargs
public final RS2Widget singleFilter(Filter<RS2Widget>... filters)

Filters the widgets

Parameters:

filters - The filters.

Returns:

The first widget matching the filters.

singleFilter

@SafeVarargs
public final RS2Widget singleFilter(int rootId,
                                                  Filter<RS2Widget>... filters)

Filters the widgets for the given root id.

Parameters:

rootId - The root id for which to filter all owned sub widgets (second and third level).

filters - The filters.

Returns:

The first widget matching the filters.

singleFilter

@SafeVarargs
public final RS2Widget singleFilter(int[] rootIds,
                                                  Filter<RS2Widget>... filters)

Filters the widgets for the given root id.

Parameters:

rootIds - The root ids for which to filter all owned sub widgets (second and third level).

filters - The filters.

Returns:

The first widget matching the filters.

filter

@SafeVarargs
public final java.util.List<RS2Widget> filter(Filter<RS2Widget>... filters)

Filters the widgets

Overrides:

filter in class FilterAPI<RS2Widget>

Parameters:

filters - The filters.

Returns:

The list of widgets based on the filters.

filter

@SafeVarargs
public final java.util.List<RS2Widget> filter(int rootId,
                                                            Filter<RS2Widget>... filters)

Filters the widgets for the given root id.

Parameters:

rootId - The root id for which to filter all owned sub widgets (second and third level).

filters - The filters.

Returns:

The list of widgets based on the filters.

filter

@SafeVarargs
public final java.util.List<RS2Widget> filter(int[] rootIds,
                                                            Filter<RS2Widget>... filters)

Filters the widgets for the given root ids.

Parameters:

rootIds - The root ids for which to filter all owned sub widgets (second and third level).

filters - The filters.

Returns:

The list of widgets based on the filters.

initializeModule

public void initializeModule()

Specified by:

initializeModule in class API