libram 0.7.10 → 0.7.13

package/dist/resources/2020/Guzzlr.js

@@ -1,45 +1,69 @@
-import { Item, mallPrice, runChoice, use, visitUrl } from "kolmafia";
-import maxBy from "lodash/maxBy";
+import { Item, itemAmount, mallPrice, runChoice, use, visitUrl, } from "kolmafia";
 import { have as haveItem } from "../../lib";
 import { get, withChoice } from "../../property";
 import { $item, $items } from "../../template-string";
-import { invertMap } from "../../utils";
+import { invertMap, maxBy } from "../../utils";
 export const item = $item `Guzzlr tablet`;
+/**
+ * Determines whether you `have` Guzzlr
+ *
+ * @returns Whether you `have` Guzzlr
+ */
 export function have() {
     return haveItem(item);
 }
+/**
+ * Internal function used to navigate the Guzzlr interface
+ *
+ * @param option Choice option to select
+ */
 function useTabletWithChoice(option) {
     withChoice(1412, option, () => use(1, item));
 }
+/**
+ * Determines whether you currently have an active Guzzlr quest
+ *
+ * @returns Whether you currently have an active Guzzlr quest
+ */
 export function isQuestActive() {
     return get("questGuzzlr") !== "unstarted";
 }
 /**
- * Platinum deliveries completed overall
+ * Determines total number of Platinum deliveries completed
+ *
+ * @returns Platinum deliveries completed overall
  */
 export function getPlatinum() {
     return get("guzzlrPlatinumDeliveries");
 }
 /**
- * Platinum deliveries completed today
+ * Determines the number of Platinum deliveries completed today
+ *
+ * @returns Platinum deliveries completed today
  */
 export function getPlatinumToday() {
     return get("_guzzlrPlatinumDeliveries");
 }
 /**
- * Can do a platinum delivery (haven't done one today)
+ * Determines whether you are currently eligible to do a Platinum delivery
+ *
+ * @returns Whether you are currently eligible to do a Platinum delivery
  */
 export function canPlatinum() {
     return !isQuestActive() && getGold() >= 5 && getPlatinumToday() < 1;
 }
 /**
- * Have fully unlocked the platinum delivery bonuses (done >= 30)
+ * Determines whether you have fully unlocked the Platinum delivery bonuses (done >= 30)
+ *
+ * @returns Whether you have fully unlocked the Platinum delivery enchantment bonuses
  */
 export function haveFullPlatinumBonus() {
     return getPlatinum() >= 30;
 }
 /**
- * Accept platinum delivery
+ * Accepts a Platinum delivery
+ *
+ * @returns Whether we succeeded in this endeavor
  */
 export function acceptPlatinum() {
     if (!canPlatinum())
@@ -48,31 +72,41 @@ export function acceptPlatinum() {
     return true;
 }
 /**
- * Gold deliveries completed overall
+ * Determines total number of Gold deliveries completed
+ *
+ * @returns Gold deliveries completed overall
  */
 export function getGold() {
     return get("guzzlrGoldDeliveries");
 }
 /**
- * Gold deliveries completed today
+ * Determines the number of Gold deliveries completed today
+ *
+ * @returns Gold deliveries completed today
  */
 export function getGoldToday() {
     return get("_guzzlrGoldDeliveries");
 }
 /**
- * Can do a gold delivery (have done fewer than 3 today)
+ * Determines whether you are currently eligible to do a Gold delivery
+ *
+ * @returns Whether you are currently eligible to do a Gold delivery
  */
 export function canGold() {
     return !isQuestActive() && getBronze() >= 5 && getGoldToday() < 3;
 }
 /**
- * Have fully unlocked the platinum delivery bonuses (done >= 30)
+ * Determines whether you have fully unlocked the Gold delivery bonuses (done >= 150)
+ *
+ * @returns Whether you have fully unlocked the Gold delivery enchantment bonuses
  */
 export function haveFullGoldBonus() {
     return getGold() >= 150;
 }
 /**
- * Accept gold delivery
+ * Accepts a Gold delivery
+ *
+ * @returns Whether we succeeded in this endeavor
  */
 export function acceptGold() {
     if (!canGold())
@@ -81,13 +115,25 @@ export function acceptGold() {
     return true;
 }
 /**
- * Bronze deliveries completed overall
+ * Determines total number of Bronze deliveries completed
+ *
+ * @returns Bronze deliveries completed overall
  */
 export function getBronze() {
     return get("guzzlrBronzeDeliveries");
 }
 /**
- * Accept bronze delivery
+ * Determines whether you have fully unlocked the Bronze delivery bonuses (done >= 196)
+ *
+ * @returns Whether you have fully unlocked the Bronze delivery enchantment bonuses
+ */
+export function haveFullBronzeBonus() {
+    return getBronze() >= 196;
+}
+/**
+ * Accepts a Bronze delivery
+ *
+ * @returns Whether we succeeded in this endeavor
  */
 export function acceptBronze() {
     if (isQuestActive())
@@ -96,19 +142,17 @@ export function acceptBronze() {
     return true;
 }
 /**
- * Have fully unlocked the platinum delivery bonuses (done >= 30)
- */
-export function haveFullBronzeBonus() {
-    return getBronze() >= 196;
-}
-/**
- * Can abandon the current Guzzlr quest
+ * Determines whether we can abandon the current Guzzlr quest
+ *
+ * @returns Whether we are able to abandon our current Guzzlr quest
  */
 export function canAbandon() {
     return isQuestActive() && !get("_guzzlrQuestAbandoned");
 }
 /**
- * Abandon Guzzlr quest
+ * Abandons Guzzlr quest
+ *
+ * @returns `false` if we were unable to abandon a quest; `true` otherwise
  */
 export function abandon() {
     if (!canAbandon())
@@ -119,20 +163,26 @@ export function abandon() {
     return true;
 }
 /**
- * Get current Guzzlr quest location
+ * Determines the target location for your current Guzzlr quest
+ *
+ * @returns The current target location for your Guzzlr quest, if it exists
  */
 export function getLocation() {
     return get("guzzlrQuestLocation");
 }
 /**
- * Get current Guzzlr quest tier
+ * Determines the tier of your current Guzzlr quest
+ *
+ * @returns The tier of your current Guzzlr quest; `null` if there is no active quest
  */
 export function getTier() {
     const tier = get("guzzlrQuestTier");
     return tier === "" ? null : tier;
 }
 /**
- * Get current Guzzlr quest booze
+ * Determines the current booze item you need to deliver for your current Guzzlr quest
+ *
+ * @returns The booze item associated with your Guzzlr quest if it exists; `null` otherwise
  */
 export function getBooze() {
     const booze = get("guzzlrQuestBooze");
@@ -145,15 +195,17 @@ export function getBooze() {
  */
 export const Cocktails = $items `Buttery Boy, Steamboat, Ghiaccio Colada, Nog-on-the-Cob, Sourfinger`;
 /**
- * Returns true if the user has a platinum cocktail in their inventory
+ * Determines whether you currently have a Platinum cocktail available
+ *
+ * @returns `true` if you have at least one Platinum cocktail in your inventory; `false` otherwise
  */
 export function havePlatinumBooze() {
-    return Cocktails.some((cock) => haveItem(cock));
+    return Cocktails.some((cock) => itemAmount(cock) > 0);
 }
 /**
- * Returns true if the user has the cocktail that they need for their current quest
+ * Determines if you currently have in your inventory the booze necessary to progress your Guzzlr quest
  *
- * If they have no quest, returns false
+ * @returns `true` if you have the booze necessary to progress your Guzzlr quest
  */
 export function haveBooze() {
     const booze = getBooze();
@@ -163,7 +215,7 @@ export function haveBooze() {
         case $item `Guzzlr cocktail set`:
             return havePlatinumBooze();
         default:
-            return haveItem(booze);
+            return itemAmount(booze) > 0;
     }
 }
 export const ingredientToPlatinumCocktail = new Map([
@@ -174,21 +226,38 @@ export const ingredientToPlatinumCocktail = new Map([
     [$item `Dish of Clarified Butter`, $item `Buttery Boy`],
 ]);
 export const platinumCocktailToIngredient = invertMap(ingredientToPlatinumCocktail);
+/**
+ * Determines the cheapest Platinum cocktail to obtain or produce
+ *
+ * @param freeCraft Defaults to `true`; if set to `false`, will count the price of any turns spent cocktailcrafting
+ * @returns The expected price of the cheapest Platinum cocktail to obtain or produce
+ */
 export function getCheapestPlatinumCocktail(freeCraft = true) {
-    const defaultCocktail = [$item `Dish of Clarified Butter`, $item `Buttery Boy`];
     if (freeCraft) {
-        return (maxBy(Array.from(ingredientToPlatinumCocktail), (ingredientAndCocktail) => Math.max(...ingredientAndCocktail.map((item) => -mallPrice(item)))) ?? defaultCocktail)[1];
+        return maxBy(Array.from(ingredientToPlatinumCocktail), (ingredientAndCocktail) => Math.min(...ingredientAndCocktail.map((item) => mallPrice(item))), true)[1];
     }
     else {
-        return (maxBy(Array.from(ingredientToPlatinumCocktail), (ingredientAndCocktail) => -mallPrice(ingredientAndCocktail[1])) ?? defaultCocktail)[1];
+        return maxBy(Array.from(ingredientToPlatinumCocktail), ([, cocktail]) => mallPrice(cocktail))[1];
     }
 }
+/**
+ * Calculates the number of turns remaining for your Guzzlr quest
+ *
+ * @param useShoes Whether or not the calculation should assume you are using Guzzlr shoes
+ * @returns The expected number of turns needed to finish your current delivery
+ */
 export function turnsLeftOnQuest(useShoes = false) {
     const progressPerTurn = useShoes
         ? Math.floor((10 - get("_guzzlrDeliveries")) * 1.5)
         : 10 - get("_guzzlrDeliveries");
     return Math.ceil((100 - get("guzzlrDeliveryProgress")) / progressPerTurn);
 }
+/**
+ * Calculates the expected Guzzlrbuck reward for completing your current Guzzlr quest
+ *
+ * @param usePants Whether or not we should account for Guzzlr pants in our calculation
+ * @returns The expected Guzzlrbuck reward of our current Guzzlr quest
+ */
 export function expectedReward(usePants = false) {
     switch (getTier()) {
         case "platinum":

package/dist/resources/2020/RetroCape.d.ts

@@ -3,6 +3,7 @@ import { Modifiers } from "../../modifier";
 export declare const item: import("kolmafia").Item;
 /**
  * Determines whether you have() the Retro Cape.
+ *
  * @returns Whether you have the Retro Cape available.
  */
 export declare function have(): boolean;
@@ -27,6 +28,7 @@ export declare const currentHero: () => "vampire" | "heck" | "robot";
 export declare const currentMode: () => Mode;
 /**
  * Tunes retro cape to a given setting
+ *
  * @param hero The Superhero to set it to
  * @param mode The washing instructions to set it to
  * @returns Whether we successfully tuned the Retro Cape.
@@ -34,6 +36,7 @@ export declare const currentMode: () => Mode;
 export declare function set(hero: Hero, mode: Mode): boolean;
 /**
  * Returns the expected Modifiers of the Retro Cape for a particular setting
+ *
  * @param hero The Superhero setting
  * @param mode The washing instructions setting
  * @returns A Modifiers object describing the Retro Cape were it to be tuned to that setting.
@@ -41,6 +44,7 @@ export declare function set(hero: Hero, mode: Mode): boolean;
 export declare function getModifier(hero?: "vampire" | "heck" | "robot", mode?: Mode): Modifiers;
 /**
  * Tunes the Retro Cape to allow it to grant a particular skill.
+ *
  * @param skill The skill to tune the Retro Cape to.
  * @returns Whether we successfully tuned the cape.
  */

package/dist/resources/2020/RetroCape.js

@@ -5,6 +5,7 @@ import { $item, $skill } from "../../template-string";
 export const item = $item `unwrapped knock-off retro superhero cape`;
 /**
  * Determines whether you have() the Retro Cape.
+ *
  * @returns Whether you have the Retro Cape available.
  */
 export function have() {
@@ -65,6 +66,7 @@ const modeMap = new Map([
 ]);
 /**
  * Tunes retro cape to a given setting
+ *
  * @param hero The Superhero to set it to
  * @param mode The washing instructions to set it to
  * @returns Whether we successfully tuned the Retro Cape.
@@ -79,6 +81,7 @@ export function set(hero, mode) {
 }
 /**
  * Returns the expected Modifiers of the Retro Cape for a particular setting
+ *
  * @param hero The Superhero setting
  * @param mode The washing instructions setting
  * @returns A Modifiers object describing the Retro Cape were it to be tuned to that setting.
@@ -99,6 +102,7 @@ const skills = new Map([
 ]);
 /**
  * Tunes the Retro Cape to allow it to grant a particular skill.
+ *
  * @param skill The skill to tune the Retro Cape to.
  * @returns Whether we successfully tuned the cape.
  */

package/dist/resources/2021/CrystalBall.d.ts

@@ -1,8 +1,14 @@
 import { Location, Monster, Item } from "kolmafia";
 export declare const orb: Item;
+/**
+ * Determines whether you `have` the Miniature Crystal Ball
+ *
+ * @returns Whether you `have` the Miniature Crystal Ball
+ */
 export declare function have(): boolean;
 /**
  * Ponders your orb (if it is able to do so safely) and then returns a Map keyed by location consisting of extant predictions
+ *
  * @returns A map of all predictions currently active in an adventurer's miniature crystal ball, after visiting the "ponder" URL to refresh them.
  */
 export declare function ponder(): Map<Location, Monster>;

package/dist/resources/2021/CrystalBall.js

@@ -1,7 +1,13 @@
 import { toLocation, toMonster, availableAmount, Item, visitUrl, } from "kolmafia";
+import { logger } from "../..";
 import { canVisitUrl } from "../../lib";
 import { get } from "../../property";
 export const orb = Item.get("miniature crystal ball");
+/**
+ * Determines whether you `have` the Miniature Crystal Ball
+ *
+ * @returns Whether you `have` the Miniature Crystal Ball
+ */
 export function have() {
     return availableAmount(orb) > 0;
 }
@@ -11,12 +17,18 @@ const parsedProp = () => get("crystalBallPredictions")
     .map(([, location, monster]) => [toLocation(location), toMonster(monster)]);
 /**
  * Ponders your orb (if it is able to do so safely) and then returns a Map keyed by location consisting of extant predictions
+ *
  * @returns A map of all predictions currently active in an adventurer's miniature crystal ball, after visiting the "ponder" URL to refresh them.
  */
 export function ponder() {
     if (!have())
         return new Map();
-    if (canVisitUrl())
+    if (canVisitUrl()) {
+        logger.debug("Now pondering Crystal Ball.");
         visitUrl("inventory.php?ponder=1", false);
+    }
+    else {
+        logger.debug("Failed to ponder Crystall Ball.");
+    }
     return new Map(parsedProp());
 }

package/dist/resources/2021/DaylightShavings.d.ts

@@ -2,33 +2,39 @@ import { Effect } from "kolmafia";
 export declare const helmet: import("kolmafia").Item;
 /**
  * Returns whether the player owns an unpackaged Daylight Shavings Helmet, and it's available in either the inventory or other zones as determined by autoSatisfy settings.
+ *
  * @returns whether we have the Daylight Shavings Helmet.
  */
 export declare function have(): boolean;
 export declare const buffs: Effect[];
 /**
  * Tells you whether you currently have a beardbuff active. Warning: because of spaghetti, this does not determine buff eligibility.
+ *
  * @returns Whether you currently have a beardbuff active
  */
 export declare function hasBuff(): boolean;
 /**
  * Checks to see if there are any beardbuffs you have more than 1 turn of, determining whether you are eligible to receive a buff post-combat.
+ *
  * @returns Whether you current are able to get a buff from the Daylight Shaving Helmet.
  */
 export declare function buffAvailable(): boolean;
 /**
  * Calculates and returns the cycle of buffs that the hat should cycle through.
+ *
  * @param playerclass The class to generate a cycle for
  * @returns An ordered array consisting of the cycle for this class. The first element of the array will be the first buff a player should expect to get in a given ascension.
  */
 export declare function buffCycle(playerclass?: import("kolmafia").Class): Effect[];
 /**
  * Returns the next buff we expect to get from the shaving hat.
+ *
  * @returns The next buff we expect to get from the shaving hat.
  */
 export declare function nextBuff(): Effect;
 /**
  * Returns the number of buffs we expect it'll take to get to a given buff. Returns 1 for the next buff, 2 for the one after that, and so on. Returns 11 for the most recent buff.
+ *
  * @param buff The shaving buff in question
  * @returns The number of buffs we expect it'll take to get to the inputted buff; null if said buff is not granted by the shaving hat.
  */

package/dist/resources/2021/DaylightShavings.js

@@ -5,6 +5,7 @@ import { $effects, $item } from "../../template-string";
 export const helmet = $item `Daylight Shavings Helmet`;
 /**
  * Returns whether the player owns an unpackaged Daylight Shavings Helmet, and it's available in either the inventory or other zones as determined by autoSatisfy settings.
+ *
  * @returns whether we have the Daylight Shavings Helmet.
  */
 export function have() {
@@ -13,6 +14,7 @@ export function have() {
 export const buffs = $effects `Spectacle Moustache, Toiletbrush Moustache, Barbell Moustache, Grizzly Beard, Surrealist's Moustache, Musician's Musician's Moustache, Gull-Wing Moustache, Space Warlord's Beard, Pointy Wizard Beard, Cowboy Stache, Friendly Chops`;
 /**
  * Tells you whether you currently have a beardbuff active. Warning: because of spaghetti, this does not determine buff eligibility.
+ *
  * @returns Whether you currently have a beardbuff active
  */
 export function hasBuff() {
@@ -20,6 +22,7 @@ export function hasBuff() {
 }
 /**
  * Checks to see if there are any beardbuffs you have more than 1 turn of, determining whether you are eligible to receive a buff post-combat.
+ *
  * @returns Whether you current are able to get a buff from the Daylight Shaving Helmet.
  */
 export function buffAvailable() {
@@ -27,6 +30,7 @@ export function buffAvailable() {
 }
 /**
  * Calculates and returns the cycle of buffs that the hat should cycle through.
+ *
  * @param playerclass The class to generate a cycle for
  * @returns An ordered array consisting of the cycle for this class. The first element of the array will be the first buff a player should expect to get in a given ascension.
  */
@@ -44,6 +48,7 @@ export function buffCycle(playerclass = myClass()) {
 }
 /**
  * Returns the next buff we expect to get from the shaving hat.
+ *
  * @returns The next buff we expect to get from the shaving hat.
  */
 export function nextBuff() {
@@ -55,6 +60,7 @@ export function nextBuff() {
 }
 /**
  * Returns the number of buffs we expect it'll take to get to a given buff. Returns 1 for the next buff, 2 for the one after that, and so on. Returns 11 for the most recent buff.
+ *
  * @param buff The shaving buff in question
  * @returns The number of buffs we expect it'll take to get to the inputted buff; null if said buff is not granted by the shaving hat.
  */

package/dist/resources/2022/AutumnAton.d.ts

@@ -2,10 +2,14 @@ import { Item, Location } from "kolmafia";
 export declare const item: Item;
 /**
  * Is the autumn-aton currently in your inventory, available to deploy?
+ *
+ * @returns The whether the autumn-aton is currently available for deployment
  */
 export declare function available(): boolean;
 /**
  * Do you own the autumn-aton?
+ *
+ * @returns Whether you are an autumn-aton `have`r
  */
 export declare function have(): boolean;
 /**
@@ -14,6 +18,7 @@ export declare function have(): boolean;
 export declare function currentlyIn(): Location | null;
 /**
  * Deploy the autumn-aton to a location of your choosing.
+ *
  * @param target A location to send the autumn-aton to, or a prioritized list of locations to send it to, or a function to pick which location to send it to.
  * @param upgrade Should we apply any upgrades we see available?
  * @returns Where we ended up sending the autumn-aton; null if we didn't send it off.
@@ -21,6 +26,7 @@ export declare function currentlyIn(): Location | null;
 export declare function sendTo(target: Location | Location[] | ((locations: Location[]) => Location), upgrade?: boolean): Location | null;
 /**
  * Install any available upgrades for the autumn-aton.
+ *
  * @returns Whether there were any upgrades to install.
  */
 export declare function upgrade(): boolean;
@@ -41,6 +47,9 @@ export declare function currentUpgrades(): Upgrade[];
  * @returns The number of turns remaining in your current autumn-aton quest. This number may be negative for any number of reasons.
  */
 export declare function turnsLeft(): number;
+/**
+ * @returns The number of leg-upgrades your autumn-aton has installed
+ */
 export declare function legs(): number;
 /**
  * @returns The number of turns we expect your next autumn-aton quest to take.
@@ -58,6 +67,12 @@ export declare function zoneItems(): 3 | 4 | 5;
  * @returns The number of seasonal items we expect the autumn-aton to return with given its current upgrade-state.
  */
 export declare function seasonalItems(): 1 | 2;
+/**
+ * Determines and returns the upgrade and item drop associated with the given location
+ *
+ * @param location The location to check the expected autumn-aton-unique drops of
+ * @returns `null` if the location has no upgrade or drop; otherwise, the upgrade and the autumn-aton item associated with that item
+ */
 export declare function getUniques(location: Location): {
     upgrade: Upgrade;
     item: Item;

package/dist/resources/2022/AutumnAton.js

@@ -5,16 +5,26 @@ import { arrayContains } from "../../utils";
 export const item = Item.get("autumn-aton");
 /**
  * Is the autumn-aton currently in your inventory, available to deploy?
+ *
+ * @returns The whether the autumn-aton is currently available for deployment
  */
 export function available() {
     return availableAmount(item) > 0;
 }
 /**
  * Do you own the autumn-aton?
+ *
+ * @returns Whether you are an autumn-aton `have`r
  */
 export function have() {
     return get("hasAutumnaton") || available();
 }
+/**
+ * Internal function used to parse the fallbot's choice adventure to determine which zones are currently available
+ *
+ * @param html The pagetext of the fallbot's choice adventure
+ * @returns The locations currently available to send the fallbot to
+ */
 function checkLocations(html) {
     return xpath(html, '//select[@name="heythereprogrammer"]//option[position()>1]/text()').map((name) => toLocation(name));
 }
@@ -27,6 +37,7 @@ export function currentlyIn() {
 }
 /**
  * Deploy the autumn-aton to a location of your choosing.
+ *
  * @param target A location to send the autumn-aton to, or a prioritized list of locations to send it to, or a function to pick which location to send it to.
  * @param upgrade Should we apply any upgrades we see available?
  * @returns Where we ended up sending the autumn-aton; null if we didn't send it off.
@@ -56,6 +67,7 @@ export function sendTo(target, upgrade = true) {
 }
 /**
  * Install any available upgrades for the autumn-aton.
+ *
  * @returns Whether there were any upgrades to install.
  */
 export function upgrade() {
@@ -102,6 +114,9 @@ export function currentUpgrades() {
 export function turnsLeft() {
     return get("autumnatonQuestTurn") - totalTurnsPlayed();
 }
+/**
+ * @returns The number of leg-upgrades your autumn-aton has installed
+ */
 export function legs() {
     return currentUpgrades().filter((u) => u.includes("leg")).length;
 }
@@ -149,6 +164,12 @@ const UNIQUES = {
         high: { index: 8, item: $item `autumn years wisdom` },
     },
 };
+/**
+ * Determines and returns the upgrade and item drop associated with the given location
+ *
+ * @param location The location to check the expected autumn-aton-unique drops of
+ * @returns `null` if the location has no upgrade or drop; otherwise, the upgrade and the autumn-aton item associated with that item
+ */
 export function getUniques(location) {
     const env = location.environment;
     const difficulty = location.difficultyLevel;

package/dist/resources/2022/CombatLoversLocket.d.ts

@@ -1,34 +1,43 @@
 import { Monster } from "kolmafia";
 export declare const locket: import("kolmafia").Item;
+/**
+ * @returns Whether you `have` the Combat Lover's Locket
+ */
 export declare function have(): boolean;
 /**
  * Filters the set of all unlocked locket monsters to only the ones available to be locketed right now.
+ *
  * @returns An array consisting of all Monsters you can fight with your locket right now.
  */
 export declare function availableLocketMonsters(): Monster[];
 /**
  * Parses getLocketMonsters and returns the collection of all Monsters as an Array.
+ *
  * @returns An array consisting of all Monsters you can hypothetically fight, regardless of whether they've been fought today.
  */
 export declare function unlockedLocketMonsters(): Monster[];
 /**
  * Determines how many reminisces remain by parsing the _locketMonstersFought property.
+ *
  * @returns The number of reminisces a player has available; 0 if they lack the Locket.
  */
 export declare function reminiscesLeft(): number;
 /**
  * Determines which monsters were reminisced today by parsing the _locketMonstersFought property.
+ *
  * @returns An array consisting of the Monsters reminisced today.
  */
 export declare function monstersReminisced(): Monster[];
 /**
  * Fight a Monster using the Combat Lover's Locket
+ *
  * @param monster The Monster to fight
  * @returns false if we are unable to reminisce about this monster. Else, returns whether, at the end of all things, we have reminisced about this monster.
  */
 export declare function reminisce(monster: Monster): boolean;
 /**
  * This function efficiently evaluates all of an adventurer's possibly reminiscable monsters, placing them through a filtering criteria and evaluating them based on a passed function.
+ *
  * @param criteria A filtering function for delineating which monsters are "fair game" for the search, such as "is this monster free".
  * @param value A function for deciding which monsters are "better" than others.
  * @returns A singular monster that fulfills the criteria function and maximizes the value function.