# WorldHopper

Made by @Yolandi, modified by @Torwent.

World hopper is resposible for hopping worlds with the logged in world hopper in the logout tab.


- - -

## type TRSWorldHopper
```pascal
type
  TRSWorldHopper = record(TRSInterface)
    SILVER, YELLOW: Int32;
    ReadyTime: UInt64;
  end;
```
WorldHopper record.


- - -

## TRSWorldHopper.Setup
```pascal
procedure TRSWorldHopper.Setup(); override;
```
Internal method used to setup the WorldHopper.


- - -

## TRSWorldHopper.Scroll
```pascal
procedure TRSWorldHopper.Scroll(down: Boolean);
```
Scroll one page up or down of the world hopper.

Example:
```pascal
TRSWorldHopper.Scroll(True);
```


- - -

## TRSWorldHopper.ClickWorld
```pascal
procedure TRSWorldHopper.ClickWorld(ocrBounds: TBox);
```
Click a world in the world hopper.

Example:
```pascal
TRSWorldHopper.ReadWorlds(ocrBounds);
TRSWorldHopper.ClickWorld(ocrBounds[0]);
```


- - -

## TRSWorldHopper.GetCurrentWorld
```pascal
function TRSWorldHopper.GetCurrentWorld(): Int32;
```
Returns the current world we are on.

Example:
```pascal
WriteLn TRSWorldHopper.GetCurrentWorld();
```


- - -

## TRSWorldHopper.ReadWorlds
```pascal
function TRSWorldHopper.ReadWorlds(out boxes: TBoxArray): TIntegerArray;
function TRSWorldHopper.ReadWorlds(): TIntegerArray;  overload;
```
Returns currently visible worlds.

Example:
```pascal
WriteLn TRSWorldHopper.ReadWorlds();
```


- - -

## TRSWorldHopper.WaitForHop
```pascal
function TRSWorldHopper.WaitForHop(world: Int32; ocrBounds: TBox; coolDownOnFail: Boolean=True): Boolean;
```
Exits false if "Please wait" not found, presumably due to combat.


- - -

## TRSWorldHopper.Hop
```pascal
function TRSWorldHopper.Hop(targetWorlds: TIntegerArray): Boolean;
```
Hops to a different world from the specified **targetWorlds**.

Example:
```pascal
WriteLn TRSWorldHopper.Hop([303, 304, 305]);
```