libram 0.7.11 → 0.7.13

package/dist/index.js

@@ -5,6 +5,7 @@ export * from "./challengePaths";
 export * from "./combat";
 export * as Counter from "./counter";
 export * from "./diet";
+export * from "./Dungeon";
 export * from "./lib";
 export * from "./maximize";
 export * from "./mood";
@@ -22,6 +23,3 @@ export * from "./utils";
 export { get, PropertiesManager, set, setProperties, withProperties, withProperty, withChoices, withChoice, } from "./property";
 export { get as getModifier } from "./modifier";
 export { Session } from "./session";
-export * as Dreadsylvania from "./dungeons/Dreadsylvania";
-export * as Hobopolis from "./dungeons/Hobopolis";
-export * as SlimeTube from "./dungeons/SlimeTube";

package/dist/lib.d.ts

@@ -1,83 +1,92 @@
-/** @module GeneralLibrary */
-import "core-js/modules/es.object.entries";
-import "core-js/features/array/flat";
 import { Effect, Element, Familiar, Item, Location, Monster, Servant, Skill, Stat, Thrall } from "kolmafia";
 /**
- * Returns the current maximum Accordion Thief songs the player can have in their head
+ * Determines the current maximum Accordion Thief songs the player can have in their head
  *
  * @category General
+ * @returns Maximum number of songs for player
  */
 export declare function getSongLimit(): number;
 /**
- * Return whether the Skill or Effect provided is an Accordion Thief song
+ * Determine whether the Skill or Effect provided is an Accordion Thief song
  *
  * @category General
  * @param skillOrEffect The Skill or Effect
+ * @returns Whether it's a song
  */
 export declare function isSong(skillOrEffect: Skill | Effect): boolean;
 /**
  * List all active Effects
  *
  * @category General
+ * @returns List of Effects
  */
 export declare function getActiveEffects(): Effect[];
 /**
  * List currently active Accordion Thief songs
  *
  * @category General
+ * @returns List of song Effects
  */
 export declare function getActiveSongs(): Effect[];
 /**
  * List number of active Accordion Thief songs
  *
  * @category General
+ * @returns Number of songs
  */
 export declare function getSongCount(): number;
 /**
- * Returns true if the player can remember another Accordion Thief song
+ * Determine whether player can remember another Accordion Thief song
  *
  * @category General
  * @param quantity Number of songs to test the space for
+ * @returns Whether player can remember another song
  */
 export declare function canRememberSong(quantity?: number): boolean;
 /**
- * Return the locations in which the given monster can be encountered naturally
+ * Determine the locations in which the given monster can be encountered naturally
  *
  * @category General
  * @param monster Monster to find
+ * @returns Locations for monster
  */
 export declare function getMonsterLocations(monster: Monster): Location[];
 /**
- * Return the player's remaining liver space
+ * Determine the player's remaining liver space
  *
  * @category General
+ * @returns Remaining liver space
  */
 export declare function getRemainingLiver(): number;
 /**
- * Return the player's remaining stomach space
+ * Determine the player's remaining stomach space
  *
  * @category General
+ * @returns Remaining stomach space
  */
 export declare function getRemainingStomach(): number;
 /**
- * Return the player's remaining spleen space
+ * Determine the player's remaining spleen space
  *
  * @category General
+ * @returns Remaining spleen space
  */
 export declare function getRemainingSpleen(): number;
 /**
- * Return whether the player "has" any entity which one could feasibly "have".
+ * Determine whether the player "has" any entity which one could feasibly "have".
  *
  * @category General
  * @param thing Thing to check
- * @param quantity Number to check that the player has
+ * @param quantity Minimum quantity the player must have to pass
+ * @returns Whether the player meets the requirements of owning the supplied thing
  */
 export declare function have(thing: Effect | Familiar | Item | Servant | Skill | Thrall, quantity?: number): boolean;
 /**
- * Return whether an item is in the player's campground
+ * Determine whether a given item is in the player's campground
  *
  * @category General
- * @param item The item mafia uses to represent the campground item
+ * @param item The Item KoLmafia uses to represent the campground item
+ * @returns Whether the item is in the campground
  */
 export declare function haveInCampground(item: Item): boolean;
 export declare enum Wanderer {
@@ -92,22 +101,29 @@ export declare enum Wanderer {
     Vote = "Vote Monster"
 }
 /**
- * Return whether the player has the queried counter
+ * Determine whether the player has the specified counter
  *
+ * @param counterName Name of the counter
+ * @param minTurns Minimum turns the counter is set to
+ * @param maxTurns Maximum turns the counter is set to
  * @category General
+ * @returns Whether player has the counter
  */
 export declare function haveCounter(counterName: string, minTurns?: number, maxTurns?: number): boolean;
 /**
- * Return whether the player has the queried wandering counter
+ * Determine whether the player has the specified wanderer's counter
  *
+ * @param wanderer Wanderer to check
  * @category Wanderers
+ * @returns Whether player has the wanderer counter
  */
 export declare function haveWandererCounter(wanderer: Wanderer): boolean;
 /**
- * Returns whether the player will encounter a vote wanderer on the next turn,
+ * Determine whether the player will encounter a vote wanderer on the next turn,
  * providing an "I Voted!" sticker is equipped.
  *
  * @category Wanderers
+ * @returns Whether the vote wanderer is due
  */
 export declare function isVoteWandererNow(): boolean;
 /**
@@ -125,17 +141,19 @@ export declare function isVoteWandererNow(): boolean;
  *
  * @category Wanderers
  * @param wanderer Wanderer to check
+ * @returns Whether the wanderer is due
  */
 export declare function isWandererNow(wanderer: Wanderer): boolean;
 /**
- * Returns the float chance the player will encounter a sausage goblin on the
+ * Determines the chance the player will encounter a sausage goblin on the
  * next turn, providing the Kramco Sausage-o-Matic is equipped.
  *
  * @category Wanderers
+ * @returns Chance that the sausage goblin is due (as a number between 0 and 1)
  */
 export declare function getKramcoWandererChance(): number;
 /**
- * Returns the float chance the player will encounter an Artistic Goth Kid or
+ * Determines the chance the player will encounter an Artistic Goth Kid or
  * Mini-Hipster wanderer on the next turn, providing a familiar is equipped.
  *
  * NOTE: You must complete one combat with the Artistic Goth Kid before you
@@ -143,69 +161,79 @@ export declare function getKramcoWandererChance(): number;
  * Artist Goth Kid is effectively 0% chance to encounter a wanderer.
  *
  * @category Wanderers
+ * @returns Chance that the familiar wanderer is due (as a number between 0 and 1)
  */
 export declare function getFamiliarWandererChance(): number;
 /**
- * Returns the float chance the player will encounter the queried wanderer
+ * Determines the chance the player will encounter the specified wanderer
  * on the next turn.
  *
  * @category Wanderers
  * @param wanderer Wanderer to check
+ * @returns Chance that the specified wanderer is due (as a number between 0 and 1)
  */
 export declare function getWandererChance(wanderer: Wanderer): number;
 /**
- * Returns true if the player's current familiar is equal to the one supplied
+ * Determines whether the player's current familiar is equal to the one supplied
  *
  * @category General
  * @param familiar Familiar to check
+ * @returns Whether it is the player's current familiar
  */
 export declare function isCurrentFamiliar(familiar: Familiar): boolean;
 /**
- * Returns the fold group (if any) of which the given item is a part
+ * Determines the fold group (if any) of which the given item is a part
  *
  * @category General
  * @param item Item that is part of the required fold group
+ * @returns List of items in the fold group
  */
 export declare function getFoldGroup(item: Item): Item[];
 /**
- * Returns the zap group (if any) of which the given item is a part
+ * Determines the zap group (if any) of which the given item is a part
  *
  * @category General
  * @param item Item that is part of the required zap group
+ * @returns List of items in the zap group
  */
 export declare function getZapGroup(item: Item): Item[];
 /**
  * Get a map of banished monsters keyed by what banished them
  *
  * @category General
+ * @returns Map of banished monsters
  */
 export declare function getBanishedMonsters(): Map<Item | Skill, Monster>;
 /**
- * Returns true if the item is usable
+ * Determines whether the item is usable
  *
  * This function will be an ongoing work in progress
  *
  * @param item Item to check
+ * @returns Whether item is usable
  */
 export declare function canUse(item: Item): boolean;
 /**
  * Turn KoLmafia `none`s to JavaScript `null`s
  *
  * @param thing Thing that can have a mafia "none" value
+ * @returns The thing specified or `null`
  */
 export declare function noneToNull<T>(thing: T): T | null;
 /**
- * Return the average value from the sort of range that KoLmafia encodes as a string
+ * Determine the average value from the sort of range that KoLmafia encodes as a string
  *
  * @param range KoLmafia-style range string
+ * @returns Average value fo range
  */
 export declare function getAverage(range: string): number;
 /**
- * Return average adventures expected from consuming an item
+ * Deternube tge average adventures expected from consuming an Item
  *
  * If item is not a consumable, will just return "0".
  *
  * @param item Consumable item
+ * @returns Average aventures from consumable
  */
 export declare function getAverageAdventures(item: Item): number;
 /**
@@ -213,6 +241,7 @@ export declare function getAverageAdventures(item: Item): number;
  *
  * @category General
  * @param effect Effect to remove
+ * @returns Success
  */
 export declare function uneffect(effect: Effect): boolean;
 export declare type Player = {
@@ -227,9 +256,10 @@ export declare type Player = {
  */
 export declare function getPlayerFromIdOrName(idOrName: number | string): Player;
 /**
- * Return the step as a number for a given quest property.
+ * Determine the step as a number for a given quest property.
  *
  * @param questName Name of quest property to check.
+ * @returns Quest step
  */
 export declare function questStep(questName: string): number;
 export declare class EnsureError extends Error {
@@ -237,15 +267,17 @@ export declare class EnsureError extends Error {
 }
 /**
  * Tries to get an effect using the default method
+ *
  * @param ef effect to try to get
  * @param turns turns to aim for; default of 1
- *
  * @throws {EnsureError} Throws an error if the effect cannot be guaranteed
  */
 export declare function ensureEffect(ef: Effect, turns?: number): void;
 /**
- * Returns the average value--based on mallprice and autosell--of a collection of items
+ * Determiens the average value (based on mallprice and autosell) of a collection of items
+ *
  * @param items items whose value you care about
+ * @returns Average value of items
  */
 export declare function getSaleValue(...items: Item[]): number;
 export declare const Environment: {
@@ -256,33 +288,47 @@ export declare const Environment: {
 };
 export declare type EnvironmentType = typeof Environment[keyof typeof Environment];
 /**
- * Returns the weight-coefficient of any leprechaunning that this familiar may find itself doing
+ * Determines the weight-coefficient of any leprechaunning that this familiar may find itself doing
  * Assumes the familiar is nude and thus fails for hatrack & pantsrack
  * For the Mutant Cactus Bud, returns the efficacy-multiplier instead
+ *
  * @param familiar The familiar whose leprechaun multiplier you're interested in
+ * @returns Weight-coefficient
  */
 export declare function findLeprechaunMultiplier(familiar: Familiar): number;
 /**
- * Returns the weight-coefficient of any baby gravy fairying that this familiar may find itself doing
+ * Determines the weight-coefficient of any baby gravy fairying that this familiar may find itself doing
  * Assumes the familiar is nude and thus fails for hatrack & pantsrack
  * For the Mutant Fire Ant, returns the efficacy-multiplier instead
+ *
  * @param familiar The familiar whose fairy multiplier you're interested in
+ * @returns Weight-coefficient
  */
 export declare function findFairyMultiplier(familiar: Familiar): number;
 export declare const holidayWanderers: Map<string, Monster[]>;
+/**
+ * Get today's holiday wanderers
+ *
+ * @returns List of holiday wanderer Monsters
+ */
 export declare function getTodaysHolidayWanderers(): Monster[];
 /**
- * Determines & returns whether or not we can safely call visitUrl(), based on whether we're in a fight, multi-fight, choice, etc
+ * Determines whether or not we can safely call visitUrl(), based on whether we're in a fight, multi-fight, choice, etc
+ *
+ * @returns Whether urls can be safely visited
  */
 export declare function canVisitUrl(): boolean;
 /**
  * Calculate damage taken from a specific element after factoring in resistance
- * @param baseDamage
- * @param element
+ *
+ * @param baseDamage Base damage
+ * @param element Element
  * @returns damage after factoring in resistances
  */
 export declare function damageTakenByElement(baseDamage: number, element: Element): number;
 /**
+ * Get information from telescope
+ *
  * @returns An object with all information the telescope gives you about the sorceress's contests and maze
  */
 export declare function telescope(): {
@@ -292,3 +338,24 @@ export declare function telescope(): {
     hedge2?: Element;
     hedge3?: Element;
 };
+/**
+ * Visit the desc_x.php page for a given thing
+ *
+ * @param thing Thing to examine
+ * @returns Contents of desc_x.php page
+ */
+export declare function examine(thing: Item | Familiar | Effect | Skill): string;
+/**
+ * Picks an option based on your primestat
+ *
+ * @param options An object keyed by stat; it must either contain all stats, or have a `default` parameter.
+ * @returns The option corresponding to your primestat.
+ */
+export declare const byStat: <S>(options: import("./utils").Switch<import("kolmafia").StatType, S>) => S;
+/**
+ * Picks an option based on your player class
+ *
+ * @param options An object keyed by player class; it must either contain all classes, or have a `default` parameter.
+ * @returns The option corresponding to your player class.
+ */
+export declare const byClass: <S>(options: import("./utils").Switch<import("kolmafia").ClassType, S>) => S;