# FairyRing
Methods to interact with the Fairy rings interface:
```{figure} ../../images/fairyring.png
```


- - -

## ERSFairyRingDial
```pascal
ERSFairyRingDial = enum(LEFT, MIDDLE, RIGHT);
```
Enum representing the {ref}`FairyRing` dials available.


- - -

## TRSFairyRing
Record responsible with interacting with the {ref}`FairyRing`.


- - -

## FairyRing.Setup
```pascal
procedure FairyRing.Setup();
```
Initializes TRSFairyRing variables.

```{note}
This is automatically called on the `FairyRing` variable.
```


- - -

## FairyRing.IsOpen
```pascal
function TRSFairyRing.IsOpen(): Boolean;
```
Returns true/false whether the FairyRing interface is open or not.

Example:
```pascal
WriteLn FairyRing.IsOpen();
```


- - -

## FairyRing.WaitOpen
```pascal
function TRSFairyRing.WaitOpen(time: Integer; interval: Integer = -1): Boolean;
```
Returns true if the fairy ring interface is open within `time` milliseconds.

## Example:
```pascal
WriteLn FairyRing.WaitOpen();
```


- - -

## FairyRing.Close
```pascal
function TRSFairyRing.Close(escape: Boolean): Boolean;
function TRSFairyRing.Close(escapeProbability: Double = BioHash): Boolean; overload;
```
Closes the {ref}`FairyRing` interface, depending on `escape` the function will either
press escape or click the close button:
```{figure} ../../images/fairyring_closebtn.png
```

Example:
```pascal
WriteLn FairyRing.Close();
```


- - -

## FairyRing.HandleItem
```pascal
function TRSFairyRing.HandleItem(): Boolean;
```
Magically finds, caches for next usages and equips dramen or lunar staff with the minimum tab opening possible.
If no item is found, we will assume the user has the elite lumbridge and draynor diary complete for next uses.

Example:
```pascal
 if FairyRing.HandleItem() then
WriteLn FairyRing.Item;
```


- - -

## FairyRing.Open
```pascal
function TRSFairyRing.Open(cuboid: TCuboid): Boolean;
```
Attempts to open the closest fairy ring RSObject.

Example:
```pascal
 WriteLn FairyRing.Open();
```


- - -

## FairyRing.IsLetterValid
```pascal
function TRSFairyRing.IsLetterValid(letter: Char; dial: ERSFairyRingDial): Boolean;
```
Checks if the `letter` passed on is valid for the given `dial`.

Example:
```pascal
WriteLn FairyRing.IsLetterValid('z', ERSFairyRingDial.LEFT);
```


- - -

## FairyRing.IsCodeValid
```pascal
function TRSFairyRing.IsCodeValid(fairyCode: String): Boolean;
```
Checks if the a given `fairyCode` is a valid fairy ring code.

Example:
```pascal
WriteLn FairyRing.IsCodeValid('abc');
```


- - -

## FairyRing.Spin
```pascal
procedure TRSFairyRing.SpinLeft(dial: ERSFairyRingDial);
procedure TRSFairyRing.SpinRight(dial: ERSFairyRingDial);
```
Spins the given `dial` left or right.

Example:
```pascal
WriteLn FairyRing.SpinLeft(ERSFairyRingDial.LEFT);
```

If you want, you can see the left and right dial blick boxes with the following
code:
```pascal
{$I WaspLib/osrs.simba}
begin
  ShowOnTarget(FairyRing.RotateLeftBoxes + FairyRing.RotateRightBoxes);
end.
```
```{figure} ../../images/fairyring_dialspinboxes.png
```


- - -

## FairyRing.Letter
```pascal
property TRSFairyRing.Letter(dial: ERSFairyRingDial): Char;
property TRSFairyRing.Letter(character: Char; dial: ERSFairyRingDial): Boolean;
```
Returns or sets the letter of a fairy ring dial.

Example:
```pascal
WriteLn FairyRing.Letter[ERSFairyRingDial.RIGHT];
WriteLn FairyRing.Letter['p', ERSFairyRingDial.RIGHT];
WriteLn FairyRing.Letter[ERSFairyRingDial.RIGHT];
```

The letter in question that will be read or set is the one that is in the dial
"hole":
```pascal
{$I WaspLib/osrs.simba}
begin
  ShowOnTarget(FairyRing.DialHoles);
end.
```
```{figure} ../../images/fairyring_dialholes.png
```


- - -

## FairyRing.Code
```pascal
property TRSFairyRing.Code: String;
property TRSFairyRing.Code(code: String): Boolean;
```
Returns the current fairy ring code or sets the new one in the dials.

Example:
```pascal
WriteLn FairyRing.Code;
WriteLn FairyRing.Code['DLP'];
WriteLn FairyRing.Code;
```


- - -

## FairyRing.ClickTeleport
```pascal
function TRSFairyRing.ClickTeleport(): Boolean;
```
Clicks the fairy ring the teleport button:
```{figure} ../../images/fairyring_teleportbtn.png
```

Example:
```pascal
WriteLn FairyRing.ClickTeleport();
```


- - -

## FairyRing TravelLog
This next section is about the fairy ring travel log {ref}`GameTab` menu:
```{figure} ../../images/fairyring_travellog.png
```


- - -

### FairyRing.GetLogCodes
```pascal
function TRSFairyRing.GetLogCodes(out boxes: TBoxArray): TStringArray;
function TRSFairyRing.GetLogCodes(): TStringArray; overload;
```
Returns the visible codes in the fairy ring travel log.

Example:
```pascal
{$I WaspLib/osrs.simba}
var
  logs: TStringArray;
  boxes: TBoxArray;
begin
  logs := FairyRing.GetLogCodes(boxes);
  if logs <> [] then
  begin
    WriteLn logs;
    ShowOnTarget(boxes);
  end;
end.
```
```{figure} ../../images/fairyring_logs.png
```


- - -

### FairyRing.FindLogCode
```pascal
function TRSFairyRing.FindLogCode(code: String; out b: TBox): Boolean;
function TRSFairyRing.FindLogCode(code: String): Boolean; overload;
```
Finds the code specified in the travel log. Codes casing is ignored.

Example:
```pascal
{$I WaspLib/osrs.simba}

var
  b: TBox;
begin
  if FairyRing.FindLogCode('ALQ', b) then
    ShowOnTarget(b);
end.
```
```{figure} ../../images/fairyring_findlog.png
```


- - -

### FairyRing.ClickLogCode
```pascal
function TRSFairyRing.ClickLogCode(fairyCode: String): Boolean;
```
Finds and clicks the `fairyCode` specified in the travel log.
Codes casing is ignored.

Example:
```pascal
WriteLn FairyRing.ClickLogCode('cip');
```


- - -

## FairyRing.HandleInterface
```pascal
function TRSFairyRing.HandleInterface(code: String): Boolean;
```
Completely handles the fairy ring interface to set a code and teleport.
Will use both the log and the dials depending on the user biohash.

Example:
```pascal
WriteLn FairyRing.HandleInterface('cip');
```


- - -

## FairyRing.Teleport
```pascal
function TRSFairyRing.Teleport(fairyCode: String; cuboid: TCuboid): Boolean;
```
Teleports the user to the specified fairy ring code.
If the fairy ring interface is not open, the `RSObject` will be used to find the closest one and open it.
If the code is on the right click context menu, it will be used.
You can also optional pass in "Zanaris" or "BKS" to go to zanaris.

Example:
```pascal
WriteLn FairyRing.Teleport('cip');
```


- - -

## FairyRing variable
Global {ref}`TRSFairyRing` variable.