org.osbot.rs07.api

Class Worlds

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.API

org.osbot.rs07.api.Worlds

public class Worlds
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
Worlds()

Method Summary

Modifier and Type	Method and Description
boolean	cancelSwitch()
boolean	confirmSwitch()
java.util.List<World>	getAvailableWorlds(boolean all) Gets a list with all available worlds to hop to
java.util.List<World>	getAvailableWorlds(boolean all, java.util.concurrent.Callable<java.lang.Boolean> breakCondition) Gets a list with all available worlds to hop to
int	getCurrentWorld()
java.awt.Rectangle	getViewport()
RS2Widget	getViewportWidget()
boolean	hop(int world) Hops to the specified world id if the destination is not already the world you are in.
boolean	hop(int world, boolean allowedWorldsOnly) Hops to the specified world id if the destination is not already the world you are in.
boolean	hop(int world, boolean allowedWorldsOnly, java.util.concurrent.Callable<java.lang.Boolean> breakCondition) Hops to the specified world id if the destination is not already the world you are in.
boolean	hop(int world, java.util.concurrent.Callable<java.lang.Boolean> breakCondition) Hops to the specified world id if the destination is not already the world you are in.
boolean	hopToF2PWorld() Hops to a random F2P server which is not full or is PvP.
boolean	hopToF2PWorld(java.util.concurrent.Callable<java.lang.Boolean> breakCondition) Hops to a random F2P server which is not full or is PvP.
boolean	hopToP2PWorld() Hops to a random P2P server which is not full or is PvP.
boolean	hopToP2PWorld(java.util.concurrent.Callable<java.lang.Boolean> breakCondition) Hops to a random P2P server which is not full or is PvP.
boolean	hover(int world) Hovers the mouse over the world
boolean	hover(int world, java.util.concurrent.Callable<java.lang.Boolean> breakCondition) Hovers the mouse over the world
void	initializeModule()
boolean	isMembersWorld()
boolean	isOpen()
boolean	isWorldAllowedForHop(World world) Checks if a world is allowed to be hopped to

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

Worlds

public Worlds()

Method Detail

initializeModule

public void initializeModule()

Specified by:

initializeModule in class API

getViewport

public java.awt.Rectangle getViewport()

getViewportWidget

public RS2Widget getViewportWidget()

isOpen

public boolean isOpen()

cancelSwitch

public boolean cancelSwitch()

confirmSwitch

public boolean confirmSwitch()

hover

public boolean hover(int world)

Hovers the mouse over the world

Parameters:

world - the world to hover

Returns:

True if the mouse is intersecting with the world

hover

public boolean hover(int world,
                     java.util.concurrent.Callable<java.lang.Boolean> breakCondition)

Hovers the mouse over the world

Parameters:

world - the world to hover

breakCondition - Return true to break the hopping process

Returns:

True if the mouse is intersecting with the world

getAvailableWorlds

public java.util.List<World> getAvailableWorlds(boolean all)

Gets a list with all available worlds to hop to

Parameters:

all - True for all worlds, False to filter out worlds that are not allowed to be hopped to

Returns:

A list with all available worlds to hop to

getAvailableWorlds

public java.util.List<World> getAvailableWorlds(boolean all,
                                                java.util.concurrent.Callable<java.lang.Boolean> breakCondition)

Gets a list with all available worlds to hop to

Parameters:

all - True for all worlds, False to filter out worlds that are not allowed to be hopped to

breakCondition - Return true to break the hopping process

Returns:

A list with all available worlds to hop to

getCurrentWorld

public int getCurrentWorld()

Returns:

The current world id.

isMembersWorld

public boolean isMembersWorld()

Returns:

Whether current world pay to play.

isWorldAllowedForHop

public boolean isWorldAllowedForHop(World world)

Checks if a world is allowed to be hopped to

Parameters:

world - the world to check

Returns:

True if the world is allowed to be hopped to

hopToP2PWorld

public boolean hopToP2PWorld()

Hops to a random P2P server which is not full or is PvP.

hopToP2PWorld

public boolean hopToP2PWorld(java.util.concurrent.Callable<java.lang.Boolean> breakCondition)

Hops to a random P2P server which is not full or is PvP.

Parameters:

breakCondition - Return true to break the hopping process

hopToF2PWorld

public boolean hopToF2PWorld()

Hops to a random F2P server which is not full or is PvP.

hopToF2PWorld

public boolean hopToF2PWorld(java.util.concurrent.Callable<java.lang.Boolean> breakCondition)

Hops to a random F2P server which is not full or is PvP.

Parameters:

breakCondition - Return true to break the hopping process

hop

public boolean hop(int world)

Hops to the specified world id if the destination is not already the world you are in.

Parameters:

world - The world to hop to

Returns:

hop(int, boolean) world, true

hop

public boolean hop(int world,
                   boolean allowedWorldsOnly)

Hops to the specified world id if the destination is not already the world you are in.

Parameters:

world - The world to hop to

allowedWorldsOnly - True to only hop to worlds for which isWorldAllowedForHop(World) returns true

Returns:

hop(int, boolean, Callable) world, allowedWorldsOnly, () -> false

hop

public boolean hop(int world,
                   java.util.concurrent.Callable<java.lang.Boolean> breakCondition)

Hops to the specified world id if the destination is not already the world you are in.

Parameters:

world - The world to hop to

breakCondition - Return true to break the hopping process

Returns:

hop(int, boolean, Callable) world, true, breakCondition

hop

public boolean hop(int world,
                   boolean allowedWorldsOnly,
                   java.util.concurrent.Callable<java.lang.Boolean> breakCondition)

Hops to the specified world id if the destination is not already the world you are in.

Parameters:

world - The world to hop to

allowedWorldsOnly - True to only hop to worlds for which isWorldAllowedForHop(World) returns true

breakCondition - Return true to break the hopping process

Returns:

True when already in the world or successfully hopped to the world.