org.osbot.rs07.event

Class WebWalkEvent

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.event.Event

org.osbot.rs07.event.WebWalkEvent

public class WebWalkEvent
extends Event

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebWalkEvent.PathType

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

Event.EventMode, Event.EventStatus

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.concurrent.atomic.AtomicInteger	webwalkRequestCount

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

bank, bot, 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
WebWalkEvent(Area... areas) Walks to closest reachable destination area.
WebWalkEvent(Position... destinations) Walks to closest reachable destination position.

Method Summary

Modifier and Type	Method and Description
int	execute() This is the execution method.
double	getCompletion()
Position	getDestination() Gets the position of this event's destination.
PathPreferenceProfile	getPathPreferenceProfile()
Position[]	getPositions() Gets the positions from the web path
void	onStart() Called before this event is executed.
boolean	prefetchRequirements(MethodProvider provider) Generates the directions for this WebWalkEvent based on the requirements of PathPreferenceProfile.
WebWalkEvent	setBreakCondition(Condition breakCondition) Breaks out of the WebWalkEvent with the provided condition; the event can not be resumed.
WebWalkEvent	setEnergyThreshold(int energyThreshold) Sets the energy threshold, default value is 15.
WebWalkEvent	setHighBreakPriority(boolean highPriority) Allows for break conditions to be checked during waits, default value is false.
WebWalkEvent	setMinDistanceThreshold(int minDistanceThreshold) This methods sets the property of this event that determines the walking accuracy to the destination you have specified.
WebWalkEvent	setMiniMapDistanceThreshold(int miniMapDistanceThreshold) This method sets the property of this event that determines the max distance before a position on the minimap will be clicked.
WebWalkEvent	setMisclickThreshold(int misclickThreshold) Sets the misclick threshold.
WebWalkEvent	setMoveCameraDuringWalking(boolean moveCameraDuringWalking) Sets the camera usage during walking, default value is true.
WebWalkEvent	setPathPreferenceProfile(PathPreferenceProfile profile) Sets a PathPreferenceProfile for this WebWalkEvent which gives control a wide variety of control over how this event will execute.
WebWalkEvent	setScreenDistanceThreshold(int screenDistanceThreshold) This method sets the property of this event that determines the max distance before a position on screen will be clicked.
WebWalkEvent	setSourcePosition(Position position) Sets the source position
WebWalkEvent	useAvoidingPath(boolean block, Area... areas) Sets WebWalkEvent to avoid (or completely block) certain areas
WebWalkEvent	useSimplePath() Sets WebWalkEvent to use the shortest path, does not prioritize roads and other weighted variables.

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

Field Detail

webwalkRequestCount

public static java.util.concurrent.atomic.AtomicInteger webwalkRequestCount

Constructor Detail

WebWalkEvent

public WebWalkEvent(Area... areas)

Walks to closest reachable destination area.

Parameters:

areas - The possible areas to walk to

WebWalkEvent

public WebWalkEvent(Position... destinations)

Walks to closest reachable destination position.

Parameters:

destinations - The possible destinations to walk to

Method Detail

setSourcePosition

public WebWalkEvent setSourcePosition(Position position)

Sets the source position

Parameters:

position - The source position to start from

Returns:

This event

useSimplePath

public WebWalkEvent useSimplePath()

Sets WebWalkEvent to use the shortest path, does not prioritize roads and other weighted variables.
WARNING: This method will increase memory usage. OSBot is optimized for the default finder!

Returns:

This event

useAvoidingPath

public WebWalkEvent useAvoidingPath(boolean block,
                                    Area... areas)

Sets WebWalkEvent to avoid (or completely block) certain areas

Parameters:

block - True to completely block an area

areas - The areas to avoid

Returns:

This event

setMinDistanceThreshold

public WebWalkEvent setMinDistanceThreshold(int minDistanceThreshold)

This methods sets the property of this event that determines the walking accuracy to the destination you have specified. The minimum distance threshold basically says with what distance to the destination you are satisfied with. For example, a distance threshold of 2 means that you say that the events will finish if your distance to the destination is 2 tiles or less. If you want the event to exactly walk to the destination, set this value to 0. The default value of this property is 4.

Parameters:

minDistanceThreshold - The threshold value. Must be above 0 for Entity.

Returns:

This event for chained method calls.

setMiniMapDistanceThreshold

public WebWalkEvent setMiniMapDistanceThreshold(int miniMapDistanceThreshold)

This method sets the property of this event that determines the max distance before a position on the minimap will be clicked. If the distance to the next position is equal or lower than the threshold, the position will be walked to via the minimap. The default value of this property is 4.

Parameters:

miniMapDistanceThreshold - The threshold value.

Returns:

This event for chained method calls.

setScreenDistanceThreshold

public WebWalkEvent setScreenDistanceThreshold(int screenDistanceThreshold)

This method sets the property of this event that determines the max distance before a position on screen will be clicked. If the distance to the next clickable position is equal or lower than the threshold, the position will be walked to via the screen. The default value of this property is 5.

Parameters:

screenDistanceThreshold - The threshold value.

Returns:

This event for chained method calls.

setEnergyThreshold

public WebWalkEvent setEnergyThreshold(int energyThreshold)

Sets the energy threshold, default value is 15.

Parameters:

energyThreshold - The energy threshold

Returns:

This event

getPathPreferenceProfile

public PathPreferenceProfile getPathPreferenceProfile()

Returns:

The profile to use for this event.

setPathPreferenceProfile

public WebWalkEvent setPathPreferenceProfile(PathPreferenceProfile profile)

Sets a PathPreferenceProfile for this WebWalkEvent which gives control a wide variety of control over how this event will execute.

Parameters:

profile - The profile to use for this event.

Returns:

This event

setBreakCondition

public WebWalkEvent setBreakCondition(Condition breakCondition)

Breaks out of the WebWalkEvent with the provided condition; the event can not be resumed.

Parameters:

breakCondition - The break condition to check for

Returns:

This event

setMoveCameraDuringWalking

public WebWalkEvent setMoveCameraDuringWalking(boolean moveCameraDuringWalking)

Sets the camera usage during walking, default value is true.

Parameters:

moveCameraDuringWalking - Sets whether or not the camera can move during walking

Returns:

This event

setHighBreakPriority

public WebWalkEvent setHighBreakPriority(boolean highPriority)

Allows for break conditions to be checked during waits, default value is false.

Parameters:

highPriority - The indicator for high priority breaking

Returns:

This event

setMisclickThreshold

public WebWalkEvent setMisclickThreshold(int misclickThreshold)

Sets the misclick threshold. This value is used to reclick the next tile on the path, when the distance between the destination and the clicked tile is higher or equal to the threshold

Parameters:

misclickThreshold - The threshold to use

Returns:

this

getPositions

public Position[] getPositions()

Gets the positions from the web path

Returns:

The positions from the web path

prefetchRequirements

public boolean prefetchRequirements(MethodProvider provider)

Generates the directions for this WebWalkEvent based on the requirements of PathPreferenceProfile. If no PathPreferenceProfile is declared, a default profile is set. If this method is not called prior to execution, it is called on event execution. You may only prefetch once for the event's instance.

Parameters:

provider - The method provider used for api related calls

Returns:

True if a destination was found and directions were created.

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

getCompletion

public double getCompletion()

Returns:

Percent of directions completed.
Will always return 0.0 if no route was found.
Will always return 100.0 if route has no directions.

getDestination

public Position getDestination()

Gets the position of this event's destination.

Returns:

The Position object that resembles this event's destination; null if no route was found.