org.osbot.rs07.api

Class Walking

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.API

org.osbot.rs07.api.Walking

public class Walking
extends API

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
Walking()

Method Summary

Modifier and Type	Method and Description
void	initializeModule()
boolean	walk(Area area) Walks to the given area with a default WalkingEvent instance.
boolean	walk(Entity entity) Walks to the given entity its location with a default WalkingEvent instance.
boolean	walk(Position position) Walks to the position given with a default WalkingEvent instance.
boolean	walkPath(java.util.List<Position> positions) Walks a path using the order in the provided position list.
boolean	webWalk(Area... areas) Walks to the closest reachable position within given areas with a default WebWalkEvent instance.
boolean	webWalk(Position... positions) Walks to the closest reachable position in given positions array.

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

exchangeContext, 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

Walking

public Walking()

Method Detail

initializeModule

public void initializeModule()

Specified by:

initializeModule in class API

walk

public boolean walk(Position position)

Walks to the position given with a default WalkingEvent instance.

Parameters:

position - The destination.

Returns:

Whether or not the walking event executed terminated successfully.

walk

public boolean walk(Entity entity)

Walks to the given entity its location with a default WalkingEvent instance.

Parameters:

entity - The entity destination.

Returns:

Whether or not the walking event executed terminated successfully.

walk

public boolean walk(Area area)

Walks to the given area with a default WalkingEvent instance.

Parameters:

area - The area destination.

Returns:

Whether or not the walking event executed terminated successfully.

walkPath

public boolean walkPath(java.util.List<Position> positions)

Walks a path using the order in the provided position list. This method will start the path wherever your player is closest to in the position list. If your player cannot reach a position in the path, this method will attempt to generate a new path that will find the unreachable position.

Parameters:

positions - The position list which you wish to traverse.

Returns:

True if all positions have been reached.

webWalk

public boolean webWalk(Area... areas)

Walks to the closest reachable position within given areas with a default WebWalkEvent instance.

Parameters:

areas - The areas.

Returns:

Whether or not the web walking event executed terminated successfully.

webWalk

public boolean webWalk(Position... positions)

Walks to the closest reachable position in given positions array.

Parameters:

positions - The positions.

Returns:

Whether or not the web walking event executed terminated successfully.