isaacscript-common 6.6.1-dev.0 → 6.6.1-dev.4

package/dist/functions/playerIndex.js

@@ -0,0 +1,160 @@
+import { CollectibleType, PlayerType } from "isaac-typescript-definitions";
+import { game } from "../cachedClasses";
+const DEFAULT_COLLECTIBLE_TYPE = CollectibleType.SAD_ONION;
+const EXCLUDED_CHARACTERS = new Set([
+    PlayerType.ESAU,
+    PlayerType.THE_SOUL_B, // 40
+]);
+/**
+ * Helper function to get every player with no restrictions, by using `Game.GetNumPlayers` and
+ * `Isaac.GetPlayer`.
+ *
+ * This function is almost never what you want to use. For most purposes, use the `getPlayers`
+ * helper function instead to get a filtered list of players.
+ */
+export function getAllPlayers() {
+    const numPlayers = game.GetNumPlayers();
+    const players = [];
+    for (let i = 0; i < numPlayers; i++) {
+        const player = Isaac.GetPlayer(i);
+        players.push(player);
+    }
+    return players;
+}
+export function getPlayerFromIndex(playerIndex) {
+    const players = getPlayers();
+    return players.find((player) => getPlayerIndex(player) === playerIndex);
+}
+/**
+ * Mods often have to track variables relating to the player. In naive mods, information will only
+ * be stored about the first player. However, in order to be robust, mods must handle up to 4
+ * players playing at the same time. This means that information must be stored on a map data
+ * structure. Finding a good index for these types of map data structures is difficult:
+ *
+ * - We cannot use the index from `Isaac.GetPlayer(i)` since this fails in the case where there are
+ *   two players and the first player leaves the run.
+ * - We cannot use `EntityPlayer.ControllerIndex` as an index because it fails in the case of Jacob
+ *   & Esau or Tainted Forgotten. It also fails in the case of a player changing their controls
+ *   mid-run.
+ * - We cannot use `EntityPlayer.GetData().index` because it does not persist across saving and
+ *   continuing.
+ * - We cannot use `GetPtrHash()` as an index because it does not persist across exiting and
+ *   relaunching the game.
+ * - We cannot use `EntityPlayer.InitSeed` because it is not consistent with additional players
+ *   beyond the first.
+ *
+ * Instead, we use the `EntityPlayer.GetCollectibleRNG` method with an arbitrary value of Sad Onion
+ * (1). This works even if the player does not have any Sad Onions.
+ *
+ * Since the RNG value is the same for both Tainted Lazarus and Dead Tainted Lazarus, we revert to
+ * using the RNG of The Inner Eye (2) for Dead Tainted Lazarus.
+ *
+ * Note that by default, this returns the same index for both The Forgotten and The Soul. (Even
+ * though they are technically different characters, they share the same inventory and InitSeed.) If
+ * this is not desired, pass true for the `differentiateForgottenAndSoul` argument, and the RNG of
+ * Spoon Bender (3) will be used for The Soul.
+ */
+export function getPlayerIndex(player, differentiateForgottenAndSoul = false) {
+    // Sub-players use separate RNG values for some reason, so we need to always use the main player:
+    // https://github.com/Meowlala/RepentanceAPIIssueTracker/issues/443
+    // We can safely ignore the player's character because regardless of whether the main player ends
+    // up being The Forgotten or The Soul, the collectible RNG values will be the same. The
+    // `EntityPlayer.IsSubPlayer` method can return true for Dead Tainted Lazarus during the
+    // PostPlayerInit callback, but since we fall back to the player in the case of
+    // "getSubPlayerParent" returning undefined, we do not need to explicitly check for this case.
+    let playerToUse = player;
+    const isSubPlayer = player.IsSubPlayer();
+    if (isSubPlayer) {
+        // The "getSubPlayerParent" function will return undefined in the situation where we are on Dead
+        // Tainted Lazarus in the PostPlayerInit callback.
+        const playerParent = getSubPlayerParent(player);
+        if (playerParent !== undefined) {
+            playerToUse = playerParent;
+        }
+    }
+    const collectibleType = getPlayerIndexCollectibleType(player, differentiateForgottenAndSoul);
+    const collectibleRNG = playerToUse.GetCollectibleRNG(collectibleType);
+    const seed = collectibleRNG.GetSeed();
+    return seed;
+}
+function getPlayerIndexCollectibleType(player, differentiateForgottenAndSoul) {
+    const character = player.GetPlayerType();
+    switch (character) {
+        // 17
+        case PlayerType.THE_SOUL: {
+            return differentiateForgottenAndSoul
+                ? CollectibleType.SPOON_BENDER
+                : DEFAULT_COLLECTIBLE_TYPE;
+        }
+        // 38
+        case PlayerType.LAZARUS_2_B: {
+            return CollectibleType.INNER_EYE;
+        }
+        default: {
+            return DEFAULT_COLLECTIBLE_TYPE;
+        }
+    }
+}
+/**
+ * Helper function to return the index of this player with respect to the output of the
+ * `Isaac.GetPlayer` method.
+ *
+ * Note that if you storing information about a player in a data structure, you never want to use
+ * this index; use the `getPlayerIndex` function instead.
+ */
+export function getPlayerIndexVanilla(playerToFind) {
+    const numPlayers = game.GetNumPlayers();
+    const playerToFindHash = GetPtrHash(playerToFind);
+    for (let i = 0; i < numPlayers; i++) {
+        const player = Isaac.GetPlayer(i);
+        const playerHash = GetPtrHash(player);
+        if (playerHash === playerToFindHash) {
+            return i;
+        }
+    }
+    return undefined;
+}
+/**
+ * This function always excludes players with a non-undefined parent, since they are not real
+ * players (e.g. the Strawman Keeper).
+ *
+ * If this is not desired, use the `getAllPlayers` helper function instead.
+ *
+ * @param performCharacterExclusions Whether or not to exclude characters that are not directly
+ *                                 controlled by the player (i.e. Esau & Tainted Soul). Default is
+ *                                 false.
+ */
+export function getPlayers(performCharacterExclusions = false) {
+    const players = getAllPlayers();
+    const nonChildPlayers = players.filter((player) => !isChildPlayer(player));
+    const nonChildPlayersFiltered = nonChildPlayers.filter((player) => {
+        const character = player.GetPlayerType();
+        return !EXCLUDED_CHARACTERS.has(character);
+    });
+    return performCharacterExclusions ? nonChildPlayersFiltered : nonChildPlayers;
+}
+/**
+ * Helper function to get a parent `EntityPlayer` object for a given `EntitySubPlayer` object. This
+ * is useful because calling the `EntityPlayer.GetSubPlayer` method on a sub-player object will
+ * return undefined.
+ */
+export function getSubPlayerParent(subPlayer) {
+    const subPlayerPtrHash = GetPtrHash(subPlayer);
+    const players = getPlayers();
+    return players.find((player) => {
+        const thisPlayerSubPlayer = player.GetSubPlayer();
+        if (thisPlayerSubPlayer === undefined) {
+            return false;
+        }
+        const thisPlayerSubPlayerPtrHash = GetPtrHash(thisPlayerSubPlayer);
+        return thisPlayerSubPlayerPtrHash === subPlayerPtrHash;
+    });
+}
+/**
+ * Some players are "child" players, meaning that they have a non-undefined Parent property. (For
+ * example, the Strawman Keeper.)
+ */
+export function isChildPlayer(player) {
+    return player.Parent !== undefined;
+}
+//# sourceMappingURL=playerIndex.js.map

package/dist/functions/playerIndex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"playerIndex.js","sourceRoot":"../src/","sources":["functions/playerIndex.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC3E,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAGxC,MAAM,wBAAwB,GAAG,eAAe,CAAC,SAAS,CAAC;AAE3D,MAAM,mBAAmB,GAA4B,IAAI,GAAG,CAAC;IAC3D,UAAU,CAAC,IAAI;IACf,UAAU,CAAC,UAAU,EAAE,KAAK;CAC7B,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,UAAU,aAAa;IAC3B,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;IAExC,MAAM,OAAO,GAAmB,EAAE,CAAC;IACnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,EAAE,CAAC,EAAE,EAAE;QACnC,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAClC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KACtB;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,kBAAkB,CAChC,WAAwB;IAExB,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAC7B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,WAAW,CAAC,CAAC;AAC1E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,UAAU,cAAc,CAC5B,MAAoB,EACpB,6BAA6B,GAAG,KAAK;IAErC,iGAAiG;IACjG,mEAAmE;IAEnE,iGAAiG;IACjG,uFAAuF;IACvF,wFAAwF;IACxF,+EAA+E;IAC/E,8FAA8F;IAC9F,IAAI,WAAW,GAAG,MAAM,CAAC;IACzB,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;IACzC,IAAI,WAAW,EAAE;QACf,gGAAgG;QAChG,kDAAkD;QAClD,MAAM,YAAY,GAAG,kBAAkB,CAAC,MAAyB,CAAC,CAAC;QACnE,IAAI,YAAY,KAAK,SAAS,EAAE;YAC9B,WAAW,GAAG,YAAY,CAAC;SAC5B;KACF;IAED,MAAM,eAAe,GAAG,6BAA6B,CACnD,MAAM,EACN,6BAA6B,CAC9B,CAAC;IACF,MAAM,cAAc,GAAG,WAAW,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;IACtE,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC;IAEtC,OAAO,IAA8B,CAAC;AACxC,CAAC;AAED,SAAS,6BAA6B,CACpC,MAAoB,EACpB,6BAAsC;IAEtC,MAAM,SAAS,GAAG,MAAM,CAAC,aAAa,EAAE,CAAC;IAEzC,QAAQ,SAAS,EAAE;QACjB,KAAK;QACL,KAAK,UAAU,CAAC,QAAQ,CAAC,CAAC;YACxB,OAAO,6BAA6B;gBAClC,CAAC,CAAC,eAAe,CAAC,YAAY;gBAC9B,CAAC,CAAC,wBAAwB,CAAC;SAC9B;QAED,KAAK;QACL,KAAK,UAAU,CAAC,WAAW,CAAC,CAAC;YAC3B,OAAO,eAAe,CAAC,SAAS,CAAC;SAClC;QAED,OAAO,CAAC,CAAC;YACP,OAAO,wBAAwB,CAAC;SACjC;KACF;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,qBAAqB,CACnC,YAA0B;IAE1B,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;IACxC,MAAM,gBAAgB,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC;IAElD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,EAAE,CAAC,EAAE,EAAE;QACnC,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAClC,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,UAAU,KAAK,gBAAgB,EAAE;YACnC,OAAO,CAAC,CAAC;SACV;KACF;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,UAAU,CAAC,0BAA0B,GAAG,KAAK;IAC3D,MAAM,OAAO,GAAG,aAAa,EAAE,CAAC;IAChC,MAAM,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;IAC3E,MAAM,uBAAuB,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE;QAChE,MAAM,SAAS,GAAG,MAAM,CAAC,aAAa,EAAE,CAAC;QACzC,OAAO,CAAC,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,OAAO,0BAA0B,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC,eAAe,CAAC;AAChF,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAChC,SAA0B;IAE1B,MAAM,gBAAgB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;IAC/C,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAE7B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;QAC7B,MAAM,mBAAmB,GAAG,MAAM,CAAC,YAAY,EAAE,CAAC;QAClD,IAAI,mBAAmB,KAAK,SAAS,EAAE;YACrC,OAAO,KAAK,CAAC;SACd;QAED,MAAM,0BAA0B,GAAG,UAAU,CAAC,mBAAmB,CAAC,CAAC;QACnE,OAAO,0BAA0B,KAAK,gBAAgB,CAAC;IACzD,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,MAAoB;IAChD,OAAO,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC;AACrC,CAAC"}

package/dist/functions/playerIndex.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/playerIndex.ts"],"names":[],"mappings":";;;;;;MAmGS,+BA/FH,0BAEA;AANN,6CAA4C;AAAnC;AAAiB;AAC1B,0BAAqB;AAAZ;;;;;;AAiBT;AACQ,uBAAa,KAAK;AAElB,oBAA0B;;AACvB,kBAAI;cAAG,IAAI;AACZ,2BAAS,gBAAgB;AAC/B,oCAAa;AAFiB;;;AAKhC,WAAO;AATT;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgDA,0CACE,QACA;OAAA;QAAA,gCAAgC;;AAU5B,wBAAc;AACZ,wBAAc,OAAO;OACvB;AAGI,6BAAe,oCAAmB;WACpC;AACF,0BAAc;;;AAIZ,4BAAkB,mCACtB,QACA;AAEI,2BAAiB,YAAY,kBAAkB;AAC/C,iBAAO,eAAe;AAE5B,WAAO;AA9BT;AAiCA,SAAS,oCACP,QACA;AAEM,sBAAY,OAAO;;6BAEjB;2CAED;;;AACH,uBAAO,kCACH,gCACA;;;mDAID;;;AACH,uBAAO;;;;;AAIP,uBAAO;;;;;;;;;;;;;AAuCb,sCAA2B;OAAA;QAAA,6BAA6B;;AAChD,oBAAU;AACV,4BAAkB;QAAA;QAAe,eAAC,QAAW,WAAC,+BAAc,OAA3B;;AACjC,oCAA0B;QAAA;QAAuB,eAAC;AAChD,8BAAY,OAAO;AACzB,uBAAQ,oBAAoB,IAAI;QAFqB;;AAKvD,WAAO,+BAA6B,2BAA0B;AARhE;;;;AAgBA,8CACE;AAEM,6BAAmB,WAAW;AAC9B,oBAAU;AAEhB,WAAO;QAAA;QAAa,eAAC;AACb,wCAAsB,OAAO;eAC/B;AACF,uBAAO;;AAGH,+CAA6B,WAAW;AAC9C,mBAAO,8BAA+B;QAPpB;;AANtB;;;AAqBA,yCAA8B;AAC5B,WAAO;AADT;AA/LM,2BAA2B;AAE3B,sBAA+C,UAAI,KAAI,CAC3D,iBACA;AAsBF,8CACE;AAEM,oBAAU;AAChB,WAAO;QAAA;QAAa,eAAC,QAAW,uCAAe,WAAY,WAAvC;;AAJtB;;;;;;AAqGA,iDACE;AAEM,uBAAa,KAAK;AAClB,6BAAmB,WAAW;;AAE3B,kBAAI;cAAG,IAAI;AACZ,2BAAS,gBAAgB;AACzB,+BAAa,WAAW;eAC1B,cAAe;AACjB,uBAAO;;AAJqB;;;AAQhC;AAdF","file":"playerIndex.lua","sourceRoot":"../src/"}

package/dist/functions/pocketItems.js

@@ -0,0 +1,124 @@
+import { ActiveSlot, Card, CollectibleType, PillColor, PlayerType, PocketItemSlot, } from "isaac-typescript-definitions";
+import { PocketItemType } from "../enums/PocketItemType";
+import { getEnumValues } from "./enums";
+import { isCharacter } from "./player";
+/**
+ * Helper function to get the `PocketItemSlot` that the player's pocket active collectible item is
+ * in, if any. Returns undefined if the player does not have a pocket active item.
+ */
+export function getActivePocketItemSlot(player) {
+    const pocketItems = getPocketItems(player);
+    for (const pocketItem of pocketItems) {
+        if (pocketItem.type === PocketItemType.ACTIVE_ITEM) {
+            return pocketItem.slot;
+        }
+    }
+    return undefined;
+}
+export function getFirstCardOrPill(player) {
+    const pocketItems = getPocketItems(player);
+    return pocketItems.find((pocketItem) => pocketItem.type === PocketItemType.CARD ||
+        pocketItem.type === PocketItemType.PILL);
+}
+/**
+ * Use this helper function as a workaround for the `EntityPlayer.GetPocketItem` method not working
+ * correctly.
+ *
+ * Note that due to API limitations, there is no way to determine the location of a Dice Bag trinket
+ * dice. Furthermore, when the player has a Dice Bag trinket dice and a pocket active at the same
+ * time, there is no way to determine the location of the pocket active item. If this function
+ * cannot determine the identity of a particular slot, it will mark the type of the slot as
+ * `PocketItemType.UNDETERMINABLE`.
+ */
+export function getPocketItems(player) {
+    const pocketItem = player.GetActiveItem(ActiveSlot.POCKET);
+    const hasPocketItem = pocketItem !== CollectibleType.NULL;
+    const pocketItem2 = player.GetActiveItem(ActiveSlot.POCKET_SINGLE_USE);
+    const hasPocketItem2 = pocketItem2 !== CollectibleType.NULL;
+    const maxPocketItems = player.GetMaxPocketItems();
+    const pocketItemSlots = getEnumValues(PocketItemSlot);
+    const pocketItems = [];
+    let pocketItemIdentified = false;
+    let pocketItem2Identified = false;
+    for (const slot of pocketItemSlots) {
+        const card = player.GetCard(slot);
+        const pillColor = player.GetPill(slot);
+        if (card !== Card.NULL) {
+            pocketItems.push({
+                slot,
+                type: PocketItemType.CARD,
+                subType: card,
+            });
+        }
+        else if (pillColor !== PillColor.NULL) {
+            pocketItems.push({
+                slot,
+                type: PocketItemType.PILL,
+                subType: pillColor,
+            });
+        }
+        else if (hasPocketItem && !hasPocketItem2 && !pocketItemIdentified) {
+            pocketItemIdentified = true;
+            pocketItems.push({
+                slot,
+                type: PocketItemType.ACTIVE_ITEM,
+                subType: pocketItem,
+            });
+        }
+        else if (!hasPocketItem && hasPocketItem2 && !pocketItem2Identified) {
+            pocketItem2Identified = true;
+            pocketItems.push({
+                slot,
+                type: PocketItemType.DICE_BAG_DICE,
+                subType: pocketItem2,
+            });
+        }
+        else if (hasPocketItem && hasPocketItem2) {
+            pocketItems.push({
+                slot,
+                type: PocketItemType.UNDETERMINABLE,
+                subType: 0,
+            });
+        }
+        else {
+            pocketItems.push({
+                slot,
+                type: PocketItemType.EMPTY,
+                subType: 0,
+            });
+        }
+        // eslint-disable-next-line isaacscript/strict-enums
+        if (slot + 1 === maxPocketItems) {
+            break;
+        }
+    }
+    return pocketItems;
+}
+/**
+ * Returns whether or not the player can hold an additional pocket item, beyond what they are
+ * currently carrying. This takes into account items that modify the max number of pocket items,
+ * like Starter Deck.
+ *
+ * If the player is the Tainted Soul, this always returns false, since that character cannot pick up
+ * items. (Only Tainted Forgotten can pick up items.)
+ */
+export function hasOpenPocketItemSlot(player) {
+    if (isCharacter(player, PlayerType.THE_SOUL_B)) {
+        return false;
+    }
+    const pocketItems = getPocketItems(player);
+    return pocketItems.some((pocketItem) => pocketItem.type === PocketItemType.EMPTY);
+}
+/**
+ * Helper function to determine whether or not the player's "active" pocket item slot is set to
+ * their pocket active item.
+ */
+export function isFirstSlotPocketActiveItem(player) {
+    const pocketItems = getPocketItems(player);
+    const firstPocketItem = pocketItems[0];
+    if (firstPocketItem === undefined) {
+        return false;
+    }
+    return firstPocketItem.type === PocketItemType.ACTIVE_ITEM;
+}
+//# sourceMappingURL=pocketItems.js.map

package/dist/functions/pocketItems.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pocketItems.js","sourceRoot":"../src/","sources":["functions/pocketItems.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,IAAI,EACJ,eAAe,EACf,SAAS,EACT,UAAU,EACV,cAAc,GACf,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC;;;GAGG;AACH,MAAM,UAAU,uBAAuB,CACrC,MAAoB;IAEpB,MAAM,WAAW,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IAC3C,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;QACpC,IAAI,UAAU,CAAC,IAAI,KAAK,cAAc,CAAC,WAAW,EAAE;YAClD,OAAO,UAAU,CAAC,IAAI,CAAC;SACxB;KACF;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,kBAAkB,CAChC,MAAoB;IAEpB,MAAM,WAAW,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IAC3C,OAAO,WAAW,CAAC,IAAI,CACrB,CAAC,UAAU,EAAE,EAAE,CACb,UAAU,CAAC,IAAI,KAAK,cAAc,CAAC,IAAI;QACvC,UAAU,CAAC,IAAI,KAAK,cAAc,CAAC,IAAI,CAC1C,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,cAAc,CAAC,MAAoB;IACjD,MAAM,UAAU,GAAG,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAC3D,MAAM,aAAa,GAAG,UAAU,KAAK,eAAe,CAAC,IAAI,CAAC;IAE1D,MAAM,WAAW,GAAG,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;IACvE,MAAM,cAAc,GAAG,WAAW,KAAK,eAAe,CAAC,IAAI,CAAC;IAE5D,MAAM,cAAc,GAAG,MAAM,CAAC,iBAAiB,EAAE,CAAC;IAClD,MAAM,eAAe,GAAG,aAAa,CAAC,cAAc,CAAC,CAAC;IAEtD,MAAM,WAAW,GAA4B,EAAE,CAAC;IAChD,IAAI,oBAAoB,GAAG,KAAK,CAAC;IACjC,IAAI,qBAAqB,GAAG,KAAK,CAAC;IAClC,KAAK,MAAM,IAAI,IAAI,eAAe,EAAE;QAClC,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,IAAsB,CAAC,CAAC;QACpD,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,IAAsB,CAAC,CAAC;QAEzD,IAAI,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE;YACtB,WAAW,CAAC,IAAI,CAAC;gBACf,IAAI;gBACJ,IAAI,EAAE,cAAc,CAAC,IAAI;gBACzB,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;SACJ;aAAM,IAAI,SAAS,KAAK,SAAS,CAAC,IAAI,EAAE;YACvC,WAAW,CAAC,IAAI,CAAC;gBACf,IAAI;gBACJ,IAAI,EAAE,cAAc,CAAC,IAAI;gBACzB,OAAO,EAAE,SAAS;aACnB,CAAC,CAAC;SACJ;aAAM,IAAI,aAAa,IAAI,CAAC,cAAc,IAAI,CAAC,oBAAoB,EAAE;YACpE,oBAAoB,GAAG,IAAI,CAAC;YAC5B,WAAW,CAAC,IAAI,CAAC;gBACf,IAAI;gBACJ,IAAI,EAAE,cAAc,CAAC,WAAW;gBAChC,OAAO,EAAE,UAAU;aACpB,CAAC,CAAC;SACJ;aAAM,IAAI,CAAC,aAAa,IAAI,cAAc,IAAI,CAAC,qBAAqB,EAAE;YACrE,qBAAqB,GAAG,IAAI,CAAC;YAC7B,WAAW,CAAC,IAAI,CAAC;gBACf,IAAI;gBACJ,IAAI,EAAE,cAAc,CAAC,aAAa;gBAClC,OAAO,EAAE,WAAW;aACrB,CAAC,CAAC;SACJ;aAAM,IAAI,aAAa,IAAI,cAAc,EAAE;YAC1C,WAAW,CAAC,IAAI,CAAC;gBACf,IAAI;gBACJ,IAAI,EAAE,cAAc,CAAC,cAAc;gBACnC,OAAO,EAAE,CAAC;aACX,CAAC,CAAC;SACJ;aAAM;YACL,WAAW,CAAC,IAAI,CAAC;gBACf,IAAI;gBACJ,IAAI,EAAE,cAAc,CAAC,KAAK;gBAC1B,OAAO,EAAE,CAAC;aACX,CAAC,CAAC;SACJ;QAED,oDAAoD;QACpD,IAAI,IAAI,GAAG,CAAC,KAAK,cAAc,EAAE;YAC/B,MAAM;SACP;KACF;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,qBAAqB,CAAC,MAAoB;IACxD,IAAI,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,UAAU,CAAC,EAAE;QAC9C,OAAO,KAAK,CAAC;KACd;IAED,MAAM,WAAW,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IAC3C,OAAO,WAAW,CAAC,IAAI,CACrB,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,cAAc,CAAC,KAAK,CACzD,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,2BAA2B,CAAC,MAAoB;IAC9D,MAAM,WAAW,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IAC3C,MAAM,eAAe,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;IACvC,IAAI,eAAe,KAAK,SAAS,EAAE;QACjC,OAAO,KAAK,CAAC;KACd;IAED,OAAO,eAAe,CAAC,IAAI,KAAK,cAAc,CAAC,WAAW,CAAC;AAC7D,CAAC"}

package/dist/functions/pocketItems.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/pocketItems.ts"],"names":[],"mappings":";;;;AAAA,6CAOO;AANL;AACA;AACA;AACA;AACA;AACA;AAEF,2BAA+B;AAAtB;AAET,kBAA8B;AAArB;AACT,mBAA4B;AAAnB;;;;;;;;;AAwCT,0CAA+B;AACvB,uBAAa,OAAO,cAAc;AAClC,0BAAgB,cAAe;AAE/B,wBAAc,OAAO,cAAc;AACnC,2BAAiB,eAAgB;AAEjC,2BAAiB,OAAO;AACxB,4BAAkB,mBAAc;AAEhC,wBAAuC;AACzC,iCAAuB;AACvB,kCAAwB;AAC5B,cAAW,eAAQ;AACX,qBAAO,OAAO,QAAQ;AACtB,0BAAY,OAAO,QAAQ;WAE7B,QAAS;AACX,4CAAiB,CACf,aACA,OAAM,qBACN,UAAS;eAEF,aAAc;AACvB,4CAAiB,CACf,aACA,OAAM,qBACN,UAAS;eAEF,sBAAkB,uBAAmB;AAC9C,mCAAuB;AACvB,4CAAiB,CACf,aACA,OAAM,4BACN,UAAS;eAEF,IAAC,kBAAiB,uBAAmB;AAC9C,oCAAwB;AACxB,4CAAiB,CACf,aACA,OAAM,8BACN,UAAS;eAEF,kBAAiB;AAC1B,4CAAiB,CACf,aACA,OAAM,+BACN,UAAS;;AAGX,4CAAiB,CACf,aACA,OAAM,sBACN,UAAS;;WAKT,OAAO,KAAM;AACf;;;AAIJ,WAAO;AA/DT;;;AAlCA,mDACE;AAEM,wBAAc,gCAAe;AACnC,cAAW,qBAAc;WACnB,mBAAoB;AACtB,mBAAO;;;AAIX;AAVF;AAaA,8CACE;AAEM,wBAAc,gCAAe;AACnC,WAAO;QAAA;QACL,eAAC,YACC,0BAAoB,uBACpB,mBAAoB,mBAFtB;;AALJ;;;;;;;AA+FA,iDAAsC;OAChC,iBAAY,QAAQ;AACtB,eAAO;;AAGH,wBAAc,gCAAe;AACnC,WAAO;QAAA;QACL,eAAC,YAAe,0BAAoB,oBAApC;;AAPJ;;;AAeA,uDAA4C;AACpC,wBAAc,gCAAe;AAC7B,4BAAkB,YAAY;OAChC;AACF,eAAO;;AAGT,WAAO,wBAAyB;AAPlC","file":"pocketItems.lua","sourceRoot":"../src/"}

package/dist/functions/positionVelocity.js

@@ -0,0 +1,136 @@
+import { EffectVariant, HeavenLightDoorSubType, } from "isaac-typescript-definitions";
+import { game } from "../cachedClasses";
+import { DISTANCE_OF_GRID_TILE } from "../constants";
+import { getEntities } from "./entity";
+import { getEffects } from "./entitySpecific";
+import { getPlayerCloserThan } from "./player";
+import { getPlayers } from "./playerIndex";
+const MAX_FIND_FREE_POSITION_ATTEMPTS = 100;
+export function anyEntityCloserThan(entities, position, distance) {
+    return entities.some((entity) => position.Distance(entity.Position) <= distance);
+}
+/** Iterates over all players and checks if any player is close enough to the specified position. */
+export function anyPlayerCloserThan(position, distance) {
+    const players = getPlayers();
+    return players.some((player) => player.Position.Distance(position) <= distance);
+}
+/**
+ * Helper function to get a room position that is not overlapping with a grid entity, a heaven door,
+ * or a player. The `Room.FindFreePickupSpawnPosition` method will return locations that overlap
+ * with heaven doors and partially overlap with players, if the thing being spawned is bigger than a
+ * tile (like a Blood Donation Machine). Use this function instead if you want to account for those
+ * specific situations.
+ *
+ * @param startingPosition The position to start searching from. If this position is not overlapping
+ *                         with anything, then it will be returned.
+ * @param avoidActiveEntities Optional. Default is false.
+ */
+export function findFreePosition(startingPosition, avoidActiveEntities = false) {
+    const room = game.GetRoom();
+    const heavenDoors = getEffects(EffectVariant.HEAVEN_LIGHT_DOOR, HeavenLightDoorSubType.HEAVEN_DOOR);
+    for (let i = 0; i < MAX_FIND_FREE_POSITION_ATTEMPTS; i++) {
+        const position = room.FindFreePickupSpawnPosition(startingPosition, i, avoidActiveEntities);
+        const closePlayer = getPlayerCloserThan(position, DISTANCE_OF_GRID_TILE);
+        if (closePlayer !== undefined) {
+            continue;
+        }
+        const isCloseHeavenDoor = anyEntityCloserThan(heavenDoors, position, DISTANCE_OF_GRID_TILE);
+        if (isCloseHeavenDoor) {
+            continue;
+        }
+        return position;
+    }
+    // We failed to find a free position in N iterations.
+    return room.FindFreePickupSpawnPosition(startingPosition);
+}
+/**
+ * Helper function to get a map containing the positions of every entity in the current room.
+ *
+ * This is useful for rewinding entity positions at a later time. Also see `setEntityPositions`.
+ *
+ * @param entities Optional. If provided, will only get the positions of the provided entities. Use
+ *                 this with cached entities to avoid invoking the `Isaac.GetRoomEntities` method
+ *                 multiple times.
+ */
+export function getEntityPositions(entities) {
+    if (entities === undefined) {
+        entities = getEntities();
+    }
+    const entityPositions = new Map();
+    for (const entity of entities) {
+        const ptrHash = GetPtrHash(entity);
+        entityPositions.set(ptrHash, entity.Position);
+    }
+    return entityPositions;
+}
+/**
+ * Helper function to get a map containing the velocities of every entity in the current room.
+ *
+ * This is useful for rewinding entity velocities at a later time. Also see `setEntityVelocities`.
+ *
+ * @param entities Optional. If provided, will only get the velocities of the provided entities. Use
+ *                 this with cached entities to avoid invoking the `Isaac.GetRoomEntities` method
+ *                 multiple times.
+ */
+export function getEntityVelocities(entities) {
+    if (entities === undefined) {
+        entities = getEntities();
+    }
+    const entityVelocities = new Map();
+    for (const entity of entities) {
+        const ptrHash = GetPtrHash(entity);
+        entityVelocities.set(ptrHash, entity.Velocity);
+    }
+    return entityVelocities;
+}
+/**
+ * Helper function to set the position of every entity in the room based on a map of positions. If
+ * an entity is found that does not have matching element in the provided map, then that entity will
+ * be skipped.
+ *
+ * This function is useful for rewinding entity positions at a later time. Also see
+ * `getEntityPositions`.
+ *
+ * @param entityPositions The map providing the positions for every entity.
+ * @param entities Optional. If provided, will only set the positions of the provided entities. Use
+ *                 this with cached entities to avoid invoking the `Isaac.GetRoomEntities` method
+ *                 multiple times.
+ */
+export function setEntityPositions(entityPositions, entities) {
+    if (entities === undefined) {
+        entities = getEntities();
+    }
+    for (const entity of entities) {
+        const ptrHash = GetPtrHash(entity);
+        const entityPosition = entityPositions.get(ptrHash);
+        if (entityPosition !== undefined) {
+            entity.Position = entityPosition;
+        }
+    }
+}
+/**
+ * Helper function to set the velocity of every entity in the room based on a map of velocities. If
+ * an entity is found that does not have matching element in the provided map, then that entity will
+ * be skipped.
+ *
+ * This function is useful for rewinding entity velocities at a later time. Also see
+ * `getEntityVelocities`.
+ *
+ * @param entityVelocities The map providing the velocities for every entity.
+ * @param entities Optional. If provided, will only set the velocities of the provided entities. Use
+ *                 this with cached entities to avoid invoking the `Isaac.GetRoomEntities` method
+ *                 multiple times.
+ */
+export function setEntityVelocities(entityVelocities, entities) {
+    if (entities === undefined) {
+        entities = getEntities();
+    }
+    for (const entity of entities) {
+        const ptrHash = GetPtrHash(entity);
+        const entityVelocity = entityVelocities.get(ptrHash);
+        if (entityVelocity !== undefined) {
+            entity.Velocity = entityVelocity;
+        }
+    }
+}
+//# sourceMappingURL=positionVelocity.js.map

package/dist/functions/positionVelocity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"positionVelocity.js","sourceRoot":"../src/","sources":["functions/positionVelocity.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,sBAAsB,GACvB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,MAAM,+BAA+B,GAAG,GAAG,CAAC;AAE5C,MAAM,UAAU,mBAAmB,CACjC,QAAkB,EAClB,QAAgB,EAChB,QAAa;IAEb,OAAO,QAAQ,CAAC,IAAI,CAClB,CAAC,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAC3D,CAAC;AACJ,CAAC;AAED,oGAAoG;AACpG,MAAM,UAAU,mBAAmB,CACjC,QAAgB,EAChB,QAAe;IAEf,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAC7B,OAAO,OAAO,CAAC,IAAI,CACjB,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAC3D,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,gBAAgB,CAC9B,gBAAwB,EACxB,mBAAmB,GAAG,KAAK;IAE3B,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;IAC5B,MAAM,WAAW,GAAG,UAAU,CAC5B,aAAa,CAAC,iBAAiB,EAC/B,sBAAsB,CAAC,WAAW,CACnC,CAAC;IAEF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,+BAA+B,EAAE,CAAC,EAAE,EAAE;QACxD,MAAM,QAAQ,GAAG,IAAI,CAAC,2BAA2B,CAC/C,gBAAgB,EAChB,CAAC,EACD,mBAAmB,CACpB,CAAC;QAEF,MAAM,WAAW,GAAG,mBAAmB,CAAC,QAAQ,EAAE,qBAAqB,CAAC,CAAC;QACzE,IAAI,WAAW,KAAK,SAAS,EAAE;YAC7B,SAAS;SACV;QAED,MAAM,iBAAiB,GAAG,mBAAmB,CAC3C,WAAW,EACX,QAAQ,EACR,qBAAqB,CACtB,CAAC;QACF,IAAI,iBAAiB,EAAE;YACrB,SAAS;SACV;QAED,OAAO,QAAQ,CAAC;KACjB;IAED,qDAAqD;IACrD,OAAO,IAAI,CAAC,2BAA2B,CAAC,gBAAgB,CAAC,CAAC;AAC5D,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,kBAAkB,CAAC,QAAmB;IACpD,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC1B,QAAQ,GAAG,WAAW,EAAE,CAAC;KAC1B;IAED,MAAM,eAAe,GAAG,IAAI,GAAG,EAAmB,CAAC;IACnD,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE;QAC7B,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;QACnC,eAAe,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;KAC/C;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,mBAAmB,CAAC,QAAmB;IACrD,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC1B,QAAQ,GAAG,WAAW,EAAE,CAAC;KAC1B;IAED,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAmB,CAAC;IACpD,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE;QAC7B,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;QACnC,gBAAgB,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;KAChD;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,kBAAkB,CAChC,eAAqC,EACrC,QAAmB;IAEnB,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC1B,QAAQ,GAAG,WAAW,EAAE,CAAC;KAC1B;IAED,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE;QAC7B,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;QACnC,MAAM,cAAc,GAAG,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACpD,IAAI,cAAc,KAAK,SAAS,EAAE;YAChC,MAAM,CAAC,QAAQ,GAAG,cAAc,CAAC;SAClC;KACF;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,mBAAmB,CACjC,gBAAsC,EACtC,QAAmB;IAEnB,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC1B,QAAQ,GAAG,WAAW,EAAE,CAAC;KAC1B;IAED,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE;QAC7B,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;QACnC,MAAM,cAAc,GAAG,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACrD,IAAI,cAAc,KAAK,SAAS,EAAE;YAChC,MAAM,CAAC,QAAQ,GAAG,cAAc,CAAC;SAClC;KACF;AACH,CAAC"}

package/dist/functions/positionVelocity.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/positionVelocity.ts"],"names":[],"mappings":";;;;;AAAA,6CAGO;AAFL;AACA;AAEF,0BAAqB;AAAZ;AACT,sBAAsC;AAA7B;AACT,mBAA4B;AAAnB;AACT,2BAA2B;AAAlB;AACT,mBAAoC;AAA3B;AACT,wBAA2B;AAAlB;AAEH,wCAAkC;AAExC,+CACE,UACA,UACA;AAEA,WAAO;QAAA;QACL,eAAC,QAAW,gBAAS,SAAS,oBAAoB,QAAlD;;AANJ;;AAWA,+CACE,UACA;AAEM,oBAAU;AAChB,WAAO;QAAA;QACL,eAAC,QAAW,uBAAgB,SAAS,aAAa,QAAlD;;AANJ;;;;;;;;;;AAqBA,4CACE,kBACA;OAAA;QAAA,sBAAsB;;AAEhB,iBAAO,KAAK;AACZ,wBAAc,gBAClB,iCACA;;AAGO,kBAAI;cAAG,IAAI;;AACZ,iCAAW,KAAK,4BACpB,kBACA,GACA;AAGI,oCAAc,yBAAoB,UAAU;mBAC9C;AACF;;AAGI,0CAAoB,qCACxB,aACA,UACA;mBAEE;AACF;;AAGF,uBAAO;;;AArB4C;;;AAyBrD,WAAO,KAAK,4BAA4B;AAnC1C;;;;;;;;AA+CA,8CAAmC;OAC7B;AACF,mBAAW;;AAGP,4BAAkB,UAAI;AAC5B,cAAW,iBAAU;AACb,wBAAU,WAAW;QAC3B,gBAAgB,IAAI,SAAS;;AAG/B,WAAO;AAXT;;;;;;;;AAuBA,+CAAoC;OAC9B;AACF,mBAAW;;AAGP,6BAAmB,UAAI;AAC7B,cAAW,iBAAU;AACb,wBAAU,WAAW;QAC3B,iBAAiB,IAAI,SAAS;;AAGhC,WAAO;AAXT;;;;;;;;;;;;AA2BA,8CACE,iBACA;OAEI;AACF,mBAAW;;AAGb,cAAW,iBAAU;AACb,wBAAU,WAAW;AACrB,+BAAiB,gBAAgB,IAAI;WACvC;AACF,8BAAkB;;;AAZxB;;;;;;;;;;;;AA8BA,+CACE,kBACA;OAEI;AACF,mBAAW;;AAGb,cAAW,iBAAU;AACb,wBAAU,WAAW;AACrB,+BAAiB,iBAAiB,IAAI;WACxC;AACF,8BAAkB;;;AAZxB","file":"positionVelocity.lua","sourceRoot":"../src/"}

package/dist/functions/random.js

@@ -0,0 +1,73 @@
+import { getRandomSeed, isRNG, newRNG } from "./rng";
+/**
+ * This returns a random float between 0 and 1. It is inclusive on the low end, but exclusive on the
+ * high end. (This is because the `RNG.RandomFloat` method will never return a value of exactly 1.)
+ *
+ * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+ *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ */
+export function getRandom(seedOrRNG = getRandomSeed()) {
+    const rng = isRNG(seedOrRNG) ? seedOrRNG : newRNG(seedOrRNG);
+    return rng.RandomFloat();
+}
+/**
+ * This returns a random float between min and max.
+ *
+ * For example:
+ *
+ * ```ts
+ * const realNumberBetweenOneAndThree = getRandomFloat(1, 3);
+ * ```
+ *
+ * @param min The lower bound for the random number (inclusive).
+ * @param max The upper bound for the random number (exclusive).
+ * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+ *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ */
+export function getRandomFloat(min, max, seedOrRNG = getRandomSeed()) {
+    if (min > max) {
+        const oldMin = min;
+        const oldMax = max;
+        min = oldMax;
+        max = oldMin;
+    }
+    // From: https://stackoverflow.com/questions/40431966
+    return min + getRandom(seedOrRNG) * (max - min);
+}
+/**
+ * This returns a random integer between min and max. It is inclusive on both ends.
+ *
+ * Note that this function will invoke the `Next` method on the `RNG` object before returning the
+ * random number.
+ *
+ * For example:
+ *
+ * ```ts
+ * const oneTwoOrThree = getRandomInt(1, 3);
+ * ```
+ *
+ * @param min The lower bound for the random number (inclusive).
+ * @param max The upper bound for the random number (inclusive).
+ * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+ *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ * @param exceptions Optional. An array of elements that will be skipped over when getting the
+ *                   random integer. For example, a min of 1, a max of 4, and an exceptions array of
+ *                   `[2]` would cause the function to return either 1, 3, or 4. Default is an empty
+ *                   array.
+ */
+export function getRandomInt(min, max, seedOrRNG = getRandomSeed(), exceptions = []) {
+    const rng = isRNG(seedOrRNG) ? seedOrRNG : newRNG(seedOrRNG);
+    if (min > max) {
+        const oldMin = min;
+        const oldMax = max;
+        min = oldMax;
+        max = oldMin;
+    }
+    const exceptionsSet = new Set(exceptions);
+    let randomInt;
+    do {
+        randomInt = rng.RandomInt(max - min + 1) + min;
+    } while (exceptionsSet.has(randomInt));
+    return randomInt;
+}
+//# sourceMappingURL=random.js.map

package/dist/functions/random.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"random.js","sourceRoot":"../src/","sources":["functions/random.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAErD;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CAAC,YAAwB,aAAa,EAAE;IAC/D,MAAM,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC7D,OAAO,GAAG,CAAC,WAAW,EAAE,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,cAAc,CAC5B,GAAQ,EACR,GAAQ,EACR,YAAwB,aAAa,EAAE;IAEvC,IAAI,GAAG,GAAG,GAAG,EAAE;QACb,MAAM,MAAM,GAAG,GAAG,CAAC;QACnB,MAAM,MAAM,GAAG,GAAG,CAAC;QACnB,GAAG,GAAG,MAAM,CAAC;QACb,GAAG,GAAG,MAAM,CAAC;KACd;IAED,qDAAqD;IACrD,OAAO,GAAG,GAAG,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC;AAClD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,YAAY,CAC1B,GAAQ,EACR,GAAQ,EACR,YAAwB,aAAa,EAAE,EACvC,aAAqC,EAAE;IAEvC,MAAM,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAE7D,IAAI,GAAG,GAAG,GAAG,EAAE;QACb,MAAM,MAAM,GAAG,GAAG,CAAC;QACnB,MAAM,MAAM,GAAG,GAAG,CAAC;QACnB,GAAG,GAAG,MAAM,CAAC;QACb,GAAG,GAAG,MAAM,CAAC;KACd;IAED,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC;IAE1C,IAAI,SAAc,CAAC;IACnB,GAAG;QACD,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;KAChD,QAAQ,aAAa,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;IAEvC,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/dist/functions/random.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/random.ts"],"names":[],"mappings":";;;;AAAA,gBAA6C;AAApC;AAAe;AAAO;;;;;;AAS/B,qCAA0B;OAAA;QAAA,YAAwB;;AAC1C,gBAAM,WAAM,eAAa,aAAY,YAAO;AAClD,WAAO,IAAI;AAFb;;;;;;;;;;;;;AAmBA,0CACE,KACA,KACA;OAAA;QAAA,YAAwB;;OAEpB,MAAM;AACF,uBAAS;AACT,uBAAS;AACf,cAAM;AACN,cAAM;;AAIR,WAAO,MAAM,2BAAU,aAAc,OAAM;AAb7C;;;;;;;;;;;;;;;;;;;;AAqCA,wCACE,KACA,KACA,WACA;OADA;QAAA,YAAwB;;OACxB;QAAA,aAAqC;;AAE/B,gBAAM,WAAM,eAAa,aAAY,YAAO;OAE9C,MAAM;AACF,uBAAS;AACT,uBAAS;AACf,cAAM;AACN,cAAM;;AAGF,0BAAgB,UAAI,KAAI;AAE1B;;;AAEF,wBAAY,IAAI,UAAU,MAAM,MAAM,KAAK;;UACpC,kBAAc,IAAI;AAE3B,WAAO;AAtBT","file":"random.lua","sourceRoot":"../src/"}