quickPrayersActive
quickPrayersActive: (Prayers) -> booleanWhether quick prayers are switched on.
player:prayer()| Method | Returns | Description |
|---|---|---|
quickPrayersActive() | boolean | Whether quick prayers are switched on. |
quickPrayersConfigured() | boolean | Whether any prayers are assigned to the quick-prayer slot. |
prayerbook() | Prayerbook? | The active prayerbook. |
active() | { string } | Every prayer currently on, by display name. |
isActive(Prayer | string) | boolean | Whether one prayer is on. |
isAvailable(Prayer | string) | boolean | Whether the prayer is in the active book and its level and unlock requirements are met. Uses the boosted Prayer level inside LMS. |
activate(Prayer | string) | boolean | Switch a prayer on. |
deactivate(Prayer | string) | boolean | Switch a prayer off, when it is on. |
flick({ Prayer | string }) | boolean | Flick prayers: on ones are toggled off and back on, off ones are switched on, every press together in one game tick or not at all, joining… |
offensivePrayers(AttackStyle) | { string } | The best available offensive set for an attack style, by display name, without causing any input. |
activateOffensivePrayers(AttackStyle?) | boolean | Switch on the best offensive set for an attack style. |
deactivateOffensivePrayers() | boolean | Switch off the offensive prayers that are on. |
deactivateAllPrayers() | boolean | Switch off every prayer that is on, or the quick-prayer orb when quick prayers are on. |
activateQuickPrayers() | boolean | Switch quick prayers on. |
deactivateQuickPrayers() | boolean | Switch quick prayers off. |
flickQuickPrayers() | boolean | Flick quick prayers in one tick. |
| Method | Returns | Description |
|---|---|---|
PlayerDomain.prayer | Prayers | Prayerbook, activation, flicking, and quick prayers. |
quickPrayersActivequickPrayersActive: (Prayers) -> booleanWhether quick prayers are switched on.
quickPrayersConfiguredquickPrayersConfigured: (Prayers) -> booleanWhether any prayers are assigned to the quick-prayer slot.
prayerbookprayerbook: (Prayers) -> Prayerbook?The active prayerbook.
nil when it has not been read yet.activeactive: (Prayers) -> { string }Every prayer currently on, by display name.
isActiveisActive: (Prayers, Prayer | string) -> booleanWhether one prayer is on.
Takes a Prayer constant (or a name); client:isPrayerActive(prayer) answers the same.
prayerPrayer constant or a prayer's name.isAvailableisAvailable: (Prayers, Prayer | string) -> booleanWhether the prayer is in the active book and its level and unlock requirements are met. Uses the boosted Prayer level inside LMS.
prayerPrayer constant or a prayer's name.activateactivate: (Prayers, Prayer | string) -> booleanSwitch a prayer on.
Does nothing when it is on, unavailable, or the live Prayer level is 0. To fall back to what the account has unlocked (Piety to Chivalry to the separate prayers), use activateOffensivePrayers(style). To toggle:
if prayer:isActive(p) then prayer:deactivate(p) else prayer:activate(p) endprayerPrayer constant or a prayer's name.deactivatedeactivate: (Prayers, Prayer | string) -> booleanSwitch a prayer off, when it is on.
deactivate(Prayer.PIETY) on an account without Piety answers false and leaves the fallback prayers on. deactivateOffensivePrayers(), the counterpart of activateOffensivePrayers(style), takes the fallbacks too (Piety not unlocked: Chivalry, else Ultimate Strength and Incredible Reflexes; Rigour: Deadeye or Eagle Eye; Augury: Mystic Vigour or Mystic Might).
prayerPrayer constant or a prayer's name.flickflick: (Prayers, { Prayer | string }) -> booleanFlick prayers: on ones are toggled off and back on, off ones are switched on, every press together in one game tick or not at all, joining an open Actions.sameTick(). An inactive prayer the account cannot use is not pressed: activateOffensivePrayers(style) and deactivateOffensivePrayers() take the fallbacks. To flick the best offensive set:
prayer:flick(prayer:offensivePrayers(player:combat():currentAttackStyle()))prayersPrayer constants or names; duplicates are dropped.false when the live Prayer level is 0.offensivePrayersoffensivePrayers: (Prayers, AttackStyle) -> { string }The best available offensive set for an attack style, by display name, without causing any input.
styleAttackStyle.MELEE.activateOffensivePrayersactivateOffensivePrayers: (Prayers, AttackStyle?) -> booleanSwitch on the best offensive set for an attack style.
styleAttackStyle.MELEE; omit for the current one.false when nothing was switched on, or the current style cannot be read.deactivateOffensivePrayersdeactivateOffensivePrayers: (Prayers) -> booleanSwitch off the offensive prayers that are on.
deactivateAllPrayersdeactivateAllPrayers: (Prayers) -> booleanSwitch off every prayer that is on, or the quick-prayer orb when quick prayers are on.
activateQuickPrayersactivateQuickPrayers: (Prayers) -> booleanSwitch quick prayers on.
activateQuickPrayers() / deactivateQuickPrayers() ask for a state rather than a flip (quickPrayersActive() tells which).
deactivateQuickPrayersdeactivateQuickPrayers: (Prayers) -> booleanSwitch quick prayers off.
flickQuickPrayersflickQuickPrayers: (Prayers) -> booleanFlick quick prayers in one tick.
false at zero prayer points, or when none are configured.