Package net.openosrs.api.service.widget

Class WidgetService

java.lang.Object

net.openosrs.api.service.widget.WidgetService

@Singleton
public class WidgetService
extends java.lang.Object

Loaded widget discovery, script calls, and child-component actions.

Constructor Summary

Constructors

Constructor	Description
WidgetService(net.runelite.api.Client client, MenuDispatcher dispatcher, PacketDispatcher packets)
WidgetService(net.runelite.api.Client client, MenuDispatcher dispatcher, PacketDispatcher packets, ClientSceneState sceneState)

Method Summary

Modifier and Type	Method	Description
java.util.List<WidgetRef>	all()	Legacy scope: gameplay widgets only.
java.util.List<WidgetRef>	all(WidgetReadScope scope)
WidgetCapability	capability(WidgetRef widget, java.lang.String action)	Read-only preflight.
void	click(WidgetRef widget)
void	continueDialogue(WidgetRef widget)
java.util.List<WidgetRef>	descendants(int componentId)
WidgetRef	findName(java.lang.String name)
WidgetRef	findText(java.lang.String text)
WidgetRef	get(int componentId)
void	interact(WidgetRef widget, int actionIndex, int subOp, int itemId)
void	interact(WidgetRef widget, java.lang.String action)
boolean	isVisible(int componentId)
void	requireCurrent(WidgetRef widget)	Revalidate a captured widget before a compound action.
void	runScript(java.lang.Object... args)
WidgetQuery	search()
WidgetQuery	search(WidgetReadScope scope)
void	sendScript(java.lang.Object... args)	Explicit alias for script-facing callers.
SubmissionResult	submitInteract(WidgetRef widget, java.lang.String action)

Methods inherited from class java.lang.Object

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

Constructor Detail

WidgetService

public WidgetService(net.runelite.api.Client client,
                     MenuDispatcher dispatcher,
                     PacketDispatcher packets)

WidgetService

@Inject
public WidgetService(net.runelite.api.Client client,
                     MenuDispatcher dispatcher,
                     PacketDispatcher packets,
                     ClientSceneState sceneState)

Method Detail

all

public java.util.List<WidgetRef> all()

Legacy scope: gameplay widgets only. Use all(LOADED) for login/loading diagnostics.

all

public java.util.List<WidgetRef> all(WidgetReadScope scope)

search

public WidgetQuery search()

search

public WidgetQuery search(WidgetReadScope scope)

get

public WidgetRef get(int componentId)

descendants

public java.util.List<WidgetRef> descendants(int componentId)

findText

public WidgetRef findText(java.lang.String text)

findName

public WidgetRef findName(java.lang.String name)

isVisible

public boolean isVisible(int componentId)

click

public void click(WidgetRef widget)

interact

public void interact(WidgetRef widget,
                     java.lang.String action)

submitInteract

public SubmissionResult submitInteract(WidgetRef widget,
                                       java.lang.String action)

capability

public WidgetCapability capability(WidgetRef widget,
                                   java.lang.String action)

Read-only preflight. It performs no native submission.

interact

public void interact(WidgetRef widget,
                     int actionIndex,
                     int subOp,
                     int itemId)

continueDialogue

public void continueDialogue(WidgetRef widget)

runScript

public void runScript(java.lang.Object... args)

sendScript

public void sendScript(java.lang.Object... args)

Explicit alias for script-facing callers.

requireCurrent

public void requireCurrent(WidgetRef widget)

Revalidate a captured widget before a compound action.