libram 0.7.10 → 0.7.13

package/dist/resources/2011/StompingBoots.js

@@ -4,50 +4,42 @@ import { get } from "../../property";
 import { $familiar } from "../../template-string";
 export const familiar = $familiar `Pair of Stomping Boots`;
 /**
- * Returns true if the player has the Pair of Stomping Boots in their
- * terrarium
+ * @returns whether the player has the Pair of Stomping Boots in their terrarium
  */
 export function have() {
     return _have(familiar);
 }
 /**
- * Returns the number of free runaways that have already been used
+ * @returns number of free runaways that have already been used today
  * @see Bandersnatch with which the Stomping Boots shares a counter
  */
 export function getRunaways() {
     return get("_banderRunaways");
 }
 /**
- * Returns the total number of free runaways that the player can
- * get from their Stomping Boots
- *
  * @param considerWeightAdjustment Include familiar weight modifiers
+ * @returns total number of free runaways that the player can get from their Stomping Boots
  */
 export function getMaxRunaways(considerWeightAdjustment = true) {
     const weightBuffs = considerWeightAdjustment ? weightAdjustment() : 0;
     return Math.floor((familiarWeight(familiar) + weightBuffs) / 5);
 }
 /**
- * Returns the number of remaining free runaways the player can
- * get from their Stomping Boots
- *
- * @param considerWeightAdjustment
+ * @param considerWeightAdjustment Whether to consider weight adjustment in free run calculation
+ * @returns the number of remaining free runaways the player can get from their Stomping Boots
  */
 export function getRemainingRunaways(considerWeightAdjustment = true) {
     return Math.max(0, getMaxRunaways(considerWeightAdjustment) - getRunaways());
 }
 /**
- * Returns true if the player could use their Stomping Boots to
- * get a free run in theory
- *
  * @param considerWeightAdjustment Include familiar weight modifiers
+ * @returns whether the player could use their Stomping Boots to get a free run in theory
  */
 export function couldRunaway(considerWeightAdjustment = true) {
     return have() && getRemainingRunaways(considerWeightAdjustment) > 0;
 }
 /**
- * Returns true if the player can use their Stomping Boots to get a
- * free run right now
+ * @returns whether the player can use their Stomping Boots to get a free run right now
  */
 export function canRunaway() {
     return isCurrentFamiliar(familiar) && couldRunaway();
@@ -57,6 +49,8 @@ export function canRunaway() {
  *
  * This will take your Stomping Boots with you.
  * If any of those steps fail, it will return false.
+ *
+ * @returns Success
  */
 export function prepareRunaway() {
     return useFamiliar(familiar);

package/dist/resources/2012/RainDoh.d.ts

@@ -1,6 +1,26 @@
 import { Monster } from "kolmafia";
 export declare const box: import("kolmafia").Item;
+/**
+ * See whether the player has a Rain-Doh item in some form
+ *
+ * @returns Whether the player has any Rain-Doh item
+ */
 export declare function have(): boolean;
+/**
+ * Get Rain-Doh black box copies made today
+ *
+ * @returns Number of Rain-Doh black box copies made
+ */
 export declare function getRainDohBlackBoxCopiesMade(): number;
+/**
+ * Get the current Rain-doh box monster
+ *
+ * @returns Current Rain-doh box monster
+ */
 export declare function getRainDohBlackBoxMonster(): Monster | null;
+/**
+ * Use the Rain-Doh box full of monster (i.e. fight the monster probably)
+ *
+ * @returns Success
+ */
 export declare function useRainDohBlackBox(): boolean;

package/dist/resources/2012/RainDoh.js

@@ -3,15 +3,35 @@ import { getFoldGroup, have as haveItem } from "../../lib";
 import { get } from "../../property";
 import { $item } from "../../template-string";
 export const box = $item `Rain-Doh black box`;
+/**
+ * See whether the player has a Rain-Doh item in some form
+ *
+ * @returns Whether the player has any Rain-Doh item
+ */
 export function have() {
     return getFoldGroup(box).some((item) => haveItem(item));
 }
+/**
+ * Get Rain-Doh black box copies made today
+ *
+ * @returns Number of Rain-Doh black box copies made
+ */
 export function getRainDohBlackBoxCopiesMade() {
     return Math.max(0, get("_raindohCopiesMade"));
 }
+/**
+ * Get the current Rain-doh box monster
+ *
+ * @returns Current Rain-doh box monster
+ */
 export function getRainDohBlackBoxMonster() {
     return get("rainDohMonster");
 }
+/**
+ * Use the Rain-Doh box full of monster (i.e. fight the monster probably)
+ *
+ * @returns Success
+ */
 export function useRainDohBlackBox() {
     return use(box);
 }

package/dist/resources/2012/ReagnimatedGnome.d.ts

@@ -1,4 +1,7 @@
 import { Item } from "kolmafia";
+/**
+ * @returns Whether the player has a Reagnimated Gnome in their terrarium
+ */
 export declare function have(): boolean;
 export declare const bodyParts: {
     readonly ears: Item;
@@ -8,6 +11,21 @@ export declare const bodyParts: {
     readonly foot: Item;
 };
 export declare type BodyPart = keyof typeof bodyParts;
+/**
+ * @returns Reagnimated Gnome parts that have already been retrieved from the arena
+ */
 export declare function chosenParts(): Item[];
+/**
+ * Fetch Reagnimated Gnome part from the arena
+ *
+ * @param part Reagnimated Gnome body part
+ * @returns Success
+ */
 export declare function choosePart(part: BodyPart): boolean;
+/**
+ * Calculate expected adventures from a given combat for a Reagnimated Gnome at a given weight
+ *
+ * @param weight Weight with which to calculuate
+ * @returns Expected adventures
+ */
 export declare function expectedAdvsPerCombat(weight: number): number;

package/dist/resources/2012/ReagnimatedGnome.js

@@ -1,6 +1,9 @@
 import { runChoice, visitUrl } from "kolmafia";
 import { have as _have } from "../../lib";
 import { $familiar, $item } from "../../template-string";
+/**
+ * @returns Whether the player has a Reagnimated Gnome in their terrarium
+ */
 export function have() {
     return _have($familiar `Reagnimated Gnome`);
 }
@@ -11,9 +14,18 @@ export const bodyParts = {
     kgnee: $item `gnomish housemaid's kgnee`,
     foot: $item `gnomish athlete's foot`,
 };
+/**
+ * @returns Reagnimated Gnome parts that have already been retrieved from the arena
+ */
 export function chosenParts() {
     return Object.values(bodyParts).filter((part) => _have(part));
 }
+/**
+ * Fetch Reagnimated Gnome part from the arena
+ *
+ * @param part Reagnimated Gnome body part
+ * @returns Success
+ */
 export function choosePart(part) {
     if (!have())
         return false;
@@ -23,6 +35,12 @@ export function choosePart(part) {
     runChoice(4);
     return chosenParts().includes(bodyParts[part]);
 }
+/**
+ * Calculate expected adventures from a given combat for a Reagnimated Gnome at a given weight
+ *
+ * @param weight Weight with which to calculuate
+ * @returns Expected adventures
+ */
 export function expectedAdvsPerCombat(weight) {
     return Math.min(0.01 + (weight / 1000) * 0.99, 1);
 }

package/dist/resources/2012/Resolutions.d.ts

@@ -1,10 +1,10 @@
 import { Item } from "kolmafia";
 export declare const summonSkill: import("kolmafia").Skill;
 /**
- * @returns true if the player can Summon Resolutions
+ * @returns Whether the player can Summon Resolutions
  */
 export declare function have(): boolean;
 /**
- * @returns map containing the chance of an item to be summoned
+ * @returns Map containing the chance of an item to be summoned
  */
 export declare function expected(): Map<Item, number>;

package/dist/resources/2012/Resolutions.js

@@ -15,13 +15,13 @@ const libramExpected = new Map([
     [$item `resolution: be more adventurous`, rareChance],
 ]);
 /**
- * @returns true if the player can Summon Resolutions
+ * @returns Whether the player can Summon Resolutions
  */
 export function have() {
     return _have(summonSkill);
 }
 /**
- * @returns map containing the chance of an item to be summoned
+ * @returns Map containing the chance of an item to be summoned
  */
 export function expected() {
     return libramExpected;

package/dist/resources/2013/Florist.d.ts

@@ -18,9 +18,24 @@ declare class Flower {
     dig(): boolean;
     plant(): boolean;
 }
+/**
+ * @returns Whether or not the Florist is currently available
+ */
 export declare function have(): boolean;
+/**
+ * @param location The location to check
+ * @returns an array of the Flowers in that location
+ */
 export declare function flowersIn(location: Location): Flower[];
+/**
+ * @param location The location to check
+ * @returns an array of the Flowers we can plant in that location
+ */
 export declare function flowersAvailableFor(location?: Location): Flower[];
+/**
+ * @param location The location to check
+ * @returns `true` if the location has 3 flowers in it; `false` otherwise
+ */
 export declare function isFull(location?: Location): boolean;
 export declare const RabidDogwood: Flower;
 export declare const Rutabeggar: Flower;

package/dist/resources/2013/Florist.js

@@ -64,12 +64,25 @@ class Flower {
         return this.isPlantedHere();
     }
 }
+/**
+ * @returns Whether or not the Florist is currently available
+ */
 export function have() {
     return floristAvailable();
 }
+/**
+ * Internal function used to convert strings to Flower instances
+ *
+ * @param name The flower name
+ * @returns a Flower instance
+ */
 function toFlower(name) {
     return all.find((flower) => name === flower.name);
 }
+/**
+ * @param location The location to check
+ * @returns an array of the Flowers in that location
+ */
 export function flowersIn(location) {
     const returnValue = [];
     Flower.plantNamesInZone(location)
@@ -80,9 +93,17 @@ export function flowersIn(location) {
     });
     return returnValue;
 }
+/**
+ * @param location The location to check
+ * @returns an array of the Flowers we can plant in that location
+ */
 export function flowersAvailableFor(location = myLocation()) {
     return all.filter((flower) => flower.available(location));
 }
+/**
+ * @param location The location to check
+ * @returns `true` if the location has 3 flowers in it; `false` otherwise
+ */
 export function isFull(location = myLocation()) {
     return flowersIn(location).length === 3;
 }

package/dist/resources/2014/CrimboShrub.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @returns Whether we `have` the Crimbo Shrub in our terrarium
+ */
 export declare function have(): boolean;
 declare const Toppers: {
     readonly Muscle: 1;
@@ -26,5 +29,14 @@ declare const Gifts: {
     readonly Gifts: 3;
 };
 declare type ShrubGifts = keyof typeof Gifts;
+/**
+ * Decorates our Crimbo Shrub with the chosen decour, if able
+ *
+ * @param topper The shrub Topper to select
+ * @param lights The shrub Lights to select
+ * @param garland The shrub Garland to select
+ * @param gifts The shrub Gifts to select
+ * @returns Whether the shrub's decour perfectly matches the given decour
+ */
 export declare function decorate(topper: ShrubTopper, lights: ShrubLights, garland: ShrubGarland, gifts: ShrubGifts): boolean;
 export {};

package/dist/resources/2014/CrimboShrub.js

@@ -2,6 +2,9 @@ import { toInt, useFamiliar, visitUrl } from "kolmafia";
 import { have as have_ } from "../../lib";
 import { get } from "../../property";
 import { $familiar, $item } from "../../template-string";
+/**
+ * @returns Whether we `have` the Crimbo Shrub in our terrarium
+ */
 export function have() {
     return have_($familiar `Crimbo Shrub`);
 }
@@ -45,6 +48,15 @@ const Prefs = {
     meat: "Red Ray",
     gifts: "Gifts",
 };
+/**
+ * Internal function used to check whether decour perfectly matches what we want
+ *
+ * @param topper Topper to check for
+ * @param lights Lights to check for
+ * @param garland Garland to check for
+ * @param gifts Gifts to check for
+ * @returns Whether every single decour matches what we expect
+ */
 function isDecoratedWith(topper, lights, garland, gifts) {
     const decorations = [
         get("shrubTopper"),
@@ -54,6 +66,15 @@ function isDecoratedWith(topper, lights, garland, gifts) {
     ].map((x) => Prefs[x]);
     return [topper, lights, garland, gifts].every((x, i) => x === decorations[i]);
 }
+/**
+ * Decorates our Crimbo Shrub with the chosen decour, if able
+ *
+ * @param topper The shrub Topper to select
+ * @param lights The shrub Lights to select
+ * @param garland The shrub Garland to select
+ * @param gifts The shrub Gifts to select
+ * @returns Whether the shrub's decour perfectly matches the given decour
+ */
 export function decorate(topper, lights, garland, gifts) {
     if (!have())
         return false;
@@ -64,5 +85,5 @@ export function decorate(topper, lights, garland, gifts) {
     }
     visitUrl(`inv_use.php?pwd=&which=99&whichitem=${toInt($item `box of old Crimbo decorations`)}`);
     visitUrl(`choice.php?whichchoice=999&pwd=&option=1&topper=${Toppers[topper]}&lights=${Lights[lights]}&garland=${Garland[garland]}&gift=${Gifts[gifts]}`);
-    return true;
+    return isDecoratedWith(topper, lights, garland, gifts);
 }

package/dist/resources/2014/DNALab.d.ts

@@ -1,48 +1,56 @@
 import { Effect, Item, Phylum } from "kolmafia";
 /**
- * Checks if you have DNA lab in inventory or installed
+ * @returns Whether or not you `have` DNA lab or it's installed
  */
 export declare function have(): boolean;
 /**
- * Checks if you have DNA lab installed
+ * @returns Whether the DNA Lab is your currently active workshed
  */
 export declare function installed(): boolean;
 /**
  * Tells you whether you are currently hybridized. When passed with an input of any sort, tells you whether you are currently hybridized with that effect.
+ *
  * @param tonic Optional input. When passed, the function returns whether that specific effect is hybridized.
+ * @returns Whether the given tonic is currently hybridized
  */
 export declare function isHybridized(tonic?: Effect | Phylum | Item): boolean;
 /**
  * Returns the tonic item associated with a particular phylum.
+ *
  * @param phylum The phylum in question.
  * @returns The tonic item associated with that phylum; returns $item.none for $phylum.none.
  */
 export declare function getTonic(phylum: Phylum): Item;
 /**
  * Returns the tonic effect associated with a particular phylum.
+ *
  * @param phylum The phylum in question.
  * @returns The tonic effect associated with that phylum; returns $effect.none for $phylum.none.
  */
 export declare function getEffect(phylum: Phylum): Effect;
 /**
  * Tells you which phylum to hunt down for a given effect or item.
+ *
  * @param dnatype The tonic effect or item in question
  * @returns The Phylum associated with that effect or item; null if an invalid choice
  */
 export declare function phylumFor(dnatype: Effect | Item): Phylum | null;
 /**
  * Hybridize yourself with the current contents of your syringe, if possible.
+ *
  * @returns Whether or not we succeeded
  */
 export declare function hybridize(): boolean;
 /**
  * Makes tonics with whatever phylum is currently in your syringe
+ *
  * @param {number} [amount=1] the number of tonics to make
  * @returns Whether we successfully made tonics; returns true if we made as many as we could, regardless of whether that was the number requested
  */
 export declare function makeTonic(amount?: 1 | 2 | 3): boolean;
 /**
  * Tells you how many tonics you can make the rest of the day.
+ *
  * @returns The remaining tonics you can make
  */
 export declare function tonicsLeft(): number;

package/dist/resources/2014/DNALab.js

@@ -6,13 +6,13 @@ import { $effect, $item, $phylum } from "../../template-string";
 import { clamp } from "../../utils";
 const lab = $item `Little Geneticist DNA-Splicing Lab`;
 /**
- * Checks if you have DNA lab in inventory or installed
+ * @returns Whether or not you `have` DNA lab or it's installed
  */
 export function have() {
     return haveItem(lab) || getWorkshed() === lab;
 }
 /**
- * Checks if you have DNA lab installed
+ * @returns Whether the DNA Lab is your currently active workshed
  */
 export function installed() {
     return getWorkshed() === lab;
@@ -66,7 +66,9 @@ const phylaTonics = new Map([
 const tonicEffects = Array.from(phylaEffects.values());
 /**
  * Tells you whether you are currently hybridized. When passed with an input of any sort, tells you whether you are currently hybridized with that effect.
+ *
  * @param tonic Optional input. When passed, the function returns whether that specific effect is hybridized.
+ * @returns Whether the given tonic is currently hybridized
  */
 export function isHybridized(tonic) {
     if (!tonic)
@@ -80,6 +82,7 @@ export function isHybridized(tonic) {
 }
 /**
  * Returns the tonic item associated with a particular phylum.
+ *
  * @param phylum The phylum in question.
  * @returns The tonic item associated with that phylum; returns $item.none for $phylum.none.
  */
@@ -89,6 +92,7 @@ export function getTonic(phylum) {
 }
 /**
  * Returns the tonic effect associated with a particular phylum.
+ *
  * @param phylum The phylum in question.
  * @returns The tonic effect associated with that phylum; returns $effect.none for $phylum.none.
  */
@@ -98,6 +102,7 @@ export function getEffect(phylum) {
 }
 /**
  * Tells you which phylum to hunt down for a given effect or item.
+ *
  * @param dnatype The tonic effect or item in question
  * @returns The Phylum associated with that effect or item; null if an invalid choice
  */
@@ -113,6 +118,7 @@ export function phylumFor(dnatype) {
 }
 /**
  * Hybridize yourself with the current contents of your syringe, if possible.
+ *
  * @returns Whether or not we succeeded
  */
 export function hybridize() {
@@ -130,6 +136,7 @@ export function hybridize() {
 }
 /**
  * Makes tonics with whatever phylum is currently in your syringe
+ *
  * @param {number} [amount=1] the number of tonics to make
  * @returns Whether we successfully made tonics; returns true if we made as many as we could, regardless of whether that was the number requested
  */
@@ -147,6 +154,7 @@ export function makeTonic(amount = 1) {
 }
 /**
  * Tells you how many tonics you can make the rest of the day.
+ *
  * @returns The remaining tonics you can make
  */
 export function tonicsLeft() {

package/dist/resources/2014/WinterGarden.d.ts

@@ -1,8 +1,23 @@
 import { Monster } from "kolmafia";
 import { Copier } from "../../Copier";
+/**
+ * @returns Whether the Winter Garden is our currently installed garden
+ */
 export declare function have(): boolean;
+/**
+ * @returns Whether we have an unfinished ice sculpture hanging around
+ */
 export declare function haveUnfinishedIceSculpture(): boolean;
+/**
+ * @returns Whether or not we've used an unfinished ice sculpture today
+ */
 export declare function isUnfinishedIceSculptureUsed(): boolean;
+/**
+ * @returns Whether we're able to use an unfinished ice sculpture in combat right now
+ */
 export declare function couldUseUnfinishedIceSculpture(): boolean;
+/**
+ * @returns Our current ice sculpture monster; `null` if none
+ */
 export declare function getUnfinishedIceSculptureMonster(): Monster | null;
 export declare const UnfinishedIceSculpture: Copier;

package/dist/resources/2014/WinterGarden.js

@@ -2,18 +2,33 @@ import { Copier } from "../../Copier";
 import { haveInCampground, have as haveItem } from "../../lib";
 import { get } from "../../property";
 import { $item } from "../../template-string";
+/**
+ * @returns Whether the Winter Garden is our currently installed garden
+ */
 export function have() {
     return haveInCampground($item `packet of winter seeds`);
 }
+/**
+ * @returns Whether we have an unfinished ice sculpture hanging around
+ */
 export function haveUnfinishedIceSculpture() {
     return haveItem($item `unfinished ice sculpture`);
 }
+/**
+ * @returns Whether or not we've used an unfinished ice sculpture today
+ */
 export function isUnfinishedIceSculptureUsed() {
     return get("_iceSculptureUsed");
 }
+/**
+ * @returns Whether we're able to use an unfinished ice sculpture in combat right now
+ */
 export function couldUseUnfinishedIceSculpture() {
     return (haveItem($item `unfinished ice sculpture`) && !haveItem($item `ice sculpture`));
 }
+/**
+ * @returns Our current ice sculpture monster; `null` if none
+ */
 export function getUnfinishedIceSculptureMonster() {
     return get("iceSculptureMonster");
 }

package/dist/resources/2015/BarrelShrine.d.ts

@@ -1,2 +1,8 @@
+/**
+ * @returns Whether we have the barrel shrine
+ */
 export declare function have(): boolean;
+/**
+ * Smashes all barrels in our inventory
+ */
 export declare function smashParty(): void;

package/dist/resources/2015/BarrelShrine.js

@@ -2,9 +2,15 @@ import { availableAmount, runChoice, visitUrl } from "kolmafia";
 import { get } from "../../property";
 import { $items } from "../../template-string";
 const BARRELS = $items `little firkin, normal barrel, big tun, weathered barrel, dusty barrel, disintegrating barrel, moist barrel, rotting barrel, mouldering barrel, barnacled barrel`;
+/**
+ * @returns Whether we have the barrel shrine
+ */
 export function have() {
     return get("barrelShrineUnlocked");
 }
+/**
+ * Smashes all barrels in our inventory
+ */
 export function smashParty() {
     if (!have())
         return;

package/dist/resources/2015/ChateauMantegna.d.ts

@@ -1,7 +1,21 @@
 import { Monster } from "kolmafia";
+/**
+ * @returns Whether we own the Chateau Mantegna
+ */
 export declare function have(): boolean;
+/**
+ * @returns `null` for an empty painting; otherwise, the monster trapped in our painting
+ */
 export declare function paintingMonster(): Monster | null;
+/**
+ * @returns Whether or not we've fought our painted monster today
+ */
 export declare function paintingFought(): boolean;
+/**
+ * Fights your currently installed painting monster if able
+ *
+ * @returns The result of `runCombat`, which is the page html of the final round of combat
+ */
 export declare function fightPainting(): string;
 export declare const desks: readonly ["fancy stationery set", "Swiss piggy bank", "continental juice bar"];
 export declare const ceilings: readonly ["antler chandelier", "ceiling fan", "artificial skylight"];
@@ -9,9 +23,30 @@ export declare const nightstands: readonly ["foreign language tapes", "bowl of p
 export declare type Desk = typeof desks[number];
 export declare type Ceiling = typeof ceilings[number];
 export declare type Nightstand = typeof nightstands[number];
+/**
+ * @returns The currently installed desk in your chateau; `null` for none
+ */
 export declare function getDesk(): Desk | null;
+/**
+ * @returns The currently installed ceiling in your chateau; `null` for none
+ */
 export declare function getCeiling(): Ceiling | null;
+/**
+ * @returns The currently installed nightstand in your chateau; `null` for none
+ */
 export declare function getNightstand(): Nightstand | null;
+/**
+ * @param desk The desk to change to
+ * @returns Whether our desk currently matches the one requested
+ */
 export declare function changeDesk(desk: Desk): boolean;
+/**
+ * @param ceiling The ceiling to change to
+ * @returns Whether our ceiling currently matches the one requested
+ */
 export declare function changeCeiling(ceiling: Ceiling): boolean;
+/**
+ * @param nightstand The nightstand to change to
+ * @returns Whether our nightstand currently matches the one requested
+ */
 export declare function changeNightstand(nightstand: Nightstand): boolean;