Widget

public class Widget implements Clickable, Actionable, Indexable

Represents an on-screen UI element that is drawn on the game canvas

Constructors

Widget

void Widget(RSInterface rsInterface)

Functions

click

boolean click()

Interacts with the entity, with the first action available.

boolean click(String action)

Interacts with the entity, given a specific action.

dragTo

boolean dragTo(Widget destination)

Drags this widget to the destination widget

getActions

List<String> getActions()

Gets the available actions for the entity, usually dependent on their definition.

getAnimationId

int getAnimationId()

Gets the widget animation ID

getBounds

Rectangle getBounds()

getChild

Optional<Widget> getChild(int index)

Gets the child of this widget at the specified index

getChildren

List<Widget> getChildren()

getIndex

int getIndex()

Gets the index of the entity.

getIndexPath

Array<int> getIndexPath()

getItemStack

int getItemStack()

getLegacyInterface

RSInterface getLegacyInterface()

Not exposed

getModelId

int getModelId()

Gets this widget's model id.

getName

Optional<String> getName()

Returns the name of this widget, if one exists.

getParent

Optional<Widget> getParent()

Gets the parent of this widget in the widget tree

getSibling

Optional<Widget> getSibling(int siblingOffset)

Gets a sibling of this widget from the specified offset

getText

Optional<String> getText()

getTextColor

int getTextColor()

Gets the text color of this widget as an rgb color

getTextureId

int getTextureId()

Gets the widget texture ID

hover

boolean hover()

Moves the mouse to a human-randomized point on the entity.

boolean hover(String action)

Hovers the specified action on this entity.

hoverMenu

boolean hoverMenu(String action)

Hovers the specified action on this entity, always right-clicking and hovering over the menu

isHovering

boolean isHovering()

Checks if the mouse is currently over this entity

isVisible

boolean isVisible()

Determines if the entity is on the screen and able to be clicked.

scrollTo

boolean scrollTo()

Scroll to the desired widget

toItemDefinition

Optional<ItemDefinition> toItemDefinition()

toString

String toString()

toWidgetItem

Optional<Item> toWidgetItem()

toWidgetItemTable

List<Item> toWidgetItemTable()

Widget

See also

Constructors

Functions