org.osbot.rs07.event

Class InteractionEvent

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.event.Event

org.osbot.rs07.event.InteractionEvent

public class InteractionEvent
extends Event

Represents an event which task it is to perform an interaction with either an entity, position, interface or mouse destination.

Nested Class Summary

Nested classes/interfaces inherited from class org.osbot.rs07.event.Event

Event.EventMode, Event.EventStatus

Field Summary

Fields inherited from class org.osbot.rs07.script.MethodProvider

bank, camera, chatbox, client, colorPicker, combat, configs, depositBox, dialogues, diaries, display, doorHandler, equipment, experienceTracker, favour, grandExchange, graphicObjects, groundItems, hintArrow, inventory, keyboard, logger, logoutTab, magic, map, menu, mouse, npcs, objects, players, prayer, projectiles, quests, settings, skills, store, tabs, trade, walking, widgets, worlds

Constructor Summary

Constructors

Constructor and Description
InteractionEvent(Bot bot, Position position, java.lang.String... actions) Creates an interaction event which interacts with the specified position.
InteractionEvent(Entity entity, java.lang.String... actions) Creates an interaction event which interacts with the specified entity.
InteractionEvent(MouseDestination destination, java.lang.String... actions) Creates an interaction event which interacts with the specified mouse destination.
InteractionEvent(RS2Widget widget, java.lang.String... actions) Creates an interaction event which interacts with the specified widget.

Method Summary

Modifier and Type	Method and Description
int	execute() This is the execution method.
boolean	isHover() Determines if we're only hovering.
void	onStart() Called before this event is executed.
InteractionEvent	setAction(java.lang.String... actions) Sets the action of the menu to interact with.
InteractionEvent	setCameraDistanceThreshold(int cameraDistanceThreshold) Deprecated.
InteractionEvent	setHover(boolean hover) Sets whether or not this event will only hover, not click.
InteractionEvent	setMaximumAttempts(int maximumAttempts) Sets the maximum attempts an InteractionEvent execution can attempt.
InteractionEvent	setName(java.lang.String... names) Sets the name(s) of the entity or item to interact with.
InteractionEvent	setOpenMenuOnly(boolean openMenuOnly) Sets whether or not this event will only open the menu, not click.
InteractionEvent	setOperateCamera(boolean operateCamera) Sets whether it is allowed by this event to operate the camera.
InteractionEvent	setValidateMenuEntity(boolean validateMenuEntity) Sets the validation that the interaction will be with the exact entity provided.
InteractionEvent	setWalkingDistanceThreshold(int walkingDistanceThreshold) Sets the maximum distance to the entity for which this event is not allowed to walk.
InteractionEvent	setWalkTo(boolean walkTo) Sets whether it is allowed by this event to walk.

Methods inherited from class org.osbot.rs07.event.Event

addChild, exchangeContext, getChildren, getMode, getParent, getStatus, hasFailed, hasFinished, interrupt, isQueued, isWorking, onEnd, removeChild, setAsync, setBlocking, setFailed, setFinished, setParent

Methods inherited from class org.osbot.rs07.script.MethodProvider

execute, getBank, getBot, getCamera, getChatbox, getClient, getColorPicker, getCombat, getConfigs, getDepositBox, getDialogues, getDiaries, getDisplay, getDoorHandler, getEquipment, getExperienceTracker, getFavour, getGrandExchange, getGraphicObjects, getGroundItems, getHintArrow, getInventory, getKeyboard, getLogoutTab, getMagic, getMap, getMenuAPI, getMouse, getNpcs, getObjects, getPlayers, getPrayer, getProjectiles, getQuests, getSettings, getSkills, getStore, getTabs, getTrade, getWalking, getWidgets, getWorlds, gRandom, gRandom, gRandom, initializeContext, log, log, myPlayer, myPosition, random, random, sleep, stripFormatting, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

InteractionEvent

public InteractionEvent(Entity entity,
                        java.lang.String... actions)

Creates an interaction event which interacts with the specified entity.

Parameters:

entity - The entity to interact with.

actions - The possible menu actions to interact with. None for left click. The bot attempts to interact with the first action in the array detected.

InteractionEvent

public InteractionEvent(Bot bot,
                        Position position,
                        java.lang.String... actions)

Creates an interaction event which interacts with the specified position.

Parameters:

bot - The bot instance.

position - The position to interact with.

actions - The possible menu actions to interact with. None for left click. The bot attempts to interact with the first action in the array detected.

InteractionEvent

public InteractionEvent(RS2Widget widget,
                        java.lang.String... actions)

Creates an interaction event which interacts with the specified widget.

Parameters:

widget - The widget to interact with.

actions - The possible menu actions to interact with. None for left click. The bot attempts to interact with the first action in the array detected.

InteractionEvent

public InteractionEvent(MouseDestination destination,
                        java.lang.String... actions)

Creates an interaction event which interacts with the specified mouse destination.

Parameters:

destination - The mouse destination to interact with.

actions - The possible menu actions to interact with. None for left click. The bot attempts to interact with the first action in the array detected.

Method Detail

setName

public InteractionEvent setName(java.lang.String... names)

Sets the name(s) of the entity or item to interact with.

Parameters:

names - The name(s) of the entity or item to interact with. The bot will interact with the first name detected.

Returns:

This event.

setAction

public InteractionEvent setAction(java.lang.String... actions)

Sets the action of the menu to interact with.

Parameters:

actions - The possible menu actions to interact with. None for left click. The bot attempts to interact with the first action in the array detected.

Returns:

This event.

setHover

public InteractionEvent setHover(boolean hover)

Sets whether or not this event will only hover, not click.
Default Value: False

Parameters:

hover - True if we're only hovering.

Returns:

This event.

setOpenMenuOnly

public InteractionEvent setOpenMenuOnly(boolean openMenuOnly)

Sets whether or not this event will only open the menu, not click.
Default Value: False

Parameters:

openMenuOnly - True if we're only opening the menu without clicking an item.

Returns:

This event.

isHover

public boolean isHover()

Determines if we're only hovering.

Returns:

True if the interaction event will only hover.

setOperateCamera

public InteractionEvent setOperateCamera(boolean operateCamera)

Sets whether it is allowed by this event to operate the camera.
Default Value: True

Parameters:

operateCamera - True if this event is allowed to operate the camera.

Returns:

This event.

setWalkTo

public InteractionEvent setWalkTo(boolean walkTo)

Sets whether it is allowed by this event to walk.
Default Value: True

Parameters:

walkTo - True if this event is allowed to walk.

Returns:

This event.

setMaximumAttempts

public InteractionEvent setMaximumAttempts(int maximumAttempts)

Sets the maximum attempts an InteractionEvent execution can attempt.
Default Value: 4

Parameters:

maximumAttempts - The maximum attempts an InteractionEvent execution can attempt.

Returns:

This event.

setCameraDistanceThreshold

@Deprecated
public InteractionEvent setCameraDistanceThreshold(int cameraDistanceThreshold)

Deprecated.

This method is deprecated and only returns the current instance.

Parameters:

cameraDistanceThreshold - The camera distance threshold

Returns:

This event

setWalkingDistanceThreshold

public InteractionEvent setWalkingDistanceThreshold(int walkingDistanceThreshold)

Sets the maximum distance to the entity for which this event is not allowed to walk.
Default Value: 24

Parameters:

walkingDistanceThreshold - The maximum distance to the entity for which this event is not allowed to walk.

Returns:

This event.

setValidateMenuEntity

public InteractionEvent setValidateMenuEntity(boolean validateMenuEntity)

Sets the validation that the interaction will be with the exact entity provided. This will effect behaviour with menu interactions Default: true

Parameters:

validateMenuEntity - True to interact with the exact entity provided

Returns:

This event.

onStart

public void onStart()

Description copied from class: Event

Called before this event is executed.

Overrides:

onStart in class Event

execute

public int execute()
            throws java.lang.InterruptedException

Description copied from class: Event

This is the execution method. Works like onLoop() in OSBot v1.

Specified by:

execute in class Event

Returns:

A positive number to wait between calls in milliseconds, or a negative number to stop the event.

Throws:

java.lang.InterruptedException - Thrown when execution is interrupted