Package net.eternalclient.api.wrappers.prayer

Class Prayers

  • public class Prayers
extends java.lang.Object
    This class provides methods to interact with prayer functionality in the game.

    • Constructor Detail

      • Prayers

        public Prayers()

    • Method Detail

      • isOpen

        public static boolean isOpen()
        Checks if the prayer tab is currently open.
        Returns:
        true if the prayer tab is open, false otherwise.

      • openTab

        public static boolean openTab()
        Opens the Prayer tab.
        Returns:
        true if the Prayer tab is successfully opened, false otherwise

      • getWidgetChild

        public static WidgetChild getWidgetChild​(Prayer prayer)
        Returns the associated widget child for the given Prayer.
        Parameters:
        prayer - the Prayer instance to retrieve the widget child from
        Returns:
        the widget child associated with the given Prayer instance

      • isActive

        public static boolean isActive​(Prayer... prayers)
        Checks if all the given prayers are active.
        Parameters:
        prayers - the prayers to check
        Returns:
        true if all prayers are active, false otherwise

      • isInactive

        public static boolean isInactive​(Prayer... prayers)
        Checks if any of the given prayers are active.
        Parameters:
        prayers - the prayers to check for activity
        Returns:
        true if none of the prayers are active, false otherwise

      • isAnyActive

        public static boolean isAnyActive​(Prayer... prayers)
        Checks if any of the specified prayers are currently active.
        Parameters:
        prayers - the prayers to check
        Returns:
        true if any of the prayers are active, false otherwise

      • isAnyInactive

        public static boolean isAnyInactive​(Prayer... prayers)
        Checks if any of the given prayers are inactive.
        Parameters:
        prayers - the prayers to check
        Returns:
        true if any of the prayers are inactive, false otherwise

      • getActive

        public static Prayer[] getActive()
        Returns an array of active prayer objects.
        Returns:
        an array of active prayer objects.

      • activate

        public static boolean activate​(Prayer prayer)
        Activates the given prayer if it is not already active.
        Parameters:
        prayer - the prayer to activate
        Returns:
        true if the prayer is successfully activated, false otherwise

      • deactivate

        public static boolean deactivate​(Prayer prayer)
        Deactivates a specified prayer.
        Parameters:
        prayer - the prayer to be deactivated
        Returns:
        true if the prayer was successfully deactivated, false if the prayer is null or already inactive

      • forceActivate

        public static boolean forceActivate​(Prayer prayer)
        Activates the specified prayer if it is not already active.
        Parameters:
        prayer - the prayer to be activated
        Returns:
        true if the prayer was successfully activated; false otherwise

      • forceDeactivate

        public static boolean forceDeactivate​(Prayer prayer)
        Deactivates the specified prayer.
        Parameters:
        prayer - the prayer to be deactivated
        Returns:
        true if the prayer was successfully deactivated, false otherwise

      • enable

        public static boolean enable​(Prayer... prayers)
        Enables the specified prayers and waits until they are active.
        Parameters:
        prayers - the array of prayers to enable
        Returns:
        true if the prayers are enabled and active, false otherwise

      • disable

        public static boolean disable​(Prayer... prayers)
        Disables the given prayers.
        Parameters:
        prayers - an array of prayers to be disabled
        Returns:
        true if the prayers are successfully disabled, false otherwise

      • forceEnable

        public static boolean forceEnable​(Prayer... prayers)
        Forces the enablement of specified prayers.
        Parameters:
        prayers - the prayers to be force enabled
        Returns:
        true if all specified prayers are successfully enabled, false otherwise

      • forceDisable

        public static boolean forceDisable​(Prayer... prayers)
        Forces the disablement of the specified prayers.
        Parameters:
        prayers - the prayers to be force-disabled
        Returns:
        true if all prayers were successfully force-disabled, false otherwise

      • isQuickPrayersActive

        public static boolean isQuickPrayersActive()
        Checks if the Quick Prayer is active.
        Returns:
        true if the Quick Prayer is active, false otherwise.

      • isQuickPrayerEnabled

        public static boolean isQuickPrayerEnabled​(Prayer... prayers)

      • isAnyQuickPrayerEnabled

        public static boolean isAnyQuickPrayerEnabled​(Prayer... prayers)

      • isQuickPrayerDisabled

        public static boolean isQuickPrayerDisabled​(Prayer... prayers)

      • isAnyQuickPrayerDisabled

        public static boolean isAnyQuickPrayerDisabled​(Prayer... prayers)

      • isQuickPrayersSetupOpen

        public static boolean isQuickPrayersSetupOpen()

      • openQuickPrayersSetup

        public static boolean openQuickPrayersSetup()

      • closeQuickPrayersSetup

        public static boolean closeQuickPrayersSetup()

      • enableQuickPrayer

        public static boolean enableQuickPrayer​(Prayer... prayers)

      • disableQuickPrayer

        public static boolean disableQuickPrayer​(Prayer... prayers)

      • activateQuickPrayers

        public static boolean activateQuickPrayers()
        Enables the Quick Prayer if it is not already active.
        Returns:
        true if the Quick Prayer is successfully enabled, false otherwise.

      • deactivateQuickPrayers

        public static boolean deactivateQuickPrayers()
        Disables the Quick Prayer function if it is currently active.
        Returns:
        true if Quick Prayer is successfully disabled, false otherwise.

      • getQuickPrayerWidgetChild

        public static WidgetChild getQuickPrayerWidgetChild()
        Retrieves the WidgetChild that represents the quick prayer orb on the minimap.
        Returns:
        the WidgetChild representing the quick prayer orb

      • flickQuickPrayers

        public static void flickQuickPrayers()
        Toggles the quick prayer widget between "Activate" and "Deactivate" actions.