org.osbot.rs07.api

Class Prayer

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.API

org.osbot.rs07.api.Prayer

public class Prayer
extends API

Represents the API for prayer functionality.

Field Summary

Fields inherited from class org.osbot.rs07.script.MethodProvider

bank, bot, camera, chatbox, client, colorPicker, combat, configs, depositBox, dialogues, diaries, display, doorHandler, equipment, experienceTracker, favour, grandExchange, graphicObjects, groundItems, hintArrow, inventory, keyboard, logger, logoutTab, magic, map, menu, mouse, npcs, objects, players, prayer, projectiles, quests, settings, skills, store, tabs, trade, walking, widgets, worlds

Constructor Summary

Constructors

Constructor and Description
Prayer()

Method Summary

Modifier and Type	Method and Description
boolean	deactivateAll() Deactivates all prayers.
RS2Widget	getWidgetForPrayer(PrayerButton prayer) Gets the widget for a specific PrayerButton
boolean	hasLevelFor(PrayerButton prayer) Returns whether you have the required level to use the specified prayer.
void	initializeModule()
boolean	isActivated(PrayerButton prayer) Returns true if designated prayer is turned on.
boolean	isQuickPrayerActive() Checks to see if your quick prayer is active.
boolean	open() Opens the prayer tab.
boolean	set(PrayerButton prayer, boolean activate) Activates or deactivates the specified prayer if you have the required level.
boolean	setQuickPrayer(boolean activate) Activates or deactivates the quick prayer.

Methods inherited from class org.osbot.rs07.script.MethodProvider

exchangeContext, execute, getBank, getBot, getCamera, getChatbox, getClient, getColorPicker, getCombat, getConfigs, getDepositBox, getDialogues, getDiaries, getDisplay, getDoorHandler, getEquipment, getExperienceTracker, getFavour, getGrandExchange, getGraphicObjects, getGroundItems, getHintArrow, getInventory, getKeyboard, getLogoutTab, getMagic, getMap, getMenuAPI, getMouse, getNpcs, getObjects, getPlayers, getPrayer, getProjectiles, getQuests, getSettings, getSkills, getStore, getTabs, getTrade, getWalking, getWidgets, getWorlds, gRandom, gRandom, gRandom, initializeContext, log, log, myPlayer, myPosition, random, random, sleep, stripFormatting, warn

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Prayer

public Prayer()

Method Detail

getWidgetForPrayer

public RS2Widget getWidgetForPrayer(PrayerButton prayer)

Gets the widget for a specific PrayerButton

Parameters:

prayer - The prayer to get the widget for

Returns:

The widget for a specific PrayerButton

set

public boolean set(PrayerButton prayer,
                   boolean activate)

Activates or deactivates the specified prayer if you have the required level.

Parameters:

prayer - The prayer to activate or deactivate.

activate - True to activate; False to deactivate.

Returns:

True if the prayer was successfully activated or deactivated as specified. False if the required level is not met.

setQuickPrayer

public boolean setQuickPrayer(boolean activate)

Activates or deactivates the quick prayer.

Parameters:

activate - True to activate; False to deactivate.

Returns:

True if the quick prayer was successfully activated or deactivated as specified.

deactivateAll

public boolean deactivateAll()

Deactivates all prayers. Returns true if succeeded, false if it failed to deactivate all prayers.

Returns:

True if all prayers were deactivated correctly.

isActivated

public boolean isActivated(PrayerButton prayer)

Returns true if designated prayer is turned on.

Parameters:

prayer - The prayer.

Returns:

True if enabled; otherwise false.

hasLevelFor

public boolean hasLevelFor(PrayerButton prayer)

Returns whether you have the required level to use the specified prayer.

Parameters:

prayer - The prayer to check the level requirement for.

Returns:

True if meeting the required level.

open

public boolean open()

Opens the prayer tab.

Returns:

True if succeeded.

isQuickPrayerActive

public boolean isQuickPrayerActive()

Checks to see if your quick prayer is active.

Returns:

True if your quick prayer is active.

initializeModule

public void initializeModule()

Specified by:

initializeModule in class API