Package rs.kreme.ksbot.api.game

Enum Prayer.Prayerbook

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Prayer.Prayerbook>
    Enclosing class:
    Prayer
    public static enum Prayer.Prayerbook
extends java.lang.Enum<Prayer.Prayerbook>
    Enum representing the different prayer books.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ANY  
      RUINOUS  
      STANDARD  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Prayer.Prayerbook getClientPrayerbook()
      Retrieves the current prayer book active on the client.
      static Prayer.Prayerbook valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Prayer.Prayerbook[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • values

        public static Prayer.Prayerbook[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Prayer.Prayerbook c : Prayer.Prayerbook.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Prayer.Prayerbook valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getClientPrayerbook

        public static Prayer.Prayerbook getClientPrayerbook()
        Retrieves the current prayer book active on the client. For simplicity, currently defaults to STANDARD.
        Returns:
        The active prayer book.