libram 0.7.17 → 0.7.18

package/dist/actions/FreeRun.js

@@ -6,7 +6,7 @@ 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, $item, $items, $skill } from "../template-string";
+import { $effect, $familiar, $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");
@@ -28,7 +28,7 @@ const asdonMartinSource = new ActionSource($skill `Asdon Martin: Spring-Loaded F
 });
 const freeRunSources = [
     // Free limited sources
-    new ActionSource(Bandersnatch.familiar, () => (have($effect `Ode to Booze`) || getSongCount() < getSongLimit()) &&
+    new ActionSource($familiar `Frumious Bandersnatch`, () => (have($effect `Ode to Booze`) || getSongCount() < getSongLimit()) &&
         Bandersnatch.couldRunaway()
         ? Bandersnatch.getRemainingRunaways()
         : 0, Macro.step("runaway"), {
@@ -37,11 +37,11 @@ const freeRunSources = [
             ensureEffect($effect `Ode to Booze`);
             return have($effect `Ode to Booze`);
         },
-        familiar: () => Bandersnatch.familiar,
+        familiar: () => $familiar `Frumious Bandersnatch`,
     }),
-    new ActionSource(StompingBoots.familiar, () => StompingBoots.couldRunaway() ? StompingBoots.getRemainingRunaways() : 0, Macro.step("runaway"), {
+    new ActionSource($familiar `Pair of Stomping Boots`, () => StompingBoots.couldRunaway() ? StompingBoots.getRemainingRunaways() : 0, Macro.step("runaway"), {
         equipmentRequirements: () => new Requirement(["Familiar Weight"], {}),
-        familiar: () => StompingBoots.familiar,
+        familiar: () => $familiar `Pair of Stomping Boots`,
     }),
     new ActionSource($skill `Snokebomb`, () => (have($skill `Snokebomb`) ? 3 - get("_snokebombUsed") : 0), Macro.skill($skill `Snokebomb`), {
         preparation: () => restoreMp(50),

package/dist/challengePaths/2015/CommunityService.d.ts

@@ -5,6 +5,7 @@ export default class CommunityService {
     private property;
     private predictor;
     private maximizeRequirements;
+    private timer;
     /**
      * Class to store properties of various CS tests.
      *
@@ -35,6 +36,17 @@ export default class CommunityService {
      * @returns A Requirement object, if applicable, that aligns with the things needed to maximize for this particular test.
      */
     get requirement(): Requirement | null;
+    /**
+     * Start the time & turn counter for the Test in question.
+     */
+    startTimer(): void;
+    private static taskTimers;
+    /**
+     * Start the time & turn counter for the given task
+     *
+     * @param name The name of the task to start the counter of
+     */
+    static startTimer(name: string): void;
     static logTask(name: string, action: () => number | void): void;
     /**
      * Checks the "csServicesPerformed" property to see whether mafia currently believes this test is complete.

package/dist/challengePaths/2015/CommunityService.js

@@ -26,6 +26,7 @@ export default class CommunityService {
     property;
     predictor;
     maximizeRequirements;
+    timer = null;
     /**
      * Class to store properties of various CS tests.
      *
@@ -72,15 +73,34 @@ export default class CommunityService {
     get requirement() {
         return this.maximizeRequirements;
     }
+    /**
+     * Start the time & turn counter for the Test in question.
+     */
+    startTimer() {
+        this.timer ??= { time: Date.now(), turns: myTurncount() };
+    }
+    static taskTimers = new Map();
+    /**
+     * Start the time & turn counter for the given task
+     *
+     * @param name The name of the task to start the counter of
+     */
+    static startTimer(name) {
+        if (!this.taskTimers.has(name)) {
+            this.taskTimers.set(name, { time: Date.now(), turns: myTurncount() });
+        }
+    }
     static logTask(name, action) {
-        const startTime = Date.now();
-        const startTurns = myTurncount();
         const estimatedTurns = action() ?? 0;
+        const { time, turns } = this.taskTimers.get(name) ?? {
+            time: Date.now(),
+            turns: myTurncount(),
+        };
         CommunityService.log[name] = {
             type: "task",
-            turnCost: myTurncount() - startTurns,
+            turnCost: myTurncount() - turns,
             predictedTurns: estimatedTurns,
-            seconds: (Date.now() - startTime) / 1000,
+            seconds: (Date.now() - time) / 1000,
         };
     }
     /**
@@ -120,8 +140,10 @@ export default class CommunityService {
     run(prepare, maxTurns = Infinity) {
         if (this.isDone())
             return "already completed";
-        const startTime = Date.now();
-        const startTurns = myTurncount();
+        const { time, turns } = this.timer ?? {
+            time: Date.now(),
+            turns: myTurncount(),
+        };
         let additionalTurns;
         try {
             const result = prepare();
@@ -133,18 +155,18 @@ export default class CommunityService {
         }
         const prediction = this.predictor();
         const council = visitCouncil();
-        const turns = this._actualCost(council);
-        if (!turns)
+        const turnCost = this._actualCost(council);
+        if (!turnCost)
             return "already completed";
-        if (turns > Math.min(maxTurns, myAdventures())) {
+        if (turnCost > Math.min(maxTurns, myAdventures())) {
             return "failed";
         }
         if (!this.do())
             return "failed";
         CommunityService.log[this.property] = {
             predictedTurns: prediction + additionalTurns,
-            turnCost: myTurncount() - startTurns,
-            seconds: (Date.now() - startTime) / 1000,
+            turnCost: myTurncount() - turns,
+            seconds: (Date.now() - time) / 1000,
             type: "test",
         };
         return "completed";

package/dist/combat.d.ts

@@ -108,6 +108,20 @@ export declare class Macro {
      * @returns {Macro} This object itself.
      */
     static abort<T extends Macro>(this: Constructor<T>): T;
+    /**
+     * Adds an "abort" step to this macro, with a warning message to print
+     *
+     * @param warning The warning message to print
+     * @returns  {Macro} This object itself.
+     */
+    abortWithWarning(warning: string): this;
+    /**
+     * Create a new macro with an "abort" step to this macro, with a warning message to print
+     *
+     * @param warning The warning message to print
+     * @returns  {Macro} This object itself.
+     */
+    static abortWithWarning<T extends Macro>(this: Constructor<T>, warning: string): T;
     /**
      * Add a "runaway" step to this macro.
      *

package/dist/combat.js

@@ -233,6 +233,24 @@ export class Macro {
     static abort() {
         return new this().abort();
     }
+    /**
+     * Adds an "abort" step to this macro, with a warning message to print
+     *
+     * @param warning The warning message to print
+     * @returns  {Macro} This object itself.
+     */
+    abortWithWarning(warning) {
+        return this.step(`abort "${warning}"`);
+    }
+    /**
+     * Create a new macro with an "abort" step to this macro, with a warning message to print
+     *
+     * @param warning The warning message to print
+     * @returns  {Macro} This object itself.
+     */
+    static abortWithWarning(warning) {
+        return new this().abortWithWarning(warning);
+    }
     /**
      * Add a "runaway" step to this macro.
      *

package/dist/index.d.ts

@@ -21,7 +21,7 @@ export * as property from "./property";
 export * as propertyTypes from "./propertyTypes";
 export * from "./utils";
 export { get, PropertiesManager, set, setProperties, withProperties, withProperty, withChoices, withChoice, } from "./property";
-export { get as getModifier } from "./modifier";
+export { get as getModifier, getTotalModifier } from "./modifier";
 export { Session } from "./session";
 export type { LogLevels } from "./logger";
 export type { Modifiers } from "./modifier";

package/dist/index.js

@@ -21,5 +21,5 @@ export * as property from "./property";
 export * as propertyTypes from "./propertyTypes";
 export * from "./utils";
 export { get, PropertiesManager, set, setProperties, withProperties, withProperty, withChoices, withChoice, } from "./property";
-export { get as getModifier } from "./modifier";
+export { get as getModifier, getTotalModifier } from "./modifier";
 export { Session } from "./session";

package/dist/lib.d.ts

@@ -1,5 +1,5 @@
 /** @module GeneralLibrary */
-import { Effect, Element, Familiar, Item, Location, Monster, Servant, Skill, Stat, Thrall } from "kolmafia";
+import { Effect, Element, Familiar, Item, Location, Monster, Servant, Skill, Slot, Stat, Thrall } from "kolmafia";
 /**
  * Determines the current maximum Accordion Thief songs the player can have in their head
  *
@@ -367,3 +367,17 @@ export declare const byClass: <S>(options: import("./utils").Switch<import("kolm
  * @returns The html of the resulting page
  */
 export declare function directlyUse(item: Item): string;
+/**
+ * Unequip all instances of a given equipped item
+ *
+ * @param item The item in question
+ * @returns Whether we succeeded completely--`false` if we unequip some but not all instances of the item.
+ */
+export declare function unequip(item: Item): boolean;
+/**
+ * Empty a given slot.
+ *
+ * @param slot The slot in question
+ * @returns Whether we successfully emptied the slot
+ */
+export declare function unequip(slot: Slot): boolean;

package/dist/lib.js

@@ -1,5 +1,5 @@
 /** @module GeneralLibrary */
-import { appearanceRates, autosellPrice, availableAmount, booleanModifier, choiceFollowsFight, cliExecute, currentRound, Effect, elementalResistance, 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, spleenLimit, Thrall, toInt, 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, toInt, toItem, toSkill, totalTurnsPlayed, visitUrl, } from "kolmafia";
 import logger from "./logger";
 import { get } from "./property";
 import { $class, $element, $familiar, $item, $items, $monsters, $skill, $stat, } from "./template-string";
@@ -746,3 +746,24 @@ export const byClass = makeByXFunction(() => myClass().toString());
 export function directlyUse(item) {
     return visitUrl(`inv_use.php?which=3&whichitem=${toInt(item)}&pwd`);
 }
+/**
+ * Empty a slot, or unequip all instances of a given equipped item
+ *
+ * @param thing The slot or item in question
+ * @returns Whether we succeeded completely--`false` if we unequip some but not all instances of the item.
+ */
+export function unequip(thing) {
+    if (thing instanceof Slot)
+        return equip(thing, $item.none);
+    const failedSlots = Slot.all().filter((s) => {
+        // Filter the slot out if it doesn't contain the relevant item
+        if (equippedItem(s) !== thing)
+            return false;
+        // Filter the slot out if we succeed at unequipping it
+        return !unequip(thing);
+        // This leaves only slots that do contain the item but that we failed to unequip
+    });
+    if (failedSlots.length)
+        logger.debug(`Failed to unequip ${thing} from slots ${failedSlots.join(", ")}`);
+    return failedSlots.length === 0;
+}

package/dist/modifier.d.ts

@@ -31,3 +31,11 @@ export declare function mergeModifiers(...modifierss: Modifiers[]): Modifiers;
  */
 export declare function printModtrace(inputModifiers: string | string[], // the user's list of modifiers to look up
 baseModifier?: string, componentColor?: string, totalColor?: string): void;
+/**
+ * Take the sum of a modifier over an array of Skills, Effects, and Items
+ *
+ * @param modifier A NumericModifier that we want to find the total value of
+ * @param subjects A rested array of Skills, Effects, and Items that we want to find the total value of
+ * @returns The sum of the appropriate modifier for all of the subjects
+ */
+export declare function getTotalModifier(modifier: NumericModifier, ...subjects: (Skill | Effect | Item)[]): number;

package/dist/modifier.js

@@ -148,3 +148,13 @@ baseModifier, componentColor = "purple", totalColor = "blue") {
     });
     print(`Total ${baseModifier}: ${total.toFixed(1)}`, totalColor);
 }
+/**
+ * Take the sum of a modifier over an array of Skills, Effects, and Items
+ *
+ * @param modifier A NumericModifier that we want to find the total value of
+ * @param subjects A rested array of Skills, Effects, and Items that we want to find the total value of
+ * @returns The sum of the appropriate modifier for all of the subjects
+ */
+export function getTotalModifier(modifier, ...subjects) {
+    return sum(subjects, (subject) => get(modifier, subject));
+}