Package com.kraken.api.service.prayer

Enum InteractablePrayer

    • Method Detail

      • values

        public static InteractablePrayer[] 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 (InteractablePrayer c : InteractablePrayer.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static InteractablePrayer 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

      • isActive

        public boolean isActive()
        Checks whether the current @InteractablePrayer is active.

        A prayer is considered active if its corresponding varbit value equals 1 in the game's internal context.

        Returns:
        true if the prayer is active; false otherwise.

      • of

        public static InteractablePrayer of​(net.runelite.api.Prayer p)
        Returns the Kraken prayer (from this class) given a RuneLite API Prayer enum or null if the prayer doesn't exist.
        Parameters:
        p - RuneLite prayer
        Returns:
        Kraken Prayer (Prayers)

      • runelitePrayerFor

        public static net.runelite.api.Prayer runelitePrayerFor​(InteractablePrayer p)
        Maps an @InteractablePrayer to its corresponding @Prayer from the RuneLite API. If no matching prayer is found, returns null.

        This method iterates through all values of the @Prayer enum and matches them based on their varbit value.

        Parameters:
        p - The @InteractablePrayer instance whose corresponding @Prayer needs to be determined. Must not be null.
        Returns:
        The @Prayer instance matching the specified @InteractablePrayer. Returns null if no match is found.

      • isOverhead

        public static boolean isOverhead​(InteractablePrayer p)
        Determines whether the specified @InteractablePrayer is classified as an overhead prayer.

        Overhead prayers are typically characterized by specific protections or effects activated during player interaction.

        Parameters:
        p - The @InteractablePrayer to be checked. Must not be null.
        Returns:
        true if the given prayer is an overhead prayer; false otherwise.