org.osbot.rs07.event

Class WalkingEvent

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.event.Event

org.osbot.rs07.event.WalkingEvent

public class WalkingEvent
extends Event

Represents an event which task it is to perform walking.

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, 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
WalkingEvent() Creates a walking event for which a path will need to be set with the setPath() methods.
WalkingEvent(Area area) Creates a walking event with a minDistanceThreshold of 2 and a miniMapDistanceThreshold of 5 to a random location within the given area.
WalkingEvent(Entity entity) Creates a walking event with a minDistanceThreshold of 2 and a miniMapDistanceThreshold of 5 to the location of the given entity.
WalkingEvent(Position position) Creates a walking event with a minDistanceThreshold of 2 and a miniMapDistanceThreshold of 5 to the location of the given position.

Method Summary

Modifier and Type	Method and Description
int	execute() This is the execution method.
int	getEnergyThreshold()
int	getMinDistanceThreshold() This methods gets the property of this walking event that determines the walking accuracy to the destination you have specified.
int	getMiniMapDistanceThreshold() This method returns the property of this walking event that determines whether the next position you're walking to in the path from A to B will be walked to by using the mini map or the main screen.
java.util.List<Position>	getPath() Returns the list of positions that represent the path associated with this event.
boolean	isOperateCamera() This method gets the property of this walking event that determines whether or not the camera is allowed to be used by this event.
void	onStart() Called before this event is executed.
WalkingEvent	setBreakCondition(Condition breakCondition) Sets the break condition for this walking event
void	setEnergyThreshold(int energyThreshold) Path walker methods use energyThreshold to activate run mid-path.
WalkingEvent	setHighBreakPriority(boolean highPriority) Allows for break conditions to be checked during waits, default value is false.
WalkingEvent	setMinDistanceThreshold(int minDistanceThreshold) This methods sets the property of this walking event that determines the walking accuracy to the destination you have specified.
WalkingEvent	setMiniMapDistanceThreshold(int miniMapDistanceThreshold) This method sets the property of this walking event that determines whether the next position you're walking to in the path from A to B will be walked to by using the mini map or the main screen.
WalkingEvent	setOperateCamera(boolean operateCamera) This method sets the property of this walking event that determines whether or not the camera is allowed to be used by this event.
WalkingEvent	setPath(java.util.LinkedList<Position> path) This method sets the path of this event.

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

WalkingEvent

public WalkingEvent()

Creates a walking event for which a path will need to be set with the setPath() methods.

WalkingEvent

public WalkingEvent(Entity entity)

Creates a walking event with a minDistanceThreshold of 2 and a miniMapDistanceThreshold of 5 to the location of the given entity.

Parameters:

entity - The entity which location to walk to.

WalkingEvent

public WalkingEvent(Position position)

Creates a walking event with a minDistanceThreshold of 2 and a miniMapDistanceThreshold of 5 to the location of the given position.

Parameters:

position - The position to walk to.

WalkingEvent

public WalkingEvent(Area area)

Creates a walking event with a minDistanceThreshold of 2 and a miniMapDistanceThreshold of 5 to a random location within the given area.

Parameters:

area - The area to walk to.

Method Detail

isOperateCamera

public boolean isOperateCamera()

This method gets the property of this walking event that determines whether or not the camera is allowed to be used by this event.

Returns:

True if this event is allowed to use the camera.

getMinDistanceThreshold

public int getMinDistanceThreshold()

This methods gets the property of this walking 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 2.

Returns:

The minimum distance threshold.

getMiniMapDistanceThreshold

public int getMiniMapDistanceThreshold()

This method returns the property of this walking event that determines whether the next position you're walking to in the path from A to B will be walked to by using the mini map or the main screen. The next location you're walking to is not necessarily the destination of this event, but the next clickable position in the path from A to B. If the distance to the next clickable position is equal or higher than the mini map distance threshold, this event will walk using the mini map. If not, it will use the main screen. The default value of this property is 5.

Returns:

The mini map walking distance threshold.

setEnergyThreshold

public void setEnergyThreshold(int energyThreshold)

Path walker methods use energyThreshold to activate run mid-path.

Parameters:

energyThreshold - The energy level which is permissible to activate run.

getEnergyThreshold

public int getEnergyThreshold()

Returns:

The energyThreshold used to activate run mid-path.

getPath

public java.util.List<Position> getPath()

Returns the list of positions that represent the path associated with this event.

Returns:

The list of positions that represent the path associated with this event.

setMinDistanceThreshold

public WalkingEvent setMinDistanceThreshold(int minDistanceThreshold)

This methods sets the property of this walking 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 3.

Parameters:

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

Returns:

This event for chained method calls.

setMiniMapDistanceThreshold

public WalkingEvent setMiniMapDistanceThreshold(int miniMapDistanceThreshold)

This method sets the property of this walking event that determines whether the next position you're walking to in the path from A to B will be walked to by using the mini map or the main screen. The next location you're walking to is not necessarily the destination of this event, but the next clickable position in the path from A to B. If the distance to the next clickable position is equal or higher than the mini map distance threshold, this event will walk using the mini map. If not, it will use the main screen. The default value of this property is 5.

Parameters:

miniMapDistanceThreshold - The threshold value.

Returns:

This event for chained method calls.

setOperateCamera

public WalkingEvent setOperateCamera(boolean operateCamera)

This method sets the property of this walking event that determines whether or not the camera is allowed to be used by this event.

Parameters:

operateCamera - True if you want this event to be allowed to use the camera.

Returns:

This event for chained method calls.

setPath

public WalkingEvent setPath(java.util.LinkedList<Position> path)

This method sets the path of this event. This can be used to use a specific pre calculated or static path.

Parameters:

path - The path for this event to walk.

Returns:

This event for chained method calls.

setBreakCondition

public WalkingEvent setBreakCondition(Condition breakCondition)

Sets the break condition for this walking event

Parameters:

breakCondition - The break condition

Returns:

This event

setHighBreakPriority

public WalkingEvent 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

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

onStart

public void onStart()

Description copied from class: Event

Called before this event is executed.

Overrides:

onStart in class Event