isaacscript-common 7.1.0 → 7.2.1

package/src/interfaces/TrinketSituation.ts

@@ -1,6 +1,6 @@
 import { TrinketType } from "isaac-typescript-definitions";
 
-/** Used by the `temporarilyRemoveTrinkets` and related helper functions. */
+/** This is used by the `temporarilyRemoveTrinkets` and related helper functions. */
 export interface TrinketSituation {
   trinketTypeRemoved: TrinketType;
   trinketType1: TrinketType;

package/src/maps/keyboardToString.ts

@@ -0,0 +1,77 @@
+import { Keyboard } from "isaac-typescript-definitions";
+
+/** Maps each keyboard enum member to its corresponding lowercase and uppercase characters. */
+export const KEYBOARD_TO_STRING: ReadonlyMap<
+  Keyboard,
+  readonly [lowercaseCharacter: string, uppercaseCharacter: string]
+> = new Map([
+  [Keyboard.SPACE, [" ", " "]], // 32
+  [Keyboard.APOSTROPHE, ["'", '"']], // 39
+  [Keyboard.COMMA, [",", "<"]], // 44
+  [Keyboard.MINUS, ["-", "_"]], // 45
+  [Keyboard.PERIOD, [".", ">"]], // 46
+  [Keyboard.SLASH, ["/", "?"]], // 47
+
+  [Keyboard.ZERO, ["0", ")"]], // 48
+  [Keyboard.ONE, ["1", "!"]], // 49
+  [Keyboard.TWO, ["2", "@"]], // 50
+  [Keyboard.THREE, ["3", "#"]], // 51
+  [Keyboard.FOUR, ["4", "$"]], // 52
+  [Keyboard.FIVE, ["5", "%"]], // 53
+  [Keyboard.SIX, ["6", "^"]], // 54
+  [Keyboard.SEVEN, ["7", "&"]], // 55
+  [Keyboard.EIGHT, ["8", "*"]], // 56
+  [Keyboard.NINE, ["9", "("]], // 57
+
+  [Keyboard.SEMICOLON, [";", ":"]], // 59
+  [Keyboard.EQUAL, ["=", "+"]], // 61
+
+  [Keyboard.A, ["a", "A"]], // 65
+  [Keyboard.B, ["b", "B"]], // 66
+  [Keyboard.C, ["c", "C"]], // 67
+  [Keyboard.D, ["d", "D"]], // 68
+  [Keyboard.E, ["e", "E"]], // 69
+  [Keyboard.F, ["f", "F"]], // 70
+  [Keyboard.G, ["g", "G"]], // 71
+  [Keyboard.H, ["h", "H"]], // 72
+  [Keyboard.I, ["i", "I"]], // 73
+  [Keyboard.J, ["j", "J"]], // 74
+  [Keyboard.K, ["k", "K"]], // 75
+  [Keyboard.L, ["l", "L"]], // 76
+  [Keyboard.M, ["m", "M"]], // 77
+  [Keyboard.N, ["n", "N"]], // 78
+  [Keyboard.O, ["o", "O"]], // 79
+  [Keyboard.P, ["p", "P"]], // 80
+  [Keyboard.Q, ["q", "Q"]], // 81
+  [Keyboard.R, ["r", "R"]], // 82
+  [Keyboard.S, ["s", "S"]], // 83
+  [Keyboard.T, ["t", "T"]], // 84
+  [Keyboard.U, ["u", "U"]], // 85
+  [Keyboard.V, ["v", "V"]], // 86
+  [Keyboard.W, ["w", "W"]], // 87
+  [Keyboard.X, ["x", "X"]], // 88
+  [Keyboard.Y, ["y", "Y"]], // 89
+  [Keyboard.Z, ["z", "Z"]], // 90
+
+  [Keyboard.KP_0, ["0", "0"]], // 320
+  [Keyboard.KP_1, ["1", "1"]], // 321
+  [Keyboard.KP_2, ["2", "2"]], // 322
+  [Keyboard.KP_3, ["3", "3"]], // 323
+  [Keyboard.KP_4, ["4", "4"]], // 324
+  [Keyboard.KP_5, ["5", "5"]], // 325
+  [Keyboard.KP_6, ["6", "6"]], // 326
+  [Keyboard.KP_7, ["7", "7"]], // 327
+  [Keyboard.KP_8, ["8", "8"]], // 328
+  [Keyboard.KP_9, ["9", "9"]], // 329
+
+  [Keyboard.KP_DECIMAL, [".", "."]], // 330
+  [Keyboard.KP_DIVIDE, ["/", "/"]], // 331
+  [Keyboard.KP_MULTIPLY, ["*", "*"]], // 332
+  [Keyboard.KP_SUBTRACT, ["-", "-"]], // 333
+  [Keyboard.KP_ADD, ["+", "+"]], // 334
+
+  [Keyboard.LEFT_BRACKET, ["[", "{"]], // 91
+  [Keyboard.BACKSLASH, ["\\", "|"]], // 92
+  [Keyboard.RIGHT_BRACKET, ["]", "}"]], // 93
+  [Keyboard.GRAVE_ACCENT, ["`", "~"]], // 96
+]);

package/src/types/AnyEntity.ts

@@ -1,3 +1,8 @@
+/**
+ * A type union that matches `Entity`, `EntityBomb`, `EntityEffect`, and so on.
+ *
+ * This is useful for building generic functions that should accept any kind of entity.
+ */
 export type AnyEntity =
   | Entity
   | EntityBomb

package/src/types/AnyGridEntity.ts

@@ -1,3 +1,8 @@
+/**
+ * A type union that matches `GridEntity`, `GridEntityDoor`, `GridEntityPit`, and so on.
+ *
+ * This is useful for building generic functions that should accept any kind of grid entity.
+ */
 export type AnyGridEntity =
   | GridEntity
   | GridEntityDoor

package/src/types/CollectibleIndex.ts

@@ -1,7 +1,8 @@
 /**
- * `CollectibleIndex` is a specific type of string; see the documentation for the
- * `getCollectibleIndex` function. Mods can signify that data structures handle collectibles by
- * using this type.
+ * `CollectibleIndex` is a specific type of string that represents a unique identifier for a
+ * collectible. Mods can signify that data structures handle collectibles by using this type.
+ *
+ * For more information, see the documentation for the `getCollectibleIndex` function.
  *
  * For example:
  *

package/src/types/Immutable.ts

@@ -1,5 +1,7 @@
 /**
- * Immutable is a type that will make the given array/map/set/object recursively read-only.
+ * Immutable is a utility type that will make the given array/map/set/object recursively read-only.
+ *
+ * You can use this type to easily build safe data structures.
  *
  * From: https://stackoverflow.com/questions/41879327/deepreadonly-object-typescript
  */

package/src/types/PickupIndex.ts

@@ -1,6 +1,8 @@
 /**
- * `PickupIndex` is a specific type of string; see the documentation for the `getPickupIndex`
- * function. Mods can signify that data structures handle collectibles by using this type.
+ * `PickupIndex` is a specific type of number that represents a unique identifier for a pickup. Mods
+ * can signify that data structures handle collectibles by using this type.
+ *
+ * For more information, see the documentation for the `getPickupIndex` function.
  *
  * For example:
  *

package/src/types/PlayerIndex.ts

@@ -1,7 +1,8 @@
 /**
  * `PlayerIndex` is a specific type of number that represents a unique identifier for a player. Mods
- * can signify that data structures handle `EntityPlayer` by using this type. For more information,
- * see the documentation for the `getPlayerIndex` function.
+ * can signify that data structures handle `EntityPlayer` by using this type.
+ *
+ * For more information, see the documentation for the `getPlayerIndex` function.
  *
  * For example:
  *

package/src/types/SerializedIsaacAPIClass.ts

@@ -1,3 +1,9 @@
+/**
+ * This is a type representing an Isaac API class like `Color` or `RNG` that has been written to the
+ * "save#.dat" file. It is used by the save data manager when reading and writing to that file.
+ *
+ * For the list of supported classes, see the `CopyableIsaacAPIClassType` enum.
+ */
 export type SerializedIsaacAPIClass = LuaMap<string, unknown> & {
   readonly __serializedIsaacAPIClassBrand: symbol;
 };

package/src/types/TSTLClass.ts

@@ -1,3 +1,8 @@
+/**
+ * This is a type representing a user-created class from TypeScript code.
+ *
+ * This type is used by the save data manager to when copying, serializing, and deserializing.
+ */
 export type TSTLClass = LuaMap<AnyNotNil, unknown> & {
   readonly __tstlClassBrand: symbol;
 };

package/src/types/TrapdoorDestination.ts

@@ -1,5 +1,8 @@
 import { LevelStage, StageType } from "isaac-typescript-definitions";
 
+/**
+ * This is the type that you need to specify when using the `spawnCustomTrapdoor` helper function.
+ */
 export type TrapdoorDestination =
   | [stage: LevelStage, stageType: StageType]
   | [customStageName: string, floorNum: int];

package/dist/enums/private/SaveDataKey.d.ts

@@ -1,7 +0,0 @@
-export declare enum SaveDataKey {
-    PERSISTENT = "persistent",
-    RUN = "run",
-    LEVEL = "level",
-    ROOM = "room"
-}
-//# sourceMappingURL=SaveDataKey.d.ts.map

package/dist/enums/private/SaveDataKey.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SaveDataKey.d.ts","sourceRoot":"","sources":["../../../src/enums/private/SaveDataKey.ts"],"names":[],"mappings":"AAAA,oBAAY,WAAW;IACrB,UAAU,eAAe;IACzB,GAAG,QAAQ;IACX,KAAK,UAAU;IACf,IAAI,SAAS;CACd"}

package/dist/functions/collectibleCacheFlag.d.ts

@@ -1,24 +0,0 @@
-import { CacheFlag, CollectibleType } from "isaac-typescript-definitions";
-export declare function collectibleHasCacheFlag(collectibleType: CollectibleType, cacheFlag: CacheFlag): boolean;
-/**
- * Returns a set containing every collectible type with the given cache flag, including modded
- * collectibles.
- */
-export declare function getCollectiblesForCacheFlag(cacheFlag: CacheFlag): Set<CollectibleType>;
-/**
- * Returns an array containing every collectible type that the player has that matches the provided
- * CacheFlag.
- *
- * For example, if the cache flag is `CacheFlag.FLYING`, and the player has one Lord of the Pit and
- * two Dead Doves, then this function would return:
- *
- * ```ts
- * [
- *   CollectibleType.LORD_OF_THE_PIT,
- *   CollectibleType.DEAD_DOVE,
- *   CollectibleType.DEAD_DOVE,
- * ]
- * ```
- */
-export declare function getPlayerCollectiblesForCacheFlag(player: EntityPlayer, cacheFlag: CacheFlag): CollectibleType[];
-//# sourceMappingURL=collectibleCacheFlag.d.ts.map

package/dist/functions/collectibleCacheFlag.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"collectibleCacheFlag.d.ts","sourceRoot":"","sources":["../../src/functions/collectibleCacheFlag.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AA2B1E,wBAAgB,uBAAuB,CACrC,eAAe,EAAE,eAAe,EAChC,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,eAAe,CAAC,CAYtB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,iCAAiC,CAC/C,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,SAAS,GACnB,eAAe,EAAE,CAYnB"}

package/dist/functions/collectibleCacheFlag.lua

@@ -1,80 +0,0 @@
-local ____lualib = require("lualib_bundle")
-local Map = ____lualib.Map
-local __TS__New = ____lualib.__TS__New
-local Set = ____lualib.Set
-local ____exports = {}
-local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
-local CacheFlag = ____isaac_2Dtypescript_2Ddefinitions.CacheFlag
-local ____cachedClasses = require("core.cachedClasses")
-local itemConfig = ____cachedClasses.itemConfig
-local ____collectibleSet = require("functions.collectibleSet")
-local getCollectibleArray = ____collectibleSet.getCollectibleArray
-local ____enums = require("functions.enums")
-local getEnumValues = ____enums.getEnumValues
-local ____flag = require("functions.flag")
-local hasFlag = ____flag.hasFlag
-local ____set = require("functions.set")
-local copySet = ____set.copySet
-local getSortedSetValues = ____set.getSortedSetValues
-local ____utils = require("functions.utils")
-local ____repeat = ____utils["repeat"]
-function ____exports.collectibleHasCacheFlag(self, collectibleType, cacheFlag)
-    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
-    if itemConfigItem == nil then
-        return false
-    end
-    return hasFlag(nil, itemConfigItem.CacheFlags, cacheFlag)
-end
-local CACHE_FLAG_TO_COLLECTIBLES_MAP = __TS__New(Map)
-local function initCacheFlagMap(self)
-    for ____, cacheFlag in ipairs(getEnumValues(nil, CacheFlag)) do
-        local collectiblesSet = __TS__New(Set)
-        for ____, collectibleType in ipairs(getCollectibleArray(nil)) do
-            if ____exports.collectibleHasCacheFlag(nil, collectibleType, cacheFlag) then
-                collectiblesSet:add(collectibleType)
-            end
-        end
-        CACHE_FLAG_TO_COLLECTIBLES_MAP:set(cacheFlag, collectiblesSet)
-    end
-end
---- Returns a set containing every collectible type with the given cache flag, including modded
--- collectibles.
-function ____exports.getCollectiblesForCacheFlag(self, cacheFlag)
-    if CACHE_FLAG_TO_COLLECTIBLES_MAP.size == 0 then
-        initCacheFlagMap(nil)
-    end
-    local collectiblesSet = CACHE_FLAG_TO_COLLECTIBLES_MAP:get(cacheFlag)
-    if collectiblesSet == nil then
-        return __TS__New(Set)
-    end
-    return copySet(nil, collectiblesSet)
-end
---- Returns an array containing every collectible type that the player has that matches the provided
--- CacheFlag.
--- 
--- For example, if the cache flag is `CacheFlag.FLYING`, and the player has one Lord of the Pit and
--- two Dead Doves, then this function would return:
--- 
--- ```ts
--- [
---   CollectibleType.LORD_OF_THE_PIT,
---   CollectibleType.DEAD_DOVE,
---   CollectibleType.DEAD_DOVE,
--- ]
--- ```
-function ____exports.getPlayerCollectiblesForCacheFlag(self, player, cacheFlag)
-    local collectiblesForCacheFlag = ____exports.getCollectiblesForCacheFlag(nil, cacheFlag)
-    local playerCollectibles = {}
-    for ____, collectibleType in ipairs(getSortedSetValues(nil, collectiblesForCacheFlag)) do
-        local numCollectibles = player:GetCollectibleNum(collectibleType)
-        ____repeat(
-            nil,
-            numCollectibles,
-            function()
-                playerCollectibles[#playerCollectibles + 1] = collectibleType
-            end
-        )
-    end
-    return playerCollectibles
-end
-return ____exports

package/src/enums/private/SaveDataKey.ts

@@ -1,6 +0,0 @@
-export enum SaveDataKey {
-  PERSISTENT = "persistent",
-  RUN = "run",
-  LEVEL = "level",
-  ROOM = "room",
-}

package/src/functions/collectibleCacheFlag.ts

@@ -1,90 +0,0 @@
-import { CacheFlag, CollectibleType } from "isaac-typescript-definitions";
-import { itemConfig } from "../core/cachedClasses";
-import { getCollectibleArray } from "./collectibleSet";
-import { getEnumValues } from "./enums";
-import { hasFlag } from "./flag";
-import { copySet, getSortedSetValues } from "./set";
-import { repeat } from "./utils";
-
-const CACHE_FLAG_TO_COLLECTIBLES_MAP = new Map<
-  CacheFlag,
-  Set<CollectibleType>
->();
-
-function initCacheFlagMap() {
-  for (const cacheFlag of getEnumValues(CacheFlag)) {
-    const collectiblesSet = new Set<CollectibleType>();
-
-    for (const collectibleType of getCollectibleArray()) {
-      if (collectibleHasCacheFlag(collectibleType, cacheFlag)) {
-        collectiblesSet.add(collectibleType);
-      }
-    }
-
-    CACHE_FLAG_TO_COLLECTIBLES_MAP.set(cacheFlag, collectiblesSet);
-  }
-}
-
-export function collectibleHasCacheFlag(
-  collectibleType: CollectibleType,
-  cacheFlag: CacheFlag,
-): boolean {
-  const itemConfigItem = itemConfig.GetCollectible(collectibleType);
-  if (itemConfigItem === undefined) {
-    return false;
-  }
-
-  return hasFlag(itemConfigItem.CacheFlags, cacheFlag);
-}
-
-/**
- * Returns a set containing every collectible type with the given cache flag, including modded
- * collectibles.
- */
-export function getCollectiblesForCacheFlag(
-  cacheFlag: CacheFlag,
-): Set<CollectibleType> {
-  // Lazy initialize the map.
-  if (CACHE_FLAG_TO_COLLECTIBLES_MAP.size === 0) {
-    initCacheFlagMap();
-  }
-
-  const collectiblesSet = CACHE_FLAG_TO_COLLECTIBLES_MAP.get(cacheFlag);
-  if (collectiblesSet === undefined) {
-    return new Set();
-  }
-
-  return copySet(collectiblesSet);
-}
-
-/**
- * Returns an array containing every collectible type that the player has that matches the provided
- * CacheFlag.
- *
- * For example, if the cache flag is `CacheFlag.FLYING`, and the player has one Lord of the Pit and
- * two Dead Doves, then this function would return:
- *
- * ```ts
- * [
- *   CollectibleType.LORD_OF_THE_PIT,
- *   CollectibleType.DEAD_DOVE,
- *   CollectibleType.DEAD_DOVE,
- * ]
- * ```
- */
-export function getPlayerCollectiblesForCacheFlag(
-  player: EntityPlayer,
-  cacheFlag: CacheFlag,
-): CollectibleType[] {
-  const collectiblesForCacheFlag = getCollectiblesForCacheFlag(cacheFlag);
-
-  const playerCollectibles: CollectibleType[] = [];
-  for (const collectibleType of getSortedSetValues(collectiblesForCacheFlag)) {
-    const numCollectibles = player.GetCollectibleNum(collectibleType);
-    repeat(numCollectibles, () => {
-      playerCollectibles.push(collectibleType);
-    });
-  }
-
-  return playerCollectibles;
-}