libram 0.7.11 → 0.7.13

package/dist/resources/2017/AsdonMartin.d.ts

@@ -1,15 +1,20 @@
-import "core-js/modules/es.object.values";
 import { Effect, Item } from "kolmafia";
 /**
- * Returns whether or not we have the Asdon installed in the workshed at present.
+ * @returns Whether the Asdon is our current active workshed
  */
 export declare function installed(): boolean;
 /**
- * Returns true if we have the Asdon or if it's installed.
+ * @returns `true` if we `have` the Asdon or if it's installed
  */
 export declare function have(): boolean;
+/**
+ * @param it the item in question
+ * @returns Can `it` be used as Asdon fuel?
+ */
+export declare function isFuelItem(it: Item): boolean;
 /**
  * Fuel your Asdon Martin with a given quantity of a given item
+ *
  * @param it Item to fuel with.
  * @param quantity Number of items to fuel with.
  * @returns Whether we succeeded at fueling with the given items.
@@ -17,12 +22,14 @@ export declare function have(): boolean;
 export declare function insertFuel(it: Item, quantity?: number): boolean;
 /**
  * Fill your Asdon Martin to the given fuel level in the cheapest way possible
+ *
  * @param targetUnits Fuel level to attempt to reach.
  * @returns Whether we succeeded at filling to the target fuel level.
  */
 export declare function fillTo(targetUnits: number): boolean;
 /**
  * Fill your Asdon Martin by prioritizing mallmin items in your inventory. Default to the behavior of fillTo.
+ *
  * @param targetUnits Fuel level to attempt to reach.
  * @returns Whether we succeeded at filling to the target fuel level.
  */
@@ -43,6 +50,7 @@ export declare const Driving: {
 };
 /**
  * Attempt to drive with a particular style for a particular number of turns.
+ *
  * @param style The driving style to use.
  * @param turns The number of turns to attempt to get.
  * @param preferInventory Whether we should preferentially value items currently in our inventory.

package/dist/resources/2017/AsdonMartin.js

@@ -1,4 +1,3 @@
-import "core-js/modules/es.object.values";
 import { autosellPrice, buy, canInteract, cliExecute, getFuel, getWorkshed, haveEffect, historicalAge, historicalPrice, isNpcItem, Item, itemAmount, mallPrice, mallPrices, retrieveItem, toInt, visitUrl, } from "kolmafia";
 import { getAverageAdventures, have as haveItem } from "../../lib";
 import { $effect, $item, $items } from "../../template-string";
@@ -10,31 +9,50 @@ var PriceAge;
     PriceAge[PriceAge["TODAY"] = 2] = "TODAY";
 })(PriceAge || (PriceAge = {}));
 /**
- * Returns whether or not we have the Asdon installed in the workshed at present.
+ * @returns Whether the Asdon is our current active workshed
  */
 export function installed() {
     return getWorkshed() === $item `Asdon Martin keyfob`;
 }
 /**
- * Returns true if we have the Asdon or if it's installed.
+ * @returns `true` if we `have` the Asdon or if it's installed
  */
 export function have() {
     return installed() || haveItem($item `Asdon Martin keyfob`);
 }
 const fuelSkiplist = $items `cup of "tea", thermos of "whiskey", Lucky Lindy, Bee's Knees, Sockdollager, Ish Kabibble, Hot Socks, Phonus Balonus, Flivver, Sloppy Jalopy, glass of "milk"`;
+/**
+ * Internal function used to determine whether a historical price is recent enough
+ *
+ * @param item The item to check
+ * @returns Whether a price is too old to trust
+ */
 function priceTooOld(item) {
     return historicalPrice(item) === 0 || historicalAge(item) >= 7;
 }
-// Return mall max if historicalPrice returns -1.
+/**
+ * @param item The item in question
+ * @returns Mall max if historicalPrice is -1; otherwise, the historical price
+ */
 function historicalPriceOrMax(item) {
     const historical = historicalPrice(item);
     return historical < 0 ? 999999999 : historical;
 }
-// Return mall max if mallPrice returns -1.
+/**
+ * @param item The item in question
+ * @returns Mall max if historicalPrice is -1; otherwise, the mall price
+ */
 function mallPriceOrMax(item) {
     const mall = mallPrice(item);
     return mall < 0 ? 999999999 : mall;
 }
+/**
+ * Combined internal function to determine the price of an item
+ *
+ * @param item The item in question
+ * @param priceAge How do we decide when to use historical vs real mall prices?
+ * @returns The price of the item in question
+ */
 function price(item, priceAge) {
     switch (priceAge) {
         case PriceAge.HISTORICAL: {
@@ -55,12 +73,20 @@ function inventoryItems() {
         .filter((item) => haveItem(item) &&
         [100, autosellPrice(item)].includes(price(item, PriceAge.RECENT)));
 }
-// Efficiency in meat per fuel.
+/**
+ * @param it The item in question
+ * @param priceAge The PriceAge option to apply
+ * @returns Meat per fuel of an item
+ */
 function calculateFuelUnitCost(it, priceAge = PriceAge.RECENT) {
     const units = getAverageAdventures(it);
     return price(it, priceAge) / units;
 }
-function isFuelItem(it) {
+/**
+ * @param it the item in question
+ * @returns Can `it` be used as Asdon fuel?
+ */
+export function isFuelItem(it) {
     return (!isNpcItem(it) &&
         it.fullness + it.inebriety > 0 &&
         getAverageAdventures(it) > 0 &&
@@ -68,6 +94,9 @@ function isFuelItem(it) {
         it.discardable &&
         !fuelSkiplist.includes(it));
 }
+/**
+ * @returns The best fuel options available to us at this time
+ */
 function getBestFuels() {
     // Three stages.
     // 1. Filter to reasonable items using historical cost (within 5x of historical best).
@@ -102,6 +131,7 @@ function getBestFuels() {
 }
 /**
  * Fuel your Asdon Martin with a given quantity of a given item
+ *
  * @param it Item to fuel with.
  * @param quantity Number of items to fuel with.
  * @returns Whether we succeeded at fueling with the given items.
@@ -112,6 +142,7 @@ export function insertFuel(it, quantity = 1) {
 }
 /**
  * Fill your Asdon Martin to the given fuel level in the cheapest way possible
+ *
  * @param targetUnits Fuel level to attempt to reach.
  * @returns Whether we succeeded at filling to the target fuel level.
  */
@@ -139,6 +170,10 @@ export function fillTo(targetUnits) {
     }
     return getFuel() >= targetUnits;
 }
+/**
+ * @param targetUnits The fuel level we aim to achieve
+ * @returns Whether we successfully filled our Asdon's tank
+ */
 function fillWithBestInventoryItem(targetUnits) {
     const options = inventoryItems().sort((a, b) => getAverageAdventures(b) / autosellPrice(b) -
         getAverageAdventures(a) / autosellPrice(a));
@@ -152,6 +187,7 @@ function fillWithBestInventoryItem(targetUnits) {
 }
 /**
  * Fill your Asdon Martin by prioritizing mallmin items in your inventory. Default to the behavior of fillTo.
+ *
  * @param targetUnits Fuel level to attempt to reach.
  * @returns Whether we succeeded at filling to the target fuel level.
  */
@@ -180,6 +216,7 @@ export const Driving = {
 };
 /**
  * Attempt to drive with a particular style for a particular number of turns.
+ *
  * @param style The driving style to use.
  * @param turns The number of turns to attempt to get.
  * @param preferInventory Whether we should preferentially value items currently in our inventory.

package/dist/resources/2017/MummingTrunk.d.ts

@@ -2,6 +2,7 @@ import { Familiar } from "kolmafia";
 import { NumericModifier } from "../../modifierTypes";
 /**
  * Parses the _mummeryMods preference into a Map for easier use.
+ *
  * @returns A map, mapping Familiars to a Tuple consisting of the NumericModifier attached to the familiar, and the value thereof.
  */
 export declare function currentCostumes(): Map<Familiar, [NumericModifier, number]>;

package/dist/resources/2017/MummingTrunk.js

@@ -1,5 +1,11 @@
 import { toFamiliar } from "kolmafia";
 import { get } from "../../property";
+/**
+ * Internal function used to parse mods
+ *
+ * @param input The modstring used in your mummery pref
+ * @returns a NumericModifier matching that string
+ */
 function toModifier(input) {
     const regExp = new RegExp(/Experience \((.*?)\)/);
     const matcher = input.match(regExp);
@@ -7,12 +13,13 @@ function toModifier(input) {
 }
 /**
  * Parses the _mummeryMods preference into a Map for easier use.
+ *
  * @returns A map, mapping Familiars to a Tuple consisting of the NumericModifier attached to the familiar, and the value thereof.
  */
 export function currentCostumes() {
     const entries = get("_mummeryMods").split(",");
     const returnValue = new Map();
-    const regExp = new RegExp(/([^:]+): \[(d+)\*fam\(([^)]+)\)\]/);
+    const regExp = new RegExp(/([^:]+): \[(\d+)\*fam\(([^)]+)\)\]/);
     for (const entry of entries) {
         const matcher = entry.match(regExp);
         if (matcher) {

package/dist/resources/2017/Pantogram.d.ts

@@ -1,5 +1,11 @@
 import { Item } from "kolmafia";
+/**
+ * @returns Do we `have` the Pantogram itself?
+ */
 export declare function have(): boolean;
+/**
+ * @returns Do we `have` pantogram pants?
+ */
 export declare function havePants(): boolean;
 declare type PantogramAlignment = "Muscle" | "Moxie" | "Mysticality";
 declare const Element: {
@@ -60,12 +66,14 @@ declare type Pants = {
 };
 /**
  * Finds the item requirements for a particular pair of pants.
+ *
  * @param modifiers An object consisting of the modifiers you want on your pants. For modifiers repeated across a particular sacrifice, use a tuple of that modifier and its value.
  * @returns A map of the items you need to make these pants and the quantities needed.
  */
 export declare function findRequirements(modifiers: Partial<Pants>): Map<Item, number>;
 /**
  * Makes a pair of pants with the given modifiers
+ *
  * @param alignment The stat you'd like your pants to improve. Moxie, Mysticality, or Muscle
  * @param element The element you'd like your pants to provide resistance for
  * @param leftSac The modifier you'd like to get from your leftmost sacrifice in Pantagramming.
@@ -76,6 +84,7 @@ export declare function findRequirements(modifiers: Partial<Pants>): Map<Item, n
 export declare function makePants(alignment: PantogramAlignment, element: PantogramElement, leftSac: PantogramSacrificeL, middleSac: PantogramSacrificeM, rightSac: PantogramSacrificeR): boolean;
 /**
  * Creates a pair of pants from a Pants object.
+ *
  * @param pants An object consisting of the modifiers you'd like the pants to give you.
  * @returns Whether or not you successfully created a pair of pants. False if you don't own the pantogram or if you already have pantogram pants.
  */

package/dist/resources/2017/Pantogram.js

@@ -3,9 +3,15 @@ import { have as haveItem } from "../../lib";
 import { $item } from "../../template-string";
 const pantogram = $item `portable pantogram`;
 const pants = $item `pantogram pants`;
+/**
+ * @returns Do we `have` the Pantogram itself?
+ */
 export function have() {
     return haveItem(pantogram);
 }
+/**
+ * @returns Do we `have` pantogram pants?
+ */
 export function havePants() {
     return haveItem(pants);
 }
@@ -32,6 +38,12 @@ const LeftSacrifice = {
     ["MP Regen Max: 20"]: [$item `glowing New Age crystal`, 1],
     ["Mana Cost: -3"]: [$item `baconstone`, 1],
 };
+/**
+ * Internal function used for `makePants`
+ *
+ * @param mod Modifier to get from our Left sacrifice
+ * @returns Item-tuple to use in our URL string
+ */
 function getLeftSacPair(mod) {
     return LeftSacrifice[mod];
 }
@@ -48,6 +60,12 @@ const MiddleSacrifice = {
     ["Avatar: Purple"]: [$item `moxie weed`, 99],
     ["Drops Items: true"]: [$item `ten-leaf clover`, 1],
 };
+/**
+ * Internal function used for `makePants`
+ *
+ * @param mod Modifier to get from our Middle sacrifice
+ * @returns Item-tuple to use in our URL string
+ */
 function getMiddleSacPair(mod) {
     return MiddleSacrifice[mod];
 }
@@ -65,11 +83,18 @@ const RightSacrifice = {
     ["Mysticality Experience Percent: 25"]: [$item `haunted battery`, 5],
     ["Moxie Experience Percent: 25"]: [$item `the funk`, 5],
 };
+/**
+ * Internal function used for `makePants`
+ *
+ * @param mod Modifier to get from our Right sacrifice
+ * @returns Item-tuple to use in our URL string
+ */
 function getRightSacPair(mod) {
     return RightSacrifice[mod];
 }
 /**
  * Finds the item requirements for a particular pair of pants.
+ *
  * @param modifiers An object consisting of the modifiers you want on your pants. For modifiers repeated across a particular sacrifice, use a tuple of that modifier and its value.
  * @returns A map of the items you need to make these pants and the quantities needed.
  */
@@ -96,6 +121,12 @@ export function findRequirements(modifiers) {
     }
     return returnValue;
 }
+/**
+ * Internal function used in `makePants`
+ *
+ * @param pair Tuple consisting of an item or number and another number
+ * @returns URL parameter associated with the tuple
+ */
 function sacrificePairToURL(pair) {
     const [rawSacrifice, quantity] = pair;
     const sacrifice = rawSacrifice instanceof Item ? toInt(rawSacrifice) : rawSacrifice;
@@ -103,6 +134,7 @@ function sacrificePairToURL(pair) {
 }
 /**
  * Makes a pair of pants with the given modifiers
+ *
  * @param alignment The stat you'd like your pants to improve. Moxie, Mysticality, or Muscle
  * @param element The element you'd like your pants to provide resistance for
  * @param leftSac The modifier you'd like to get from your leftmost sacrifice in Pantagramming.
@@ -133,6 +165,7 @@ export function makePants(alignment, element, leftSac, middleSac, rightSac) {
 }
 /**
  * Creates a pair of pants from a Pants object.
+ *
  * @param pants An object consisting of the modifiers you'd like the pants to give you.
  * @returns Whether or not you successfully created a pair of pants. False if you don't own the pantogram or if you already have pantogram pants.
  */

package/dist/resources/2017/Robortender.d.ts

@@ -15,6 +15,7 @@ export declare function have(): boolean;
 export declare function dropFrom(target: Monster | Phylum): Item;
 /**
  * Determines the probability of getting a robortender drop based on number of drops received
+ *
  * @param dropNumber The number of drops to assume you've already received; defaults to mafia's tracked amount
  * @returns The probability of getting a robort drop
  */

package/dist/resources/2017/Robortender.js

@@ -44,6 +44,7 @@ export function dropFrom(target) {
 }
 /**
  * Determines the probability of getting a robortender drop based on number of drops received
+ *
  * @param dropNumber The number of drops to assume you've already received; defaults to mafia's tracked amount
  * @returns The probability of getting a robort drop
  */

package/dist/resources/2017/Spacegate.js

@@ -1,3 +1,4 @@
+/* eslint "jsdoc/require-jsdoc": "warn" */
 import { cliExecute, toInt, visitUrl } from "kolmafia";
 import { get } from "../../property";
 import { $item } from "../../template-string";

package/dist/resources/2017/TunnelOfLove.d.ts

@@ -1,10 +1,28 @@
 import { Monster } from "kolmafia";
 import { Copier } from "../../Copier";
+/**
+ * @returns Is the love tunnel available?
+ */
 export declare function have(): boolean;
+/**
+ * @returns Have we visited the love tunnel yet today?
+ */
 export declare function isUsed(): boolean;
+/**
+ * @returns Do we `have` an Enamorang?
+ */
 export declare function haveLovEnamorang(): boolean;
+/**
+ * @returns How many enamorangs have we used today?
+ */
 export declare function getLovEnamorangUses(): number;
+/**
+ * @returns Can we currently use an enamorang?
+ */
 export declare function couldUseLoveEnamorang(): boolean;
+/**
+ * @returns The Monster currently in our enamorang; `null` for none
+ */
 export declare function getLovEnamorangMonster(): Monster | null;
 export declare const LovEnamorang: Copier;
 declare type LOVEquipment = "LOV Eardigan" | "LOV Epaulettes" | "LOV Earring";
@@ -12,6 +30,7 @@ declare type LOVEffect = "Lovebotamy" | "Open Heart Surgery" | "Wandering Eye Su
 declare type LOVExtra = "LOV Enamorang" | "LOV Emotionizer" | "LOV Extraterrestrial Chocolate" | "LOV Echinacea Bouquet" | "LOV Elephant" | "toast" | null;
 /**
  * Fight all LOV monsters and get buffs/equipment.
+ *
  * @param equipment Equipment to take from LOV.
  * @param effect Effect to take from LOV.
  * @param extra Extra item to take from LOV.

package/dist/resources/2017/TunnelOfLove.js

@@ -3,27 +3,51 @@ import { Copier } from "../../Copier";
 import { have as haveItem, haveWandererCounter, Wanderer } from "../../lib";
 import { get, set } from "../../property";
 import { $item, $location } from "../../template-string";
+/**
+ * @returns Is the love tunnel available?
+ */
 export function have() {
     return get("loveTunnelAvailable");
 }
+/**
+ * @returns Have we visited the love tunnel yet today?
+ */
 export function isUsed() {
     return get("_loveTunnelUsed");
 }
+/**
+ * @returns Do we `have` an Enamorang?
+ */
 export function haveLovEnamorang() {
     return haveItem($item `LOV Enamorang`);
 }
+/**
+ * @returns How many enamorangs have we used today?
+ */
 export function getLovEnamorangUses() {
     return get("_enamorangs");
 }
+/**
+ * @returns Can we currently use an enamorang?
+ */
 export function couldUseLoveEnamorang() {
     return (!haveWandererCounter(Wanderer.Enamorang) &&
         getLovEnamorangUses() < 3 &&
         haveLovEnamorang());
 }
+/**
+ * @returns The Monster currently in our enamorang; `null` for none
+ */
 export function getLovEnamorangMonster() {
     return get("enamorangMonster");
 }
 export const LovEnamorang = new Copier(() => couldUseLoveEnamorang(), null, () => couldUseLoveEnamorang(), () => getLovEnamorangMonster());
+/**
+ * Internal function used for `fightAll`
+ *
+ * @param equipment The equipment to select from the tunnel
+ * @returns The relevant choice option
+ */
 function equipmentChoice(equipment) {
     switch (equipment) {
         case "LOV Eardigan":
@@ -34,6 +58,12 @@ function equipmentChoice(equipment) {
             return 3;
     }
 }
+/**
+ *Internal function used for `fightAll`
+ *
+ * @param effect The effect to select from the tunnel
+ * @returns The relevant choice option
+ */
 function effectChoice(effect) {
     switch (effect) {
         case "Lovebotamy":
@@ -44,6 +74,12 @@ function effectChoice(effect) {
             return 3;
     }
 }
+/**
+ * Internal function used for `fightAll`
+ *
+ * @param extra The extra item to select from the tunnel
+ * @returns The relevant choice option
+ */
 function extraChoice(extra) {
     switch (extra) {
         case "LOV Enamorang":
@@ -64,6 +100,7 @@ function extraChoice(extra) {
 }
 /**
  * Fight all LOV monsters and get buffs/equipment.
+ *
  * @param equipment Equipment to take from LOV.
  * @param effect Effect to take from LOV.
  * @param extra Extra item to take from LOV.

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

@@ -1,4 +1,13 @@
 import { Monster } from "kolmafia";
+/**
+ * @returns Whether we `have` the latte lovers member's mug
+ */
 export declare function have(): boolean;
+/**
+ * @returns The current target of `Offer Latte`, assuming the effect is active; otherwise, `null`
+ */
 export declare function sniffedMonster(): Monster | null;
+/**
+ * @returns The number of latte refills remaining for the day
+ */
 export declare function refillsRemaining(): number;

package/dist/resources/2018/LatteLoversMembersMug.js

@@ -2,12 +2,21 @@ import { getCounter } from "kolmafia";
 import { have as haveItem } from "../../lib";
 import { get } from "../../property";
 import { $item } from "../../template-string";
+/**
+ * @returns Whether we `have` the latte lovers member's mug
+ */
 export function have() {
     return haveItem($item `latte lovers member's mug`);
 }
+/**
+ * @returns The current target of `Offer Latte`, assuming the effect is active; otherwise, `null`
+ */
 export function sniffedMonster() {
     return getCounter("Latte Monster") !== -1 ? get("_latteMonster") : null;
 }
+/**
+ * @returns The number of latte refills remaining for the day
+ */
 export function refillsRemaining() {
     return 3 - get("_latteRefillsUsed");
 }

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;