libram 0.8.18 → 0.8.19

package/dist/actions/Banish.d.ts

@@ -0,0 +1,16 @@
+import { ActionSource, FindActionSourceConstraints } from "./ActionSource";
+/**
+ * Find an available banish source subject to constraints.
+ *
+ * @param constraints Preexisting constraints that restrict possible sources.
+ * @returns Banish source satisfying constraints, or null.
+ */
+export declare function tryFindBanish(constraints?: FindActionSourceConstraints): ActionSource | null;
+/**
+ * Ensure an available banish source subject to constraints.
+ * Throws an error if no source can be found.
+ *
+ * @param constraints Preexisting constraints that restrict possible sources.
+ * @returns Banish source satisfying constraints.
+ */
+export declare function ensureBanish(constraints?: FindActionSourceConstraints): ActionSource;

package/dist/actions/Banish.js

@@ -0,0 +1,121 @@
+import { canEquip, cliExecute, myTurncount, restoreMp, retrieveItem, visitUrl, } from "kolmafia";
+import { Macro } from "../combat";
+import { getFoldGroup, have } from "../lib";
+import { Requirement } from "../maximize";
+import { get } from "../property";
+import * as AsdonMartin from "../resources/2017/AsdonMartin";
+import { $item, $items, $skill } from "../template-string";
+import { ActionSource, findActionSource, } from "./ActionSource";
+// Value of _lastCombatStarted the last time we updated scrapbook charges.
+let scrapbookChargesLastUpdated = get("_lastCombatStarted");
+// Free unlimited source every 30 turns.
+// Does not work on special monsters so needs a backup, see tryFindFreeRun.
+// banishedMonsters isn't updated if the banish succeeds on an unbanishable monster
+const asdonMartinSource = new ActionSource($skill `Asdon Martin: Spring-Loaded Front Bumper`, () => {
+    if (!AsdonMartin.installed())
+        return 0;
+    const banishes = get("banishedMonsters").split(":");
+    const bumperIndex = banishes
+        .map((string) => string.toLowerCase())
+        .indexOf("spring-loaded front bumper");
+    if (bumperIndex === -1)
+        return 1;
+    return myTurncount() - parseInt(banishes[bumperIndex + 1]) > 30 ? 1 : 0;
+}, Macro.trySkill($skill `Asdon Martin: Spring-Loaded Front Bumper`), {
+    preparation: () => AsdonMartin.fillTo(50),
+});
+const banishSources = [
+    // Free limited sources
+    new ActionSource($skill `Snokebomb`, () => (have($skill `Snokebomb`) ? 3 - get("_snokebombUsed") : 0), Macro.skill($skill `Snokebomb`), {
+        preparation: () => restoreMp(50),
+    }),
+    new ActionSource($skill `Emotionally Chipped`, () => (have($skill `Emotionally Chipped`) ? 3 - get("_feelHatredUsed") : 0), Macro.skill($skill `Feel Hatred`)),
+    new ActionSource($item `Kremlin's Greatest Briefcase`, () => have($item `Kremlin's Greatest Briefcase`)
+        ? 3 - get("_kgbTranquilizerDartUses")
+        : 0, Macro.skill($skill `KGB tranquilizer dart`), {
+        equipmentRequirements: () => new Requirement([], {
+            forceEquip: $items `Kremlin's Greatest Briefcase`,
+        }),
+    }),
+    new ActionSource($item `latte lovers member's mug`, () => have($item `latte lovers member's mug`) && !get("_latteBanishUsed")
+        ? 1
+        : 0, Macro.skill($skill `Throw Latte on Opponent`), {
+        equipmentRequirements: () => new Requirement([], { forceEquip: $items `latte lovers member's mug` }),
+    }),
+    new ActionSource($item `Lil' Doctor™ bag`, () => (have($item `Lil' Doctor™ bag`) ? 3 - get("_reflexHammerUsed") : 0), Macro.skill($skill `Reflex Hammer`), {
+        equipmentRequirements: () => new Requirement([], { forceEquip: $items `Lil' Doctor™ bag` }),
+    }),
+    new ActionSource($item `mafia middle finger ring`, () => have($item `mafia middle finger ring`) &&
+        canEquip($item `mafia middle finger ring`) &&
+        !get("_mafiaMiddleFingerRingUsed")
+        ? 1
+        : 0, Macro.skill($skill `Show them your ring`), {
+        equipmentRequirements: () => new Requirement([], { forceEquip: $items `mafia middle finger ring` }),
+    }),
+    new ActionSource($item `V for Vivala mask`, () => have($item `V for Vivala mask`) && !get("_vmaskBanisherUsed") ? 1 : 0, Macro.skill($skill `Creepy Grin`), {
+        equipmentRequirements: () => new Requirement([], { forceEquip: $items `V for Vivala mask` }),
+        preparation: () => restoreMp(30),
+    }),
+    new ActionSource($item `stinky cheese eye`, () => getFoldGroup($item `stinky cheese eye`).some((item) => have(item)) &&
+        !get("_stinkyCheeseBanisherUsed")
+        ? 1
+        : 0, Macro.skill($skill `Give Your Opponent the Stinkeye`), {
+        equipmentRequirements: () => new Requirement([], { forceEquip: $items `stinky cheese eye` }),
+        preparation: () => {
+            if (!have($item `stinky cheese eye`)) {
+                cliExecute(`fold stinky cheese eye`);
+            }
+            return have($item `stinky cheese eye`);
+        },
+    }),
+    new ActionSource($skill `Show your boring familiar pictures`, () => {
+        if (have($item `familiar scrapbook`)) {
+            if (scrapbookChargesLastUpdated !== get("_lastCombatStarted")) {
+                visitUrl("desc_item.php?whichitem=463063785");
+                scrapbookChargesLastUpdated = get("_lastCombatStarted");
+            }
+            return Math.floor(get("scrapbookCharges") / 100);
+        }
+        return 0;
+    }, Macro.skill($skill `Show your boring familiar pictures`), {
+        equipmentRequirements: () => new Requirement([], { forceEquip: $items `familiar scrapbook` }),
+    }),
+    new ActionSource($item `human musk`, () => Math.max(0, 3 - get("_humanMuskUses")), Macro.item($item `human musk`), {
+        preparation: () => retrieveItem($item `human musk`),
+        cost: () => ActionSource.defaultPriceFunction($item `human musk`),
+    }),
+    // Expensive unlimited sources
+    ...$items `Louder Than Bomb, divine champagne popper, tennis ball`.map((item) => new ActionSource(item, () => Infinity, Macro.item(item), {
+        preparation: () => retrieveItem(item),
+        cost: () => ActionSource.defaultPriceFunction(item),
+    })),
+];
+/**
+ * Find an available banish source subject to constraints.
+ *
+ * @param constraints Preexisting constraints that restrict possible sources.
+ * @returns Banish source satisfying constraints, or null.
+ */
+export function tryFindBanish(constraints) {
+    let source = findActionSource(banishSources, constraints);
+    // Always try to use Asdon Martin: Spring-Loaded Front Bumper first,
+    // but only if another source has been found.
+    if (source && asdonMartinSource.available()) {
+        source = asdonMartinSource.merge(source);
+    }
+    return source;
+}
+/**
+ * Ensure an available banish source subject to constraints.
+ * Throws an error if no source can be found.
+ *
+ * @param constraints Preexisting constraints that restrict possible sources.
+ * @returns Banish source satisfying constraints.
+ */
+export function ensureBanish(constraints) {
+    const source = tryFindBanish(constraints);
+    if (!source) {
+        throw new Error("Failed to ensure Banish source");
+    }
+    return source;
+}

package/dist/actions/FreeRun.js

@@ -1,31 +1,14 @@
-import { canEquip, cliExecute, myTurncount, restoreMp, retrieveItem, visitUrl, } from "kolmafia";
+import { retrieveItem } from "kolmafia";
 import { Macro } from "../combat";
-import { ensureEffect, getFoldGroup, getSongCount, getSongLimit, have, } from "../lib";
+import { ensureEffect, getSongCount, getSongLimit, have } from "../lib";
 import { Requirement } from "../maximize";
 import { get } from "../property";
 import * as Bandersnatch from "../resources/2009/Bandersnatch";
 import * as StompingBoots from "../resources/2011/StompingBoots";
-import * as AsdonMartin from "../resources/2017/AsdonMartin";
-import { $effect, $familiar, $item, $items, $skill } from "../template-string";
+import { $effect, $familiar, $item, $items } from "../template-string";
 import { ActionSource, findActionSource, } from "./ActionSource";
-// Value of _lastCombatStarted the last time we updated scrapbook charges.
-let scrapbookChargesLastUpdated = get("_lastCombatStarted");
-// Free unlimited source every 30 turns.
-// Does not work on special monsters so needs a backup, see tryFindFreeRun.
-// banishedMonsters isn't updated if the free run succeeds on an unbanishable monster
-const asdonMartinSource = new ActionSource($skill `Asdon Martin: Spring-Loaded Front Bumper`, () => {
-    if (!AsdonMartin.installed())
-        return 0;
-    const banishes = get("banishedMonsters").split(":");
-    const bumperIndex = banishes
-        .map((string) => string.toLowerCase())
-        .indexOf("spring-loaded front bumper");
-    if (bumperIndex === -1)
-        return 1;
-    return myTurncount() - parseInt(banishes[bumperIndex + 1]) > 30 ? 1 : 0;
-}, Macro.trySkill($skill `Asdon Martin: Spring-Loaded Front Bumper`), {
-    preparation: () => AsdonMartin.fillTo(50),
-});
+// eslint-disable-next-line libram/verify-constants
+const EVERYTHING_LOOKS_GREEN = $effect `Everything Looks Green`;
 const freeRunSources = [
     // Free limited sources
     new ActionSource($familiar `Frumious Bandersnatch`, () => (have($effect `Ode to Booze`) || getSongCount() < getSongLimit()) &&
@@ -43,48 +26,6 @@ const freeRunSources = [
         equipmentRequirements: () => new Requirement(["Familiar Weight"], {}),
         familiar: () => $familiar `Pair of Stomping Boots`,
     }),
-    new ActionSource($skill `Snokebomb`, () => (have($skill `Snokebomb`) ? 3 - get("_snokebombUsed") : 0), Macro.skill($skill `Snokebomb`), {
-        preparation: () => restoreMp(50),
-    }),
-    new ActionSource($skill `Emotionally Chipped`, () => (have($skill `Emotionally Chipped`) ? 3 - get("_feelHatredUsed") : 0), Macro.skill($skill `Feel Hatred`)),
-    new ActionSource($item `Kremlin's Greatest Briefcase`, () => have($item `Kremlin's Greatest Briefcase`)
-        ? 3 - get("_kgbTranquilizerDartUses")
-        : 0, Macro.skill($skill `KGB tranquilizer dart`), {
-        equipmentRequirements: () => new Requirement([], {
-            forceEquip: $items `Kremlin's Greatest Briefcase`,
-        }),
-    }),
-    new ActionSource($item `latte lovers member's mug`, () => have($item `latte lovers member's mug`) && !get("_latteBanishUsed")
-        ? 1
-        : 0, Macro.skill($skill `Throw Latte on Opponent`), {
-        equipmentRequirements: () => new Requirement([], { forceEquip: $items `latte lovers member's mug` }),
-    }),
-    new ActionSource($item `Lil' Doctor™ bag`, () => (have($item `Lil' Doctor™ bag`) ? 3 - get("_reflexHammerUsed") : 0), Macro.skill($skill `Reflex Hammer`), {
-        equipmentRequirements: () => new Requirement([], { forceEquip: $items `Lil' Doctor™ bag` }),
-    }),
-    new ActionSource($item `mafia middle finger ring`, () => have($item `mafia middle finger ring`) &&
-        canEquip($item `mafia middle finger ring`) &&
-        !get("_mafiaMiddleFingerRingUsed")
-        ? 1
-        : 0, Macro.skill($skill `Show them your ring`), {
-        equipmentRequirements: () => new Requirement([], { forceEquip: $items `mafia middle finger ring` }),
-    }),
-    new ActionSource($item `V for Vivala mask`, () => have($item `V for Vivala mask`) && !get("_vmaskBanisherUsed") ? 1 : 0, Macro.skill($skill `Creepy Grin`), {
-        equipmentRequirements: () => new Requirement([], { forceEquip: $items `V for Vivala mask` }),
-        preparation: () => restoreMp(30),
-    }),
-    new ActionSource($item `stinky cheese eye`, () => getFoldGroup($item `stinky cheese eye`).some((item) => have(item)) &&
-        !get("_stinkyCheeseBanisherUsed")
-        ? 1
-        : 0, Macro.skill($skill `Give Your Opponent the Stinkeye`), {
-        equipmentRequirements: () => new Requirement([], { forceEquip: $items `stinky cheese eye` }),
-        preparation: () => {
-            if (!have($item `stinky cheese eye`)) {
-                cliExecute(`fold stinky cheese eye`);
-            }
-            return have($item `stinky cheese eye`);
-        },
-    }),
     new ActionSource($item `navel ring of navel gazing`, () => have($item `navel ring of navel gazing`)
         ? Math.max(0, 3 - get("_navelRunaways"))
         : 0, Macro.step("runaway"), {
@@ -95,30 +36,28 @@ const freeRunSources = [
         : 0, Macro.step("runaway"), {
         equipmentRequirements: () => new Requirement([], { forceEquip: $items `Greatest American Pants` }),
     }),
-    new ActionSource($skill `Show your boring familiar pictures`, () => {
-        if (have($item `familiar scrapbook`)) {
-            if (scrapbookChargesLastUpdated !== get("_lastCombatStarted")) {
-                visitUrl("desc_item.php?whichitem=463063785");
-                scrapbookChargesLastUpdated = get("_lastCombatStarted");
-            }
-            return Math.floor(get("scrapbookCharges") / 100);
-        }
-        return 0;
-    }, Macro.skill($skill `Show your boring familiar pictures`), {
-        equipmentRequirements: () => new Requirement([], { forceEquip: $items `familiar scrapbook` }),
-    }),
     new ActionSource($item `peppermint parasol`, () => Math.max(0, 3 - get("_navelRunaways")), Macro.item($item `peppermint parasol`), {
         preparation: () => retrieveItem($item `peppermint parasol`),
         cost: () => Math.min(ActionSource.defaultPriceFunction($item `peppermint sprout`) * 5, ActionSource.defaultPriceFunction($item `peppermint parasol`)) / 10, // Breaks after 10 successful runaways.
     }),
-    new ActionSource($item `human musk`, () => Math.max(0, 3 - get("_humanMuskUses")), Macro.item($item `human musk`), {
-        preparation: () => retrieveItem($item `human musk`),
-        cost: () => ActionSource.defaultPriceFunction($item `human musk`),
+    new ActionSource($item `green smoke bomb`, () => (have(EVERYTHING_LOOKS_GREEN) ? 0 : 1), Macro.item($item `green smoke bomb`), {
+        preparation: () => retrieveItem($item `green smoke bomb`),
+        cost: () => ActionSource.defaultPriceFunction($item `green smoke bomb`),
     }),
-    // Expensive unlimited sources
-    ...$items `Louder Than Bomb, divine champagne popper, tennis ball`.map((item) => new ActionSource(item, () => Infinity, Macro.item(item), {
-        preparation: () => retrieveItem(item),
-        cost: () => ActionSource.defaultPriceFunction(item),
+    // 50% chance, get 5 to be safe
+    new ActionSource($item `tattered scrap of paper`, () => (have(EVERYTHING_LOOKS_GREEN) ? 0 : 1), Macro.item($item `tattered scrap of paper`).repeat(), {
+        preparation: () => retrieveItem($item `tattered scrap of paper`, 5),
+        cost: () => ActionSource.defaultPriceFunction($item `tattered scrap of paper`) * 5,
+    }),
+    // 30% chance, get 10 to be safe
+    new ActionSource($item `GOTO`, () => (have(EVERYTHING_LOOKS_GREEN) ? 0 : 1), Macro.item($item `GOTO`).repeat(), {
+        preparation: () => retrieveItem($item `GOTO`, 10),
+        cost: () => ActionSource.defaultPriceFunction($item `GOTO`) * 10,
+    }),
+    // limited quest items
+    ...$items `fish-oil smoke bomb, giant eraser`.map((item) => new ActionSource(item, () => (have(EVERYTHING_LOOKS_GREEN) ? 0 : 1), Macro.item(item), {
+        preparation: () => have(item),
+        cost: () => 0,
     })),
 ];
 /**
@@ -128,12 +67,7 @@ const freeRunSources = [
  * @returns Free run source satisfying constraints, or null.
  */
 export function tryFindFreeRun(constraints) {
-    let source = findActionSource(freeRunSources, constraints);
-    // Always try to use Asdon Martin: Spring-Loaded Front Bumper first,
-    // but only if another source has been found.
-    if (source && asdonMartinSource.available()) {
-        source = asdonMartinSource.merge(source);
-    }
+    const source = findActionSource(freeRunSources, constraints);
     return source;
 }
 /**

package/dist/ascend.js

@@ -182,7 +182,8 @@ export function ascend(options) {
         consumable: $item `astral six-pack`,
         pet: $item `none`,
     };
-    const { path, playerClass, lifestyle, kolGender, moon, consumable, pet, permOptions, } = { ...DEFAULT_OPTIONS, ...options };
+    const prunedOptions = Object.fromEntries(Object.entries(options).filter(([, value]) => value));
+    const { path, playerClass, lifestyle, kolGender, moon, consumable, pet, permOptions, } = { ...DEFAULT_OPTIONS, ...prunedOptions };
     if (playerClass.path !== (path.avatar ? path : Path.none)) {
         throw new AscendError(playerClass);
     }

package/dist/lib.d.ts

@@ -408,3 +408,45 @@ export declare function realmCurrency(realm: RealmType): Item | undefined;
  * @returns a list of currently available currencies
  */
 export declare function lgrCurrencies(): Item[];
+declare const ACCOUNT_COMBAT_FLAGS: readonly ["aabosses", "wowbar", "bothcombatinterf", "compactmanuel", "eternalmrj", "disablelovebugs"];
+/**
+ * Different flags you can set on your account for how to handle combat:
+ * aabosses refers to the flag that lets autoattack trigger against special monsters
+ * wowbar refers to the flag to use the Combat Action Bar
+ * bothcombatinterf refers to the flag to use both the CAB
+ * compactmanuel refers to the flag to display monster manuel data horizontally
+ * eternalmrg refers to the flag to enable endless factoid delight
+ * disablelovebugs disables love bugs
+ */
+export declare type AccountCombatFlag = typeof ACCOUNT_COMBAT_FLAGS[number];
+/**
+ * Get the current value of all of your account's combat setting flags
+ * @param flags An array of the flags you want to get, defaults to all of them
+ * @returns An array of objects that contain the flags and their values as booleans
+ */
+export declare function getCombatFlags(flags?: AccountCombatFlag[]): {
+    flag: AccountCombatFlag;
+    value: boolean;
+}[];
+/**
+ * Sets the given combat setting flags on your account
+ *
+ * @param flags A spread array of objects that contain a flag and its desired value; these look like the return value of `getCombatFlags`
+ * @returns the result of the associated `visitUrl` call
+ */
+export declare function setCombatFlags(...flags: {
+    flag: AccountCombatFlag;
+    value: boolean;
+}[]): string;
+/**
+ * Perform a given action with certain combat setting flags set, returning them to their initial values if possible
+ *
+ * @param action The action you want to do with the given combat setting flags
+ * @param flags A spread array of objects that contain a combat setting flag and its desired value; these look like the return value of `getCombatFlags`
+ * @returns The result of the action
+ */
+export declare function withCombatFlags<T>(action: () => T, ...flags: {
+    flag: AccountCombatFlag;
+    value: boolean;
+}[]): T;
+export {};

package/dist/lib.js

@@ -1,5 +1,5 @@
 /** @module GeneralLibrary */
-import { appearanceRates, autosellPrice, availableAmount, booleanModifier, choiceFollowsFight, cliExecute, currentRound, Effect, elementalResistance, equip, equippedItem, Familiar, fullnessLimit, getCampground, getCounters, getPlayerId, getPlayerName, getRelated, handlingChoice, haveEffect, haveFamiliar, haveServant, haveSkill, holiday, inebrietyLimit, inMultiFight, Item, Location, mallPrice, Monster, myClass, myEffects, myFamiliar, myFullness, myInebriety, myPath, myPrimestat, mySpleenUse, myThrall, myTurncount, numericModifier, Path, Servant, Skill, Slot, spleenLimit, Thrall, todayToString, toItem, toSkill, totalTurnsPlayed, visitUrl, } from "kolmafia";
+import { appearanceRates, autosellPrice, availableAmount, booleanModifier, choiceFollowsFight, cliExecute, currentRound, Effect, elementalResistance, equip, equippedItem, Familiar, fullnessLimit, getCampground, getCounters, getPlayerId, getPlayerName, getRelated, handlingChoice, haveEffect, haveFamiliar, haveServant, haveSkill, holiday, inebrietyLimit, inMultiFight, Item, Location, mallPrice, Monster, myClass, myEffects, myFamiliar, myFullness, myInebriety, myPath, myPrimestat, mySpleenUse, myThrall, myTurncount, numericModifier, Path, Servant, Skill, Slot, spleenLimit, Thrall, todayToString, toItem, toSkill, totalTurnsPlayed, visitUrl, xpath, } from "kolmafia";
 import logger from "./logger";
 import { get } from "./property";
 import { $class, $effect, $element, $familiar, $item, $items, $monsters, $skill, $stat, } from "./template-string";
@@ -847,3 +847,55 @@ export function lgrCurrencies() {
         .map(realmCurrency)
         .filter((i) => !!i);
 }
+const ACCOUNT_COMBAT_FLAGS = [
+    "aabosses",
+    "wowbar",
+    "bothcombatinterf",
+    "compactmanuel",
+    "eternalmrj",
+    "disablelovebugs",
+];
+/**
+ * Get the current value of all of your account's combat setting flags
+ * @param flags An array of the flags you want to get, defaults to all of them
+ * @returns An array of objects that contain the flags and their values as booleans
+ */
+export function getCombatFlags(flags = [...ACCOUNT_COMBAT_FLAGS]) {
+    const accountPage = visitUrl("account.php?tab=combat");
+    return flags.map((flag) => ({
+        flag,
+        value: xpath(accountPage, `//*[@id="opt_flag_${flag}"]/label/input[@type='checkbox']@checked`)[0] === "checked",
+    }));
+}
+/**
+ * Sets the given combat setting flags on your account
+ *
+ * @param flags A spread array of objects that contain a flag and its desired value; these look like the return value of `getCombatFlags`
+ * @returns the result of the associated `visitUrl` call
+ */
+export function setCombatFlags(...flags) {
+    return visitUrl(`account.php?${([
+        ...flat(flags.map(({ flag, value }) => [
+            `actions[]=flag_${flag}`,
+            `flag_${flag}=${Number(value)}`,
+        ])),
+        "action=Update",
+    ].join("&"),
+        true)}`);
+}
+/**
+ * Perform a given action with certain combat setting flags set, returning them to their initial values if possible
+ *
+ * @param action The action you want to do with the given combat setting flags
+ * @param flags A spread array of objects that contain a combat setting flag and its desired value; these look like the return value of `getCombatFlags`
+ * @returns The result of the action
+ */
+export function withCombatFlags(action, ...flags) {
+    const initialValues = getCombatFlags(flags.map(({ flag }) => flag));
+    try {
+        return action();
+    }
+    finally {
+        setCombatFlags(...initialValues);
+    }
+}