Package org.dreambot.api.methods.fairyring

Class FairyRings

  • public class FairyRings
extends java.lang.Object
    Created by Nezz on 10/4/2016.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static boolean codeEquals​(java.lang.String[] code)
      Checks if the current code of the fairy ring equals the given code Ignores case
      static boolean enterCode​(int slot, java.lang.String letter)
      Enters a letter for a given slot First slot starts at 0
      static boolean enterTravelCode​(java.lang.String[] s)
      See enterTravelCode(FairyLocation fl)
      static boolean enterTravelCode​(FairyLocation fl)
      Enters the code for a given fairy location
      static java.lang.String getCode​(int slot)
      Gets the current letter of a given slot in the fairy code
      static java.lang.String[] getCurrentCode()
      Gets the current fairy ring code as a String array
      static java.awt.Rectangle getQuickTravelRect()
      Gets the Rectangle surrounding the quick travel widget container
      static boolean openTravelInterface()
      Opens the fairy ring travel interface, if a fairy ring is available and it is not already open
      static boolean quickTravel​(java.lang.String[] code)
      See quickTravel(FairyLocation fl)
      static boolean quickTravel​(FairyLocation fl)
      Travels using the quick travel list on the fairy ring
      static boolean quickTravelContains​(java.lang.String[] s)
      See quickTravelContains(FairyLocation fl)
      static boolean quickTravelContains​(FairyLocation fl)
      Checks if a fairy location is within your quick travel list
      static boolean rotateSlotClockwise​(int slot)
      Rotates a slot clockwise once
      static boolean scrollToQuickTravel​(java.lang.String[] code)
      Scrolls to the quick travel widget with the given code
      static boolean travel​(java.lang.String[] code)
      See travel(FairyLocation fl) Except given the code as a String array (ignores upper/lower case)
      static boolean travel​(FairyLocation location)
      Travels to a fairy location, if it exists in your quick travel list, it will use the quick travel otherwise it will enter the code and click travel.
      static boolean travelInterfaceOpen()
      Checks if the fairy ring travel interface is open

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getQuickTravelRect

        public static java.awt.Rectangle getQuickTravelRect()
        Gets the Rectangle surrounding the quick travel widget container
        Returns:

      • travelInterfaceOpen

        public static boolean travelInterfaceOpen()
        Checks if the fairy ring travel interface is open
        Returns:

      • travel

        public static boolean travel​(FairyLocation location)
        Travels to a fairy location, if it exists in your quick travel list, it will use the quick travel otherwise it will enter the code and click travel. It will handle opening the interface (if near a fairy ring)
        Parameters:
        location - The location you'd like to travel to
        Returns:
        True if successfully travels, otherwise false

      • openTravelInterface

        public static boolean openTravelInterface()
        Opens the fairy ring travel interface, if a fairy ring is available and it is not already open
        Returns:

      • travel

        public static boolean travel​(java.lang.String[] code)
        See travel(FairyLocation fl) Except given the code as a String array (ignores upper/lower case)
        Parameters:
        code - Fairy code to enter
        Returns:

      • quickTravel

        public static boolean quickTravel​(FairyLocation fl)
        Travels using the quick travel list on the fairy ring
        Parameters:
        fl -
        Returns:

      • quickTravel

        public static boolean quickTravel​(java.lang.String[] code)
        See quickTravel(FairyLocation fl)
        Parameters:
        code - Fairy code given as an array
        Returns:

      • scrollToQuickTravel

        public static boolean scrollToQuickTravel​(java.lang.String[] code)
        Scrolls to the quick travel widget with the given code
        Parameters:
        code - fairy code as a String array
        Returns:

      • quickTravelContains

        public static boolean quickTravelContains​(FairyLocation fl)
        Checks if a fairy location is within your quick travel list
        Parameters:
        fl -
        Returns:

      • quickTravelContains

        public static boolean quickTravelContains​(java.lang.String[] s)
        See quickTravelContains(FairyLocation fl)
        Parameters:
        s - Fairy code given as a String array
        Returns:

      • codeEquals

        public static boolean codeEquals​(java.lang.String[] code)
        Checks if the current code of the fairy ring equals the given code Ignores case
        Parameters:
        code - Fairy ring code given as a String array
        Returns:

      • enterTravelCode

        public static boolean enterTravelCode​(FairyLocation fl)
        Enters the code for a given fairy location
        Parameters:
        fl -
        Returns:

      • enterTravelCode

        public static boolean enterTravelCode​(java.lang.String[] s)
        See enterTravelCode(FairyLocation fl)
        Parameters:
        s - Fairy code given as a String array
        Returns:

      • enterCode

        public static boolean enterCode​(int slot,
                                java.lang.String letter)
        Enters a letter for a given slot First slot starts at 0
        Parameters:
        slot - Slot of the code
        letter - Letter you wish the code to be
        Returns:
        Whether it successfully changes the code to the given code

      • rotateSlotClockwise

        public static boolean rotateSlotClockwise​(int slot)
        Rotates a slot clockwise once
        Parameters:
        slot - slot to rotate, first slot is 0
        Returns:
        True if the code changes, otherwise false.

      • getCurrentCode

        public static java.lang.String[] getCurrentCode()
        Gets the current fairy ring code as a String array
        Returns:

      • getCode

        public static java.lang.String getCode​(int slot)
        Gets the current letter of a given slot in the fairy code
        Parameters:
        slot - Slot in code, first slot is 0
        Returns: