script-sdk/org.tribot.script.sdk.types/Widget

Widget

open class Widget : Clickable, Actionable, Indexable

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

Constructors

Widget

constructor(rsInterface: RSInterface)

Functions

click

open fun click(): Boolean

Interacts with the entity, with the first action available.

open fun click(action: String): Boolean

Interacts with the entity, given a specific action.

dragTo

open fun dragTo(destination: Widget): Boolean

Drags this widget to the destination widget

getActions

open fun getActions(): List<String>

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

getAnimationId

open fun getAnimationId(): Int

Gets the widget animation ID

getBounds

open fun getBounds(): Rectangle

getChild

open fun getChild(index: Int): Optional<Widget>

Gets the child of this widget at the specified index

getChildren

open fun getChildren(): List<Widget>

getIndex

open fun getIndex(): Int

Gets the index of the entity.

getIndexPath

open fun getIndexPath(): Array<Int>

getItemStack

open fun getItemStack(): Int

getLegacyInterface

open fun getLegacyInterface(): RSInterface

Not exposed

getModelId

open fun getModelId(): Int

Gets this widget's model id.

getName

open fun getName(): Optional<String>

Returns the name of this widget, if one exists.

getParent

open fun getParent(): Optional<Widget>

Gets the parent of this widget in the widget tree

getSibling

open fun getSibling(siblingOffset: Int): Optional<Widget>

Gets a sibling of this widget from the specified offset

getText

open fun getText(): Optional<String>

getTextColor

open fun getTextColor(): Int

Gets the text color of this widget as an rgb color

getTextureId

open fun getTextureId(): Int

Gets the widget texture ID

hover

open fun hover(action: String): Boolean

Hovers the specified action on this entity.

open fun hover(): Boolean

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

hoverMenu

open fun hoverMenu(action: String): Boolean

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

isHovering

open fun isHovering(): Boolean

Checks if the mouse is currently over this entity

isVisible

open fun isVisible(): Boolean

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

scrollTo

open fun scrollTo(): Boolean

Scroll to the desired widget

toItemDefinition

open fun toItemDefinition(): Optional<ItemDefinition>

toString

open fun toString(): String

toWidgetItem

open fun toWidgetItem(): Optional<Item>

toWidgetItemTable

open fun toWidgetItemTable(): List<Item>

Widget

See also

Constructors

Functions