Package com.epicbot.api.shared.methods

Interface IVariablesAPI

  • public interface IVariablesAPI

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int get​(int setting)
      Gets the setting at a given index.
      boolean get​(int setting, int bit)
      Gets the setting as a bit at a given index.
      int get​(int setting, int startBit, int size)
      Gets the setting as a part of the full setting at a given index.
      int getVarbit​(int varbitId)
      Gets a value corresponding to the passed varbit id.
      int getVarbit​(Varbits varbit)
      Gets a value corresponding to the passed varbit.
      int getVarp​(int varpId)
      Gets a value corresponding to the passed varp id.
      int getVarp​(VarPlayer varp)
      Gets a value corresponding to the passed varp.
      int[] getVarps()  

    • Method Detail

      • get

        int get​(int setting)
        Gets the setting at a given index.
        Parameters:
        setting - The setting index to return the value of
        Returns:
        an int representing the setting of the given setting id; otherwise -1.

      • get

        boolean get​(int setting,
            int bit)
        Gets the setting as a bit at a given index.
        Parameters:
        setting - The setting index to return the value of
        bit - The bit index to return the value of.
        Returns:
        the requested bit

      • get

        int get​(int setting,
        int startBit,
        int size)
        Gets the setting as a part of the full setting at a given index.
        Parameters:
        setting - The setting index to return the value of.
        startBit - The bit as which the requested values start.
        size - The size of the value, being a number of bits.
        Returns:
        the requested setting region

      • getVarbit

        int getVarbit​(Varbits varbit)
        Gets a value corresponding to the passed varbit.
        Parameters:
        varbit - the varbit
        Returns:
        the value or -1 if the varbit does not exist

      • getVarbit

        int getVarbit​(int varbitId)
        Gets a value corresponding to the passed varbit id.
        Parameters:
        varbitId - the varbit id
        Returns:
        the value or -1 if the varbit does not exist

      • getVarp

        int getVarp​(VarPlayer varp)
        Gets a value corresponding to the passed varp.
        Parameters:
        varp - the varp
        Returns:
        the value

      • getVarp

        int getVarp​(int varpId)
        Gets a value corresponding to the passed varp id.
        Parameters:
        varpId - the varp id
        Returns:
        the value or -1 if the varp does not exist

      • getVarps

        int[] getVarps()