libram 0.7.11 → 0.7.14

package/dist/resources/2018/SongBoom.d.ts

@@ -1,4 +1,7 @@
 export declare const item: import("kolmafia").Item;
+/**
+ * @returns Whether we `have` the SongBoom™ BoomBox
+ */
 export declare function have(): boolean;
 declare const keywords: {
     "Eye of the Giger": string;
@@ -10,20 +13,22 @@ declare const keywords: {
 export declare type SongBoomSong = keyof typeof keywords | null;
 export declare const songBoomSongs: Set<string>;
 /**
- * Current song.
+ * @returns The `SongBoomSong` you currently have active; `null` if none is active at this time
  */
 export declare function song(): SongBoomSong;
 /**
- * Song changes left today.
+ * @returns Song changes left today.
  */
 export declare function songChangesLeft(): number;
 /**
- * Change the song.
+ * Change the song. Throws an error if unable.
+ *
  * @param newSong Song to change to.
+ * @returns Whether we successfully changed the song; `false` thus means that this was already our current song.
  */
 export declare function setSong(newSong: SongBoomSong): boolean;
 /**
- * Progress to next song drop (e.g. gathered meat-clip).
+ * @returns Progress to next song drop (e.g. gathered meat-clip).
  */
 export declare function dropProgress(): number;
 export {};

package/dist/resources/2018/SongBoom.js

@@ -3,6 +3,9 @@ import { have as haveItem } from "../../lib";
 import { get } from "../../property";
 import { $item } from "../../template-string";
 export const item = $item `SongBoom™ BoomBox`;
+/**
+ * @returns Whether we `have` the SongBoom™ BoomBox
+ */
 export function have() {
     return haveItem(item);
 }
@@ -15,21 +18,23 @@ const keywords = {
 };
 export const songBoomSongs = new Set(Object.keys(keywords));
 /**
- * Current song.
+ * @returns The `SongBoomSong` you currently have active; `null` if none is active at this time
  */
 export function song() {
     const stored = get("boomBoxSong");
     return songBoomSongs.has(stored) ? stored : null;
 }
 /**
- * Song changes left today.
+ * @returns Song changes left today.
  */
 export function songChangesLeft() {
     return get("_boomBoxSongsLeft");
 }
 /**
- * Change the song.
+ * Change the song. Throws an error if unable.
+ *
  * @param newSong Song to change to.
+ * @returns Whether we successfully changed the song; `false` thus means that this was already our current song.
  */
 export function setSong(newSong) {
     if (song() !== newSong) {
@@ -43,7 +48,7 @@ export function setSong(newSong) {
     }
 }
 /**
- * Progress to next song drop (e.g. gathered meat-clip).
+ * @returns Progress to next song drop (e.g. gathered meat-clip).
  */
 export function dropProgress() {
     return get("_boomBoxFights");

package/dist/resources/2019/BeachComb.d.ts

@@ -1,4 +1,9 @@
 import { Effect } from "kolmafia";
+/**
+ * Determines whether we `have` the beach comb
+ *
+ * @returns Whether we `have` the beach comb
+ */
 export declare function have(): boolean;
 export declare const headBuffs: readonly [Effect, Effect, Effect, Effect, Effect, Effect, Effect, Effect, Effect, Effect, Effect];
 export declare const head: {
@@ -21,9 +26,41 @@ export declare type BeachTile = {
     row: number;
     column: number;
 };
+/**
+ * Calculates the tide level for a given game day
+ *
+ * @param day The day to check the tide level of; defaults to today
+ * @returns The tide level as an integer
+ */
 export declare function tideLevel(day?: number): number;
-export declare function canComb({ row }: BeachTile): boolean;
+/**
+ * Determines whether a given tile can currently be combed, based on the tide level
+ *
+ * @param tile The tile to check
+ * @returns Whether today's tides permit the combing of this tile
+ */
+export declare function canComb(tile: BeachTile): boolean;
+/**
+ * @returns The number of free combs we have available for today
+ */
 export declare function freeCombs(): number;
+/**
+ * Comb a tile or tiles; skips any presently uncombablle tiles
+ *
+ * @param tiles The tiles to comb
+ */
 export declare function comb(...tiles: BeachTile[]): void;
+/**
+ * Determines whether a given Beach Head can be combed today
+ *
+ * @param target The head in question, either as the Effect it grants or as its name
+ * @returns Whether the given head is combable
+ */
 export declare function headAvailable(target: Effect | keyof typeof head): boolean;
+/**
+ * Tries to comb a given Beach Head
+ *
+ * @param target The Beach Head to comb, given either as its effect or as its name
+ * @returns Whether we have the head effect at the end of the whole rigamarole; this means that if you `tryHead` when you already have the effect, it will (presumably) fail to comb but will return `true`
+ */
 export declare function tryHead(target: Effect | keyof typeof head): boolean;

package/dist/resources/2019/BeachComb.js

@@ -3,6 +3,11 @@ import { have as have_ } from "../../lib";
 import { get } from "../../property";
 import { $effect } from "../../template-string";
 import { clamp } from "../../utils";
+/**
+ * Determines whether we `have` the beach comb
+ *
+ * @returns Whether we `have` the beach comb
+ */
 export function have() {
     return have_(Item.get("Beach Comb"));
 }
@@ -31,16 +36,36 @@ export const head = {
     FAMILIAR: $effect `Do I Know You From Somewhere?`,
     EXPERIENCE: $effect `You Learned Something Maybe!`,
 };
+/**
+ * Calculates the tide level for a given game day
+ *
+ * @param day The day to check the tide level of; defaults to today
+ * @returns The tide level as an integer
+ */
 export function tideLevel(day = gamedayToInt()) {
     const dayOfMonth = 1 + (day % 8);
     return 4 - Math.abs(4 - dayOfMonth);
 }
-export function canComb({ row }) {
-    return row > tideLevel();
+/**
+ * Determines whether a given tile can currently be combed, based on the tide level
+ *
+ * @param tile The tile to check
+ * @returns Whether today's tides permit the combing of this tile
+ */
+export function canComb(tile) {
+    return tile.row > tideLevel();
 }
+/**
+ * @returns The number of free combs we have available for today
+ */
 export function freeCombs() {
     return have() ? clamp(11 - get("_freeBeachWalksUsed"), 0, 11) : 0;
 }
+/**
+ * Comb a tile or tiles; skips any presently uncombablle tiles
+ *
+ * @param tiles The tiles to comb
+ */
 export function comb(...tiles) {
     if (!have() || !tiles.length)
         return;
@@ -54,6 +79,12 @@ export function comb(...tiles) {
     if (handlingChoice())
         runChoice(5);
 }
+/**
+ * Determines whether a given Beach Head can be combed today
+ *
+ * @param target The head in question, either as the Effect it grants or as its name
+ * @returns Whether the given head is combable
+ */
 export function headAvailable(target) {
     const effect = target instanceof Effect ? target : head[target];
     const headNumber = 1 + headBuffs.indexOf(effect);
@@ -62,6 +93,12 @@ export function headAvailable(target) {
         .includes(headNumber.toString()) &&
         !getProperty("_beachHeadsUsed").split(",").includes(headNumber.toString()));
 }
+/**
+ * Tries to comb a given Beach Head
+ *
+ * @param target The Beach Head to comb, given either as its effect or as its name
+ * @returns Whether we have the head effect at the end of the whole rigamarole; this means that if you `tryHead` when you already have the effect, it will (presumably) fail to comb but will return `true`
+ */
 export function tryHead(target) {
     const effect = target instanceof Effect ? target : head[target];
     if (!headBuffs.includes(effect))

package/dist/resources/2019/Snapper.d.ts

@@ -9,21 +9,25 @@ export declare const phylumItem: Map<Phylum, Item>;
 export declare const itemPhylum: Map<Item, Phylum>;
 /**
  * Return whether you have a Red-Nosed Snapper.
+ *
  * @returns True if you have a Red-Nosed Snapper, false otherwise.
  */
 export declare function have(): boolean;
 /**
  * Get the phylum currently being tracked by the snapper.
+ *
  * @returns Tracked phylum, or null if no phylum tracked.
  */
 export declare function getTrackedPhylum(): Phylum | null;
 /**
  * Set snapper tracking to a certain phylum.
+ *
  * @param phylum Phylum to track.
  */
 export declare function trackPhylum(phylum: Phylum): void;
 /**
  * Get progress to next snapper drop.
+ *
  * @returns Number of fights completed (out of 11) to reach next drop.
  */
 export declare function getProgress(): number;

package/dist/resources/2019/Snapper.js

@@ -34,6 +34,7 @@ export const phylumItem = new Map([
 export const itemPhylum = new Map([...phylumItem].map(([phylum, item]) => [item, phylum]));
 /**
  * Return whether you have a Red-Nosed Snapper.
+ *
  * @returns True if you have a Red-Nosed Snapper, false otherwise.
  */
 export function have() {
@@ -41,6 +42,7 @@ export function have() {
 }
 /**
  * Get the phylum currently being tracked by the snapper.
+ *
  * @returns Tracked phylum, or null if no phylum tracked.
  */
 export function getTrackedPhylum() {
@@ -48,6 +50,7 @@ export function getTrackedPhylum() {
 }
 /**
  * Set snapper tracking to a certain phylum.
+ *
  * @param phylum Phylum to track.
  */
 export function trackPhylum(phylum) {
@@ -62,6 +65,7 @@ export function trackPhylum(phylum) {
 }
 /**
  * Get progress to next snapper drop.
+ *
  * @returns Number of fights completed (out of 11) to reach next drop.
  */
 export function getProgress() {

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

@@ -1,5 +1,18 @@
 import { Location, Monster } from "kolmafia";
 export declare const passive: import("kolmafia").Skill;
 export declare const skill: import("kolmafia").Skill;
+/**
+ * Determines whether you `have` the skill Comprehensive Cartography
+ *
+ * @returns Whether you currently `have` the skill
+ */
 export declare function have(): boolean;
+/**
+ * Map a particular monster in a particular location
+ * You'll need to set your autoattack or CCS in advance of using this. Additionally, it will loop to try to avoid time-spinner pranks or zone intro adventures
+ *
+ * @param location The location to target
+ * @param monster The monster to target
+ * @returns Whether we successfully mapped the monster
+ */
 export declare function mapMonster(location: Location, monster: Monster): boolean;

package/dist/resources/2020/Cartography.js

@@ -4,9 +4,22 @@ import { get } from "../../property";
 import { $skill } from "../../template-string";
 export const passive = $skill `Comprehensive Cartography`;
 export const skill = $skill `Map the Monsters`;
+/**
+ * Determines whether you `have` the skill Comprehensive Cartography
+ *
+ * @returns Whether you currently `have` the skill
+ */
 export function have() {
     return _have(passive);
 }
+/**
+ * Map a particular monster in a particular location
+ * You'll need to set your autoattack or CCS in advance of using this. Additionally, it will loop to try to avoid time-spinner pranks or zone intro adventures
+ *
+ * @param location The location to target
+ * @param monster The monster to target
+ * @returns Whether we successfully mapped the monster
+ */
 export function mapMonster(location, monster) {
     if (!have())
         return false;

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

@@ -1,77 +1,123 @@
 import { Item, Location } from "kolmafia";
 export declare const item: Item;
+/**
+ * Determines whether you `have` Guzzlr
+ *
+ * @returns Whether you `have` Guzzlr
+ */
 export declare function have(): boolean;
+/**
+ * Determines whether you currently have an active Guzzlr quest
+ *
+ * @returns Whether you currently have an active Guzzlr quest
+ */
 export declare function isQuestActive(): boolean;
 /**
- * Platinum deliveries completed overall
+ * Determines total number of Platinum deliveries completed
+ *
+ * @returns Platinum deliveries completed overall
  */
 export declare function getPlatinum(): number;
 /**
- * Platinum deliveries completed today
+ * Determines the number of Platinum deliveries completed today
+ *
+ * @returns Platinum deliveries completed today
  */
 export declare function getPlatinumToday(): number;
 /**
- * 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 declare function canPlatinum(): boolean;
 /**
- * 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 declare function haveFullPlatinumBonus(): boolean;
 /**
- * Accept platinum delivery
+ * Accepts a Platinum delivery
+ *
+ * @returns Whether we succeeded in this endeavor
  */
 export declare function acceptPlatinum(): boolean;
 /**
- * Gold deliveries completed overall
+ * Determines total number of Gold deliveries completed
+ *
+ * @returns Gold deliveries completed overall
  */
 export declare function getGold(): number;
 /**
- * Gold deliveries completed today
+ * Determines the number of Gold deliveries completed today
+ *
+ * @returns Gold deliveries completed today
  */
 export declare function getGoldToday(): number;
 /**
- * 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 declare function canGold(): boolean;
 /**
- * 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 declare function haveFullGoldBonus(): boolean;
 /**
- * Accept gold delivery
+ * Accepts a Gold delivery
+ *
+ * @returns Whether we succeeded in this endeavor
  */
 export declare function acceptGold(): boolean;
 /**
- * Bronze deliveries completed overall
+ * Determines total number of Bronze deliveries completed
+ *
+ * @returns Bronze deliveries completed overall
  */
 export declare function getBronze(): number;
 /**
- * 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 declare function acceptBronze(): boolean;
+export declare function haveFullBronzeBonus(): boolean;
 /**
- * Have fully unlocked the platinum delivery bonuses (done >= 30)
+ * Accepts a Bronze delivery
+ *
+ * @returns Whether we succeeded in this endeavor
  */
-export declare function haveFullBronzeBonus(): boolean;
+export declare function acceptBronze(): boolean;
 /**
- * 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 declare function canAbandon(): boolean;
 /**
- * Abandon Guzzlr quest
+ * Abandons Guzzlr quest
+ *
+ * @returns `false` if we were unable to abandon a quest; `true` otherwise
  */
 export declare function abandon(): boolean;
 /**
- * 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 declare function getLocation(): Location | null;
 /**
- * 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 declare function getTier(): "platinum" | "gold" | "bronze" | null;
 /**
- * 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 declare function getBooze(): Item | null;
 /**
@@ -79,17 +125,37 @@ export declare function getBooze(): Item | null;
  */
 export declare const Cocktails: Item[];
 /**
- * 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 declare function havePlatinumBooze(): boolean;
 /**
- * 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 declare function haveBooze(): boolean;
 export declare const ingredientToPlatinumCocktail: Map<Item, Item>;
 export declare const platinumCocktailToIngredient: Map<Item, Item>;
+/**
+ * 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 declare function getCheapestPlatinumCocktail(freeCraft?: boolean): Item;
+/**
+ * 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 declare function turnsLeftOnQuest(useShoes?: boolean): number;
+/**
+ * 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 declare function expectedReward(usePants?: boolean): number;