Package rs.kreme.ksbot.api.game.magic

Enum RunePouch.RuneSlot

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<RunePouch.RuneSlot>
    Enclosing class:
    RunePouch
    public static enum RunePouch.RuneSlot
extends java.lang.Enum<RunePouch.RuneSlot>
    Enum representing the 3 rune slots inside the Rune Pouch. Each slot contains a rune type varbit and a quantity varbit.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      FIRST  
      SECOND  
      THIRD  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getQuantity()
      Retrieves the current rune quantity stored in this slot.
      java.lang.String getRuneName()
      Retrieves the display name of the rune stored in this slot.
      int getVarbit()
      Retrieves the cached varbit value for this slot's rune type.
      static RunePouch.RuneSlot valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static RunePouch.RuneSlot[] 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 RunePouch.RuneSlot[] 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 (RunePouch.RuneSlot c : RunePouch.RuneSlot.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static RunePouch.RuneSlot 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

      • getVarbit

        public int getVarbit()
        Retrieves the cached varbit value for this slot's rune type.
        Returns:
        The varbit value representing the rune type in this slot, or 0 if unavailable.

      • getRuneName

        public java.lang.String getRuneName()
        Retrieves the display name of the rune stored in this slot.
        Returns:
        The rune name, or null if the slot is empty or invalid.

      • getQuantity

        public int getQuantity()
        Retrieves the current rune quantity stored in this slot.
        Returns:
        The quantity of runes in this slot.