Package net.runelite.api

Interface ScriptEventBuilder

public interface ScriptEventBuilder

Method Summary

Modifier and Type	Method	Description
ScriptEvent	build()	Build the ScriptEvent
Object[]	getArguments()	Arguments passed to the script.
int	getOp()	Gets the menu op of the event
Widget	getSource()	Gets the widget the ScriptEvent.WIDGET_ID and ScriptEvent.WIDGET_INDEX args are substituted with
Widget	getTarget()	Gets the Widget target.
ScriptEventBuilder	setArguments(Object[] arguments)	Arguments passed to the script.
ScriptEventBuilder	setOp(int op)	Set the menu op of the event
ScriptEventBuilder	setSource(Widget widget)	Sets the widget the ScriptEvent.WIDGET_ID and ScriptEvent.WIDGET_INDEX args are substituted with.
ScriptEventBuilder	setTarget(Widget target)	Sets the Widget target.

Method Detail

getArguments

Object[] getArguments()

Arguments passed to the script. Index 0 is the script being run and is not an argument.

Returns:

setArguments

ScriptEventBuilder setArguments(Object[] arguments)

Arguments passed to the script. Index 0 is the script being run and is not an argument.

Returns:

getSource

Widget getSource()

Gets the widget the ScriptEvent.WIDGET_ID and ScriptEvent.WIDGET_INDEX args are substituted with

setSource

ScriptEventBuilder setSource(Widget widget)

Sets the widget the ScriptEvent.WIDGET_ID and ScriptEvent.WIDGET_INDEX args are substituted with. This is useful for running widget listeners

See Also:

Widget.getOnLoadListener()

getTarget

@Nullable
Widget getTarget()

Gets the Widget target. This is only used for the drag complete listener

Returns:

See Also:

Widget.setOnDragCompleteListener(Object...)

setTarget

ScriptEventBuilder setTarget(Widget target)

Sets the Widget target. This is only used for the drag complete listener.

Parameters:

target -

Returns:

See Also:

Widget.setOnDragCompleteListener(Object...)

getOp

int getOp()

Gets the menu op of the event

Returns:

the menu op

setOp

ScriptEventBuilder setOp(int op)

Set the menu op of the event

Parameters:

op -

build

ScriptEvent build()

Build the ScriptEvent