org.osbot.rs07.api.ui

Class RS2Widget

java.lang.Object

org.osbot.core.api.Wrapper<Bot,C>

org.osbot.rs07.api.RS07Wrapper<org.osbot.rs07.accessor.XRS2Widget>

org.osbot.rs07.api.ui.RS2Widget

All Implemented Interfaces:

Interactable

public class RS2Widget
extends RS07Wrapper<org.osbot.rs07.accessor.XRS2Widget>
implements Interactable

This class represents a widget (previously called interface) in the OSRS client. There are three levels of widgets. For the first level widgets (root) you can not get an instance of this RS2Widget class. For the second level and third level widgets you can. Second level widgets are children of a root widget. Third level widgets are children of a second level widget.

Field Summary

Fields

Modifier and Type	Field and Description
int	cachedDisplayedTime

Fields inherited from class org.osbot.core.api.Wrapper

accessor

Constructor Summary

Constructors

Constructor and Description
RS2Widget(org.osbot.rs07.accessor.XRS2Widget instance, int thirdLevelId) Constructor

Method Summary

Modifier and Type	Method and Description
int	getAbsX() Gets the absolute x coordinate for this widget.
int	getAbsY() Gets the absolute y coordinate for this widget.
int	getActionType() Gets the action type of this widget.
int	getAlpha() Gets the alpha color of this widget.
java.awt.Rectangle	getBounds() Gets the rectangle of this widget.
RS2Widget	getChildWidget(int childId) Gets the given child widget of this widget.
RS2Widget[]	getChildWidgets() Gets this widget's children.
int[]	getConditionCompareValue() Gets the condition compare value of this widget.
int[]	getConditionType() Gets the condition type of this widget.
int	getContentType() Gets the content type of this widget.
int	getDisabledMediaId() Gets the disabled media sprite id for this widget.
MediaType	getDisabledMediaType() Gets the disabled media type.
int[][]	getDynamicValueFormulas() Gets the dynamic formula values of this widget.
int	getEnabledMediaId() Gets the enabled media sprite id for this widget.
MediaType	getEnabledMediaType() Gets the enabled media type.
int	getHeight() Gets the height for this widget.
boolean	getHiddenUntilMouseOver() Checks if this widget is hidden until hovered.
int	getId() Gets the id of the widget
java.lang.String[]	getInteractActions() Gets the interact actions for this widget.
int[]	getInv() Gets the item ids for this widget.
int[]	getInvStackSizes() Gets the amounts of the items for this widget.
int	getItemAmount() Returns the amount of the item on this widget.
int	getItemId() Returns the item id of the item on this widget.
Item[]	getItems() Gets the items of this interface.
java.lang.String	getMessage() Gets the text displayed on this widget.
java.awt.Point	getPosition() Gets the position of this widget.
java.awt.Point	getPositionIgnoreIsHidden(boolean ignoreIsHidden) Gets the position of this widget.
java.awt.Rectangle	getRectangleIgnoreIsHidden(boolean ignoreIsHidden) Gets the rectangle of this widget.
int	getRootId() Returns the root parent id (first level) of this widget.
int	getScrollMax() Gets the maximum amount of pixels the scroll bar of this widget can scroll.
int	getScrollX() Currently unused in OSRS.
int	getScrollY() Gets the scroll y position for this widget.
int	getSecondLevelId() Gets the second level id for this widget.
java.lang.String	getSelectedActionName() Gets the selected action name for this widget.
java.lang.String	getSpellName() Gets the spell name for this widget.
int	getSpriteIndex1() Gets the primary sprite index for this widget.
int	getSpriteIndex2() Gets the secondary sprite index for this widget.
int	getTextColor() Gets the text colour of the text displayed on this widget.
int	getTextDrawingAreaIndex() Gets the index of the text drawing area for this widget.
int	getThirdLevelId() Gets the third level id for this widget.
java.lang.String	getToolTip() Gets the tool tip message for this widget.
int	getType() Gets the type for this widget.
int	getWidth() Gets the width for this widget.
boolean	hasAction(java.lang.String... actions) Check if widget contains one or more of specified actions.
boolean	hover() Attempts to hover the mouse over the next click needed to interact with this Interactable.
boolean	interact(boolean ignoreIsHidden, java.lang.String... actions) Deprecated. use interact(String...)
boolean	interact(java.lang.String... actions) Executes an @link org.osbot.rs07.event.InteractionEvent which attempts to interact with this Interactable with the specified actions (if any).
boolean	isHidden() Returns the isHidden field of this widget in the osrs client.
boolean	isSecondLevel() Determines if this widget is a second level widget.
boolean	isThirdLevel() Determines if this widget is a third level widget.
boolean	isVisible() Determines if this widget is drawn or not.
boolean	isVisibleIgnoreHidden(boolean ignoreIsHidden) Determines if this widget exists or not.
RS2Widget	refresh() Refreshes the information for this widget.
java.lang.String	toString()

Methods inherited from class org.osbot.rs07.api.RS07Wrapper

getClient, getMethods

Methods inherited from class org.osbot.core.api.Wrapper

equals, getBot, supplyWrappers, wrap, wrapArray

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

cachedDisplayedTime

public final int cachedDisplayedTime

Constructor Detail

RS2Widget

public RS2Widget(org.osbot.rs07.accessor.XRS2Widget instance,
                 int thirdLevelId)

Constructor

Parameters:

instance - The XRS2Widget instance

thirdLevelId - The third level widget id

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isVisible

public boolean isVisible()

Determines if this widget is drawn or not.

Returns:

True if this widget is drawn.

isVisibleIgnoreHidden

public boolean isVisibleIgnoreHidden(boolean ignoreIsHidden)

Determines if this widget exists or not. Sometimes widgets have a field marked in the client that determines it is hidden, like some widgets on the bankpin interface. Setting ignoreIsHidden to true will still return this widget unlike the isVisible() method.

Parameters:

ignoreIsHidden - Set to true to ignore the isHidden() value of this widget.

Returns:

True is this widget exists live.

isHidden

public boolean isHidden()

Returns the isHidden field of this widget in the osrs client.

Returns:

True if this widget is hidden.

isSecondLevel

public boolean isSecondLevel()

Determines if this widget is a second level widget.

Returns:

True if this widget is a second level widget.

isThirdLevel

public boolean isThirdLevel()

Determines if this widget is a third level widget.

Returns:

True if this widget is a third level widget.

getEnabledMediaType

public MediaType getEnabledMediaType()

Gets the enabled media type.

Returns:

1 = MediaType.MODEL
2 = MediaType.NPC_HEAD
3 = MediaType.PLAYER_HEAD
4 = MediaType.WITHDRAW_ITEM
other = MediaType.NONE

getDisabledMediaType

public MediaType getDisabledMediaType()

Gets the disabled media type.

Returns:

1 = MediaType.MODEL
2 = MediaType.NPC_HEAD
3 = MediaType.PLAYER_HEAD
4 = MediaType.WITHDRAW_ITEM
other = MediaType.NONE

getType

public int getType()

Gets the type for this widget.

Returns:

The type for this widget.

getId

public int getId()

Gets the id of the widget

Returns:

The id of the widget

getRootId

public int getRootId()

Returns the root parent id (first level) of this widget.

Returns:

The root parent id (first level) of this widget.

getSecondLevelId

public int getSecondLevelId()

Gets the second level id for this widget. This can either be the parent id of this widget

Returns:

The id for this widget.

getThirdLevelId

public int getThirdLevelId()

Gets the third level id for this widget.

Returns:

The third level id for this widget.

refresh

public RS2Widget refresh()

Refreshes the information for this widget.

Returns:

The refreshed version of this widget.

getBounds

public java.awt.Rectangle getBounds()

Gets the rectangle of this widget.

Returns:

The rectangle of this widget. Rectangle(-1, -1, 0, 0) if not visible.

getAbsX

public int getAbsX()

Gets the absolute x coordinate for this widget.

Returns:

The absolute x coordinate for this widget.

getAbsY

public int getAbsY()

Gets the absolute y coordinate for this widget.

Returns:

The absolute y coordinate for this widget.

getScrollX

public int getScrollX()

Currently unused in OSRS.

Returns:

0;

getScrollY

public int getScrollY()

Gets the scroll y position for this widget.

Returns:

The scroll y position for this widget.

getWidth

public int getWidth()

Gets the width for this widget.

Returns:

The width for this widget.

getHeight

public int getHeight()

Gets the height for this widget.

Returns:

The height for this widget.

getHiddenUntilMouseOver

public boolean getHiddenUntilMouseOver()

Checks if this widget is hidden until hovered.

Returns:

true if this widget is hidden until hovered.

getActionType

public int getActionType()

Gets the action type of this widget.

Returns:

The action type of this widget.

getContentType

public int getContentType()

Gets the content type of this widget.

Returns:

The content type of this widget.

getAlpha

public int getAlpha()

Gets the alpha color of this widget.

Returns:

The alpha color of this widget.

getConditionType

public int[] getConditionType()

Gets the condition type of this widget.

Returns:

The condition type of this widget.

getConditionCompareValue

public int[] getConditionCompareValue()

Gets the condition compare value of this widget.

Returns:

The condition compare value of this widget.

getDynamicValueFormulas

public int[][] getDynamicValueFormulas()

Gets the dynamic formula values of this widget.

Returns:

The dynamic formula values of this widget.

getScrollMax

public int getScrollMax()

Gets the maximum amount of pixels the scroll bar of this widget can scroll.

Returns:

The maximum amount of pixels the scroll bar of this widget child can scroll.

getInv

public int[] getInv()

Gets the item ids for this widget. It's best to avoid this method.

Returns:

The item ids for this widget.

getInvStackSizes

public int[] getInvStackSizes()

Gets the amounts of the items for this widget.

Returns:

The amounts of the items for this widget.

getInteractActions

public java.lang.String[] getInteractActions()

Gets the interact actions for this widget. For example, actions of an interface, equipment stats: Open equipment stats.

Returns:

The interact actions for this interface child.

getTextDrawingAreaIndex

public int getTextDrawingAreaIndex()

Gets the index of the text drawing area for this widget.

Returns:

The index of the text drawing area for this widget.

getMessage

public java.lang.String getMessage()

Gets the text displayed on this widget.

Returns:

The text displayed on this widget.

getTextColor

public int getTextColor()

Gets the text colour of the text displayed on this widget.

Returns:

The text colour of the text displayed on this widget.

getSpriteIndex1

public int getSpriteIndex1()

Gets the primary sprite index for this widget.

Returns:

The primary sprite index for this widget

getSpriteIndex2

public int getSpriteIndex2()

Gets the secondary sprite index for this widget.

Returns:

The secondary sprite index for this widget

getSelectedActionName

public java.lang.String getSelectedActionName()

Gets the selected action name for this widget.

Returns:

The selected action name for this widget

getSpellName

public java.lang.String getSpellName()

Gets the spell name for this widget.

Returns:

The spell name for this widget

getToolTip

public java.lang.String getToolTip()

Gets the tool tip message for this widget.

Returns:

The tool tip message for this widget

getDisabledMediaId

public int getDisabledMediaId()

Gets the disabled media sprite id for this widget.

Returns:

The disabled media sprite id for this widget

getEnabledMediaId

public int getEnabledMediaId()

Gets the enabled media sprite id for this widget.

Returns:

The enabled media sprite id for this widget

getPosition

public java.awt.Point getPosition()

Gets the position of this widget.

Returns:

The position of this widget. (-1, -1) if not visible.

getPositionIgnoreIsHidden

public java.awt.Point getPositionIgnoreIsHidden(boolean ignoreIsHidden)

Gets the position of this widget.

Parameters:

ignoreIsHidden - Whether to ignore the isHidden() value of this widget for visibility.

Returns:

The position of this widget.

getRectangleIgnoreIsHidden

public java.awt.Rectangle getRectangleIgnoreIsHidden(boolean ignoreIsHidden)

Gets the rectangle of this widget.

Parameters:

ignoreIsHidden - Whether to ignore the isHidden() value of this widget for visibility.

Returns:

The rectangle of this widget. Rectangle(-1, -1, 0, 0) if not visible.

getChildWidgets

public RS2Widget[] getChildWidgets()

Gets this widget's children.

Returns:

An array of this widget's children.

getChildWidget

public RS2Widget getChildWidget(int childId)

Gets the given child widget of this widget.

Parameters:

childId - The id of the child widget.

Returns:

The child widget.

getItems

public Item[] getItems()

Gets the items of this interface. Use with care though, interfaces like inventory and bank use different methods to get the items.

Returns:

The items on the interface.

interact

public boolean interact(java.lang.String... actions)

Executes an @link org.osbot.rs07.event.InteractionEvent which attempts to interact with this Interactable with the specified actions (if any).

Specified by:

interact in interface Interactable

Parameters:

actions - The actions to chose from the menu while hovering over this Interactable.

Returns:

Whether or not the interaction event executed successfully.

interact

@Deprecated
public boolean interact(boolean ignoreIsHidden,
                                     java.lang.String... actions)

Deprecated. use interact(String...)

hasAction

public boolean hasAction(java.lang.String... actions)

Check if widget contains one or more of specified actions.

Parameters:

actions - The actions you wish to check.

Returns:

If the widget contains at least one action specified.

getItemId

public int getItemId()

Returns the item id of the item on this widget.

Returns:

The item id of the item on this widget.

getItemAmount

public int getItemAmount()

Returns the amount of the item on this widget.

Returns:

The item amount of the item on this widget.

hover

public boolean hover()

Attempts to hover the mouse over the next click needed to interact with this Interactable. This method will never click the mouse, so it can be used to speed up scripts while they are idling.

Specified by:

hover in interface Interactable