poisonState
poisonState: (Consumables) -> { isPoisoned: boolean, isVenomed: boolean, incomingDamage: number, rawValue: number }Poison and venom state, and incoming damage with it.
player:consumables()| Method | Returns | Description |
|---|---|---|
poisonState() | { isPoisoned: boolean, isVenomed: boolean, incomingDamage: number, rawValue: number } | Poison and venom state, and incoming damage with it. |
curePoison(number?) | boolean | Cure poison or venom with the best potion carried, else Cure Me. |
consumeFood(number?, boolean?) | boolean | Eat one food when hitpoints are low. Any carried food that heals counts, karambwans included, but the gout tuber, Recipe for Disaster's que… |
consumeKarambwanFood(number?, boolean?) | boolean | Eat food and a karambwan together in one tick, or neither: the combo eat. |
consumeTripleFood(boolean?) | boolean | Eat food, a karambwan and drink a Saradomin brew together in one tick, or none of them. Whatever of the three is carried; no hitpoints gate. |
consumePrayerRestore(number?) | boolean | Drink a prayer restore when prayer points are low enough. |
consumeMagicBoost(number?) | boolean | Drink a magic boost when it has run down. |
consumeStrengthBoost(number?) | boolean | Drink a strength boost when it has run down. |
consumeAttackBoost(number?) | boolean | Drink an attack boost when it has run down. |
consumeDefenceBoost(number?) | boolean | Drink a defence boost when it has run down. |
consumeRangingBoost(number?) | boolean | Drink a ranging boost when it has run down. |
consumeEnergyPotion() | boolean | Top up run energy: below 5% an energy potion; below 40% with no stamina buff running a stamina potion; otherwise nothing. |
| Method | Returns | Description |
|---|---|---|
PlayerDomain.consumables | Consumables | Food, potions, and poison cures. |
poisonStatepoisonState: (Consumables) -> { isPoisoned: boolean, isVenomed: boolean, incomingDamage: number, rawValue: number }Poison and venom state, and incoming damage with it.
curePoisoncurePoison: (Consumables, number?) -> booleanCure poison or venom with the best potion carried, else Cure Me.
Venom is always cured. Poison is cured when no threshold is given, or when incoming poison damage has reached it.
damageThresholdfalse when not afflicted, or below the threshold.consumeFoodconsumeFood: (Consumables, number?, boolean?) -> booleanEat one food when hitpoints are low. Any carried food that heals counts, karambwans included, but the gout tuber, Recipe for Disaster's quest foods and rock cakes. Fewest bites first (a cake is 3), then inventory order; tick-eat foods (karambwans, halibut, the gnome foods) after all the rest.
thresholdincludeBlightedfalse when there is no food, or it is not time to eat.consumeKarambwanFoodconsumeKarambwanFood: (Consumables, number?, boolean?) -> booleanEat food and a karambwan together in one tick, or neither: the combo eat.
thresholdincludeBlightedconsumeTripleFoodconsumeTripleFood: (Consumables, boolean?) -> booleanEat food, a karambwan and drink a Saradomin brew together in one tick, or none of them. Whatever of the three is carried; no hitpoints gate.
includeBlightedconsumePrayerRestoreconsumePrayerRestore: (Consumables, number?) -> booleanDrink a prayer restore when prayer points are low enough.
atOrBelowPointsconsumeMagicBoostconsumeMagicBoost: (Consumables, number?) -> booleanDrink a magic boost when it has run down.
boostLeftAtMostconsumeStrengthBoostconsumeStrengthBoost: (Consumables, number?) -> booleanDrink a strength boost when it has run down.
boostLeftAtMostconsumeMagicBoost's.consumeAttackBoostconsumeAttackBoost: (Consumables, number?) -> booleanDrink an attack boost when it has run down.
boostLeftAtMostconsumeMagicBoost's.consumeDefenceBoostconsumeDefenceBoost: (Consumables, number?) -> booleanDrink a defence boost when it has run down.
boostLeftAtMostconsumeMagicBoost's.consumeRangingBoostconsumeRangingBoost: (Consumables, number?) -> booleanDrink a ranging boost when it has run down.
boostLeftAtMostconsumeMagicBoost's.consumeEnergyPotionconsumeEnergyPotion: (Consumables) -> booleanTop up run energy: below 5% an energy potion; below 40% with no stamina buff running a stamina potion; otherwise nothing.