kolmafia 4.0.0-beta → 26744.0.0

package/index.d.ts

@@ -1,3 +1,4 @@
+// Generated by KoLmafia r26744
 export function abort(string: string): never;
 export function abort(): never;
 export function absorbedMonsters(): { [monster: string]: boolean };
@@ -55,7 +56,7 @@ export function buysItem(master: Coinmaster, item: Item): boolean;
 export function canAdventure(arg: Location): boolean;
 export function canDrink(): boolean;
 export function canEat(): boolean;
-export function canEquip(itemOrFamiliar: Item): boolean;
+export function canEquip(equipment: Item): boolean;
 export function canEquip(familiar: Familiar): boolean;
 export function canEquip(familiar: Familiar, item: Item): boolean;
 export function canFaxbot(arg: Monster): boolean;
@@ -418,6 +419,7 @@ export function myMeat(): number;
 export function myMp(): number;
 export function myName(): string;
 export function myPath(): Path;
+/** @deprecated */
 export function myPathId(): number;
 export function myPokeFam(arg: number): Familiar;
 export function myPp(): number;
@@ -457,7 +459,9 @@ export function outfitTreats(outfit: string): { [item: string]: number };
 export function overdrink(item: Item): boolean;
 export function overdrink(arg1: Item, arg2: number): boolean;
 export function overdrink(arg1: number, arg2: Item): boolean;
+/** @deprecated */
 export function pathIdToName(value: number): string;
+/** @deprecated */
 export function pathNameToId(value: string): number;
 export function pickPocket(arg: Monster): boolean;
 export function pickPocket(arg: Effect): { [effect: string]: number };
@@ -484,6 +488,7 @@ export function prepareForAdventure(arg: Location): boolean;
 export function print(): void;
 export function print(string: string): void;
 export function print(string: string, color: string): void;
+export function printHtml(string: string, logToSession: boolean): void;
 export function printHtml(string: string): void;
 export function propertyDefaultValue(nameValue: string): string;
 export function propertyExists(nameValue: string): boolean;

package/package.json

@@ -1,23 +1,14 @@
 {
-    "name": "kolmafia",
-    "version": "4.0.0-beta",
-    "description": "Typings and stubs for the KoLmafia JS standard library",
-    "main": "index",
-    "types": "index",
-    "repository": "https://github.com/Loathing-Associates-Scripting-Society/kolmafia-js",
-    "author": "Sam Gaus",
-    "license": "MIT",
-    "private": false,
-    "devDependencies": {
-        "prettier": "^2.3.0",
-        "ts-expect": "^1.3.0",
-        "typescript": "^4.1.2"
-    },
-    "scripts": {
-        "test": "tsc"
-    },
-    "files": [
-        "index.d.ts",
-        "contrib/*.d.ts"
-    ]
-}
+  "name": "kolmafia",
+  "version": "26744.0.0",
+  "description": "Typings for the KoLmafia JS standard library",
+  "main": "index",
+  "types": "index",
+  "repository": "https://github.com/kolmafia/kolmafia",
+  "author": "KoLmafia Team",
+  "license": "MIT",
+  "private": false,
+  "files": [
+    "index.d.ts"
+  ]
+}

package/README.md

@@ -1,14 +0,0 @@
-kolmafia-js
-=======
-
-Install this dependency to your mafia JS script to get TypeScript typings for the mafia standard library!
-
-If you are using a bundler (which you probably are) you will need to mark this as an external module so that the `require("kolmafia")` is kept in tact.
-
-For example, in `webpack` you would add the following to your config
-
-```
-  externals: {
-    kolmafia: 'commonjs kolmafia',
-  }
-```

package/contrib/EatDrink.ash.d.ts

@@ -1,32 +0,0 @@
-/**
- * @file Type definition for EatDrink, made by dj_d.
- *
- * - ASH script name: EatDrink
- * - ASH script version: 3.2
- * - ASH script authors: dj_d
- *
- * Links:
- *  - ASH script forum thread: https://kolmafia.us/threads/eatdrink-ash-optimize-your-daily-diet-and-see-how-your-old-diet-stacks-up.1519/
- */
-
-/**
- * @return Net number of adventures gained
- */
-export function eatdrink(
-  foodMax: number,
-  drinkMax: number,
-  spleenMax: number,
-  overdrink: boolean
-): number;
-
-export function eatdrink(
-  foodMax: number,
-  drinkMax: number,
-  spleenMax: number,
-  overdrink: boolean,
-  advmeat: number,
-  primemeat: number,
-  offmeat: number,
-  pullmeat: number,
-  sim: boolean
-): void;

package/contrib/PriceAdvisor.d.ts

@@ -1,43 +0,0 @@
-/**
- * @file Type definition for PriceAdvisor, made by aqualectrix.
- *
- * - ASH script name: PriceAdvisor
- * - ASH script version: 1.62
- * - ASH script authors: aqualectrix
- *
- * Links:
- *  - ASH script forum thread: https://kolmafia.us/threads/priceadvisor-maximize-your-profits.3110/
- */
-
-import { Item } from "..";
-
-export interface PriceAdvice {
-  /** Action command that can be executed in the gCLI */
-  action: string;
-  /** Expected meat gain from the action. A floating-point number. */
-  price: number;
-}
-
-/**
- * Calculates the most profitable advice for `item`.
- * @param item
- * @param considerMore
- * @return Most profitable advice with respect to `considerMore`
- */
-export function bestAdvice(it: Item, considerMore: boolean): PriceAdvice;
-
-/**
- * Calculates all possible advices which have a positive profit.
- * @param item
- * @param considerMore
- * @return All profitable advices for `item`, sorted from best to worst
- */
-export function priceAdvisor(
-  it: Item,
-  considerMore: boolean
-): {[key: number]: PriceAdvice};
-
-/**
- * Resets the internal price advice cache.
- */
-export function clearAdviceCache(): void;

package/contrib/canadv.ash.d.ts

@@ -1,20 +0,0 @@
-/**
- * @file Type definition for CanAdv, made by dj_d.
- *
- * - ASH script name: CanAdv
- * - ASH script version: r109
- * - ASH script authors: zarqon, Theraze
- *
- * Links:
- *  - ASH script forum thread: https://kolmafia.us/threads/canadv-check-whether-you-can-adventure-at-a-given-location.2027/
- */
-
-import { Location } from "..";
-
-/**
- * Checks if the player can adventure at `location`.
- * @param location
- * @param prep If `true`, will equip items, use potions, etc. to meet
- *    requirements for visiting the location. Default is `false`
- */
-export function canAdv(where: Location, prep?: boolean): boolean;

package/contrib/zlib.ash.d.ts

@@ -1,65 +0,0 @@
-/**
- * @file Type definition for Zlib, made by zarqon.
- *
- * - ASH script name: Zlib
- * - ASH script version: r49
- * - ASH script authors: zarqon
- *
- * Links:
- *  - ASH script forum thread: https://kolmafia.us/threads/zlib-zarqons-useful-function-library.2072/
- *  - Wiki page: https://wiki.kolmafia.us/index.php?title=Zlib
- */
-
-import { Bounty, Class, Coinmaster, Effect, Element, Familiar, Item, Location, Monster, Phylum, Servant, Skill, Stat, Thrall, Vykea } from "..";
-
-export function kmail(to: string, message: string, meat: number): boolean;
-
-export function setvar(
-  varname: string,
-  defaultValue: string,
-  type:
-    | 'string'
-    | 'boolean'
-    | 'bounty'
-    | 'class'
-    | 'coinmaster'
-    | 'effect'
-    | 'element'
-    | 'familiar'
-    | 'float'
-    | 'int'
-    | 'item'
-    | 'location'
-    | 'monster'
-    | 'phylum'
-    | 'servant'
-    | 'skill'
-    | 'stat'
-    | 'thrall'
-    | 'vykea'
-): void;
-
-export function setvar(
-  varname: string,
-  defaultValue:
-    | string
-    | boolean
-    | Bounty
-    | Class
-    | Coinmaster
-    | Effect
-    | Element
-    | Familiar
-    | number
-    | Item
-    | Location
-    | Monster
-    | Phylum
-    | Servant
-    | Skill
-    | Stat
-    | Thrall
-    | Vykea
-): void;
-
-export function getvar(varname: string): string;