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

package/dist/functions/revive.js

@@ -0,0 +1,140 @@
+import { CollectibleType, EntityType, NullItemID, PlayerType, TrinketType, } from "isaac-typescript-definitions";
+import { game } from "../cachedClasses";
+import { MAX_TAINTED_SAMSON_BERSERK_CHARGE, TAINTED_SAMSON_BERSERK_CHARGE_FROM_TAKING_DAMAGE, } from "../constants";
+import { getCharacterDeathAnimationName } from "./character";
+import { getPlayerMaxHeartContainers, getPlayerNumHitsRemaining, hasLostCurse, isKeeper, } from "./player";
+import { getLastFrameOfAnimation } from "./sprite";
+import { giveTrinketsBack, temporarilyRemoveTrinket } from "./trinketGive";
+/**
+ * Uses the player's current health and other miscellaneous things to determine if incoming damage
+ * will be fatal.
+ */
+export function isDamageToPlayerFatal(player, damageAmount, damageSource, lastDamageGameFrame) {
+    const gameFrameCount = game.GetFrameCount();
+    const character = player.GetPlayerType();
+    const effects = player.GetEffects();
+    const isBerserk = effects.HasCollectibleEffect(CollectibleType.BERSERK);
+    // If we are Tainted Jacob and the damage source is Dark Esau, this will not be fatal damage
+    // (because we will transform into Tainted Jacob's lost form).
+    if (character === PlayerType.JACOB_B &&
+        damageSource.Type === EntityType.DARK_ESAU) {
+        return false;
+    }
+    // If we are berserk, no damage is fatal. (The death is deferred until the end of the berserk
+    // effect.)
+    if (isBerserk) {
+        return false;
+    }
+    // If we are playing Tainted Samson and the incoming hit will cause us to become Berserk, then
+    // this will not be fatal damage.
+    const berserkChargeAfterHit = player.SamsonBerserkCharge +
+        TAINTED_SAMSON_BERSERK_CHARGE_FROM_TAKING_DAMAGE;
+    if (character === PlayerType.SAMSON_B &&
+        berserkChargeAfterHit >= MAX_TAINTED_SAMSON_BERSERK_CHARGE) {
+        return false;
+    }
+    // If Spirit Shackles is activated, no damage is fatal.
+    if (willReviveFromSpiritShackles(player)) {
+        return false;
+    }
+    // If we are Tainted Jacob in the Lost Form, we may have plenty of health left, but we will still
+    // die in one hit to anything.
+    if (character === PlayerType.JACOB_2_B) {
+        return true;
+    }
+    // If we are in the "Lost Curse" form from touching a white fire, all damage will be fatal.
+    if (hasLostCurse(player)) {
+        return true;
+    }
+    const playerNumAllHearts = getPlayerNumHitsRemaining(player);
+    if (damageAmount < playerNumAllHearts) {
+        return false;
+    }
+    // This will not be fatal damage if the player has Heartbreak and two slots open for broken
+    // hearts.
+    if (willReviveFromHeartbreak(player)) {
+        return false;
+    }
+    // This will not be fatal damage if we have Glass Cannon and this is the second time we are taking
+    // damage on the same frame.
+    if (player.HasCollectible(CollectibleType.BROKEN_GLASS_CANNON) &&
+        gameFrameCount === lastDamageGameFrame) {
+        return false;
+    }
+    // This will not be fatal damage if we have two different kinds of hearts. For example, a bomb
+    // explosion deals 2 damage, but if the player has one half soul heart and one half red heart, the
+    // game will only remove the soul heart.
+    const hearts = player.GetHearts();
+    const eternalHearts = player.GetEternalHearts();
+    const soulHearts = player.GetSoulHearts();
+    const boneHearts = player.GetBoneHearts();
+    if ((hearts > 0 && soulHearts > 0) ||
+        (hearts > 0 && boneHearts > 0) ||
+        (soulHearts > 0 && boneHearts > 0) ||
+        (soulHearts > 0 && eternalHearts > 0) ||
+        boneHearts >= 2 // Two bone hearts and nothing else should not result in a death
+    ) {
+        return false;
+    }
+    return true;
+}
+/**
+ * Assuming that we are on the frame of fatal damage, this function returns whether or not
+ * Mysterious Paper would rotate to Missing Poster on the frame that the "Game Over" screen would
+ * appear (which would subsequently save the player from fatal damage).
+ *
+ * Mysterious Paper rotates between the 4 items on every frame, in order. The formula for whether
+ * Mysterious Paper be Missing Power is: `gameFrameCount % 4 === 3`
+ */
+export function willMysteriousPaperRevive(player) {
+    const gameFrameCount = game.GetFrameCount();
+    const sprite = player.GetSprite();
+    // We want to explicitly check the length of the death animation because we might be playing on a
+    // modded character that has a custom death animation.
+    const character = player.GetPlayerType();
+    const animation = getCharacterDeathAnimationName(character);
+    const deathAnimationFrames = getLastFrameOfAnimation(sprite, animation);
+    const frameOfDeath = gameFrameCount + deathAnimationFrames + 1;
+    // (We add 1 because it takes one frame for the death animation to begin.)
+    return frameOfDeath % 4 === 3;
+}
+/**
+ * The `EntityPlayer.WillPlayerRevive` method does not properly account for Mysterious Paper, so use
+ * this helper function instead for more robust revival detection.
+ */
+export function willPlayerRevive(player) {
+    const trinketSituation = temporarilyRemoveTrinket(player, TrinketType.MYSTERIOUS_PAPER);
+    const willRevive = player.WillPlayerRevive() ||
+        (trinketSituation !== undefined && willMysteriousPaperRevive(player));
+    giveTrinketsBack(player, trinketSituation);
+    return willRevive;
+}
+/**
+ * Helper function to determine if the player will be revived by the Heartbreak collectible if they
+ * take fatal damage. This is contingent on the character that they are playing as and the amount of
+ * broken hearts that they already have.
+ */
+export function willReviveFromHeartbreak(player) {
+    if (!player.HasCollectible(CollectibleType.HEARTBREAK)) {
+        return false;
+    }
+    const maxHeartContainers = getPlayerMaxHeartContainers(player);
+    const numBrokenHeartsThatWillBeAdded = isKeeper(player) ? 1 : 2;
+    const brokenHearts = player.GetBrokenHearts();
+    const numBrokenHeartsAfterRevival = numBrokenHeartsThatWillBeAdded + brokenHearts;
+    return maxHeartContainers > numBrokenHeartsAfterRevival;
+}
+/**
+ * Helper function to determine if the Spirit Shackles item is in an enabled state. (It can be
+ * either enabled or disabled.)
+ */
+export function willReviveFromSpiritShackles(player) {
+    if (!player.HasCollectible(CollectibleType.SPIRIT_SHACKLES)) {
+        return false;
+    }
+    const effects = player.GetEffects();
+    const spiritShacklesEnabled = !effects.HasNullEffect(NullItemID.SPIRIT_SHACKLES_DISABLED);
+    const playerInSoulForm = effects.HasNullEffect(NullItemID.SPIRIT_SHACKLES_SOUL);
+    return spiritShacklesEnabled && !playerInSoulForm;
+}
+//# sourceMappingURL=revive.js.map

package/dist/functions/revive.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"revive.js","sourceRoot":"../src/","sources":["functions/revive.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,UAAU,EACV,UAAU,EACV,UAAU,EACV,WAAW,GACZ,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EACL,iCAAiC,EACjC,gDAAgD,GACjD,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,8BAA8B,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,EACL,2BAA2B,EAC3B,yBAAyB,EACzB,YAAY,EACZ,QAAQ,GACT,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAC;AACnD,OAAO,EAAE,gBAAgB,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAC;AAE3E;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CACnC,MAAoB,EACpB,YAAiB,EACjB,YAAuB,EACvB,mBAAoC;IAEpC,MAAM,cAAc,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;IAC5C,MAAM,SAAS,GAAG,MAAM,CAAC,aAAa,EAAE,CAAC;IACzC,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;IACpC,MAAM,SAAS,GAAG,OAAO,CAAC,oBAAoB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAExE,4FAA4F;IAC5F,8DAA8D;IAC9D,IACE,SAAS,KAAK,UAAU,CAAC,OAAO;QAChC,YAAY,CAAC,IAAI,KAAK,UAAU,CAAC,SAAS,EAC1C;QACA,OAAO,KAAK,CAAC;KACd;IAED,6FAA6F;IAC7F,WAAW;IACX,IAAI,SAAS,EAAE;QACb,OAAO,KAAK,CAAC;KACd;IAED,8FAA8F;IAC9F,iCAAiC;IACjC,MAAM,qBAAqB,GACzB,MAAM,CAAC,mBAAmB;QAC1B,gDAAgD,CAAC;IACnD,IACE,SAAS,KAAK,UAAU,CAAC,QAAQ;QACjC,qBAAqB,IAAI,iCAAiC,EAC1D;QACA,OAAO,KAAK,CAAC;KACd;IAED,uDAAuD;IACvD,IAAI,4BAA4B,CAAC,MAAM,CAAC,EAAE;QACxC,OAAO,KAAK,CAAC;KACd;IAED,iGAAiG;IACjG,8BAA8B;IAC9B,IAAI,SAAS,KAAK,UAAU,CAAC,SAAS,EAAE;QACtC,OAAO,IAAI,CAAC;KACb;IAED,2FAA2F;IAC3F,IAAI,YAAY,CAAC,MAAM,CAAC,EAAE;QACxB,OAAO,IAAI,CAAC;KACb;IAED,MAAM,kBAAkB,GAAG,yBAAyB,CAAC,MAAM,CAAC,CAAC;IAC7D,IAAI,YAAY,GAAG,kBAAkB,EAAE;QACrC,OAAO,KAAK,CAAC;KACd;IAED,2FAA2F;IAC3F,UAAU;IACV,IAAI,wBAAwB,CAAC,MAAM,CAAC,EAAE;QACpC,OAAO,KAAK,CAAC;KACd;IAED,kGAAkG;IAClG,4BAA4B;IAC5B,IACE,MAAM,CAAC,cAAc,CAAC,eAAe,CAAC,mBAAmB,CAAC;QAC1D,cAAc,KAAK,mBAAmB,EACtC;QACA,OAAO,KAAK,CAAC;KACd;IAED,8FAA8F;IAC9F,kGAAkG;IAClG,wCAAwC;IACxC,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;IAClC,MAAM,aAAa,GAAG,MAAM,CAAC,gBAAgB,EAAE,CAAC;IAChD,MAAM,UAAU,GAAG,MAAM,CAAC,aAAa,EAAE,CAAC;IAC1C,MAAM,UAAU,GAAG,MAAM,CAAC,aAAa,EAAE,CAAC;IAC1C,IACE,CAAC,MAAM,GAAG,CAAC,IAAI,UAAU,GAAG,CAAC,CAAC;QAC9B,CAAC,MAAM,GAAG,CAAC,IAAI,UAAU,GAAG,CAAC,CAAC;QAC9B,CAAC,UAAU,GAAG,CAAC,IAAI,UAAU,GAAG,CAAC,CAAC;QAClC,CAAC,UAAU,GAAG,CAAC,IAAI,aAAa,GAAG,CAAC,CAAC;QACrC,UAAU,IAAI,CAAC,CAAC,gEAAgE;MAChF;QACA,OAAO,KAAK,CAAC;KACd;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,yBAAyB,CAAC,MAAoB;IAC5D,MAAM,cAAc,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;IAC5C,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;IAElC,iGAAiG;IACjG,sDAAsD;IACtD,MAAM,SAAS,GAAG,MAAM,CAAC,aAAa,EAAE,CAAC;IACzC,MAAM,SAAS,GAAG,8BAA8B,CAAC,SAAS,CAAC,CAAC;IAC5D,MAAM,oBAAoB,GAAG,uBAAuB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACxE,MAAM,YAAY,GAAG,cAAc,GAAG,oBAAoB,GAAG,CAAC,CAAC;IAC/D,0EAA0E;IAE1E,OAAO,YAAY,GAAG,CAAC,KAAK,CAAC,CAAC;AAChC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAoB;IACnD,MAAM,gBAAgB,GAAG,wBAAwB,CAC/C,MAAM,EACN,WAAW,CAAC,gBAAgB,CAC7B,CAAC;IAEF,MAAM,UAAU,GACd,MAAM,CAAC,gBAAgB,EAAE;QACzB,CAAC,gBAAgB,KAAK,SAAS,IAAI,yBAAyB,CAAC,MAAM,CAAC,CAAC,CAAC;IAExE,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAE3C,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,wBAAwB,CAAC,MAAoB;IAC3D,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,eAAe,CAAC,UAAU,CAAC,EAAE;QACtD,OAAO,KAAK,CAAC;KACd;IAED,MAAM,kBAAkB,GAAG,2BAA2B,CAAC,MAAM,CAAC,CAAC;IAC/D,MAAM,8BAA8B,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAChE,MAAM,YAAY,GAAG,MAAM,CAAC,eAAe,EAAE,CAAC;IAC9C,MAAM,2BAA2B,GAC/B,8BAA8B,GAAG,YAAY,CAAC;IAEhD,OAAO,kBAAkB,GAAG,2BAA2B,CAAC;AAC1D,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,4BAA4B,CAAC,MAAoB;IAC/D,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,eAAe,CAAC,eAAe,CAAC,EAAE;QAC3D,OAAO,KAAK,CAAC;KACd;IAED,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;IAEpC,MAAM,qBAAqB,GAAG,CAAC,OAAO,CAAC,aAAa,CAClD,UAAU,CAAC,wBAAwB,CACpC,CAAC;IACF,MAAM,gBAAgB,GAAG,OAAO,CAAC,aAAa,CAC5C,UAAU,CAAC,oBAAoB,CAChC,CAAC;IAEF,OAAO,qBAAqB,IAAI,CAAC,gBAAgB,CAAC;AACpD,CAAC"}

package/dist/functions/revive.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/revive.ts"],"names":[],"mappings":";AAAA,6CAMO;AALL;AACA;AACA;AACA;AACA;AAEF,0BAAqB;AAAZ;AACT,sBAGO;AAFL;AACA;AAEF,sBAA+C;AAAtC;AACT,mBAKO;AAJL;AACA;AACA;AACA;AAEF,mBAAwC;AAA/B;AACT,wBAA2D;AAAlD;AAAkB;;;;AAmJ3B,oDAAyC;WAClC,OAAO,eAAe;AACzB,eAAO;;AAGH,+BAAqB,iCAA4B;AACjD,2CAAiC,cAAS,YAAU,KAAI;AACxD,yBAAe,OAAO;AACtB,wCACJ,iCAAiC;AAEnC,WAAO,qBAAqB;AAX9B;;;AAkBA,wDAA6C;WACtC,OAAO,eAAe;AACzB,eAAO;;AAGH,oBAAU,OAAO;AAEjB,sCAAyB,QAAQ,cACrC;AAEI,6BAAmB,QAAQ,cAC/B;AAGF,WAAO,8BAA0B;AAdnC;;;AA/JA,iDACE,QACA,cACA,cACA;AAEM,2BAAiB,KAAK;AACtB,sBAAY,OAAO;AACnB,oBAAU,OAAO;AACjB,sBAAY,QAAQ,qBAAqB;OAK7C,aAAc,uBACd,qBAAsB;AAEtB,eAAO;;OAKL;AACF,eAAO;;AAKH,kCACJ,6BACA;OAEA,aAAc,wBACd,yBAAyB;AAEzB,eAAO;;OAIL,8CAA6B;AAC/B,eAAO;;OAKL,aAAc;AAChB,eAAO;;OAIL,kBAAa;AACf,eAAO;;AAGH,+BAAqB,+BAA0B;OACjD,eAAe;AACjB,eAAO;;OAKL,0CAAyB;AAC3B,eAAO;;OAMP,OAAO,eAAe,yCACtB,kBAAmB;AAEnB,eAAO;;AAMH,mBAAS,OAAO;AAChB,0BAAgB,OAAO;AACvB,uBAAa,OAAO;AACpB,uBAAa,OAAO;OAExB,SAAU,MAAK,aAAa,KAC3B,SAAS,MAAK,aAAa,KAC3B,aAAa,MAAK,aAAa,KAC/B,aAAa,MAAK,gBAAgB,KACnC,cAAc;AAEd,eAAO;;AAGT,WAAO;AA3FT;;;;;;;AAsGA,qDAA0C;AAClC,2BAAiB,KAAK;AACtB,mBAAS,OAAO;AAIhB,sBAAY,OAAO;AACnB,sBAAY,oCAA+B;AAC3C,iCAAuB,6BAAwB,QAAQ;AACvD,yBAAe,iBAAiB,uBAAuB;AAG7D,WAAO,eAAe,KAAM;AAZ9B;;;AAmBA,4CAAiC;AACzB,6BAAmB,8BACvB,QACA;AAGI,uBACJ,OAAO,sBACN,4BAAkC,2CAA0B;IAE/D,sBAAiB,QAAQ;AAEzB,WAAO;AAZT","file":"revive.lua","sourceRoot":"../src/"}

package/dist/functions/rng.d.ts

@@ -0,0 +1,54 @@
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="typescript-to-lua/language-extensions" />
+import { SerializationType } from "../enums/SerializationType";
+declare type SerializedRNG = LuaTable<string, unknown> & {
+    readonly __serializedRNGBrand: symbol;
+};
+interface CopyRNGReturn {
+    [SerializationType.NONE]: RNG;
+    [SerializationType.SERIALIZE]: SerializedRNG;
+    [SerializationType.DESERIALIZE]: RNG;
+}
+/**
+ * Helper function to copy an `RNG` object.
+ *
+ * @param rng The RNG object to copy. In the case of deserialization, this will actually be a Lua
+ *            table instead of an instantiated RNG class.
+ * @param serializationType Default is `SerializationType.NONE`.
+ */
+export declare function copyRNG<R extends RNG | SerializedRNG, S extends SerializationType>(rng: R, serializationType: S): CopyRNGReturn[S];
+export declare function copyRNG<R extends RNG | SerializedRNG>(rng: R): CopyRNGReturn[SerializationType.NONE];
+/**
+ * Helper function to get a random `Seed` value to be used in spawning entities and so on. Use this
+ * instead of calling the `Random` function directly since that can return a value of 0 and crash
+ * the game.
+ */
+export declare function getRandomSeed(): Seed;
+/** Helper function to check if something is an instantiated RNG object. */
+export declare function isRNG(object: unknown): object is RNG;
+/**
+ * Used to determine is the given table is a serialized `RNG` object created by the save data
+ * manager and/or the `deepCopy` function.
+ */
+export declare function isSerializedRNG(object: unknown): object is SerializedRNG;
+/**
+ * Helper function to initialize an RNG object using Blade's recommended shift index.
+ *
+ * @param seed The seed to initialize it with. Default is `getRandomSeed()`.
+ */
+export declare function newRNG(seed?: Seed): RNG;
+export declare function rngEquals(rng1: RNG, rng2: RNG): boolean;
+/**
+ * Helper function to iterate over the provided object and set the seed for all of the values that
+ * are RNG objects equal to a particular seed.
+ */
+export declare function setAllRNGToSeed(object: unknown, seed: Seed): void;
+/**
+ * Helper function to iterate over the provided object and set the seed for all of the values that
+ * are RNG objects equal to the start seed for the current run.
+ */
+export declare function setAllRNGToStartSeed(object: unknown): void;
+/** Helper function to set a seed to an RNG object using Blade's recommended shift index. */
+export declare function setSeed(rng: RNG, seed: Seed): void;
+export {};

package/dist/functions/rng.js

@@ -0,0 +1,117 @@
+import { game } from "../cachedClasses";
+import { SerializationBrand } from "../enums/private/SerializationBrand";
+import { SerializationType } from "../enums/SerializationType";
+import { isaacAPIClassEquals, isIsaacAPIClassOfType } from "./isaacAPIClass";
+import { getNumbersFromTable, tableHasKeys } from "./table";
+import { isTable } from "./types";
+/**
+ * This is the ShiftIdx that Blade recommended after having reviewing the game's internal functions.
+ * Any value between 0 and 80 should work equally well.
+ * https://www.jstatsoft.org/article/view/v008i14/xorshift.pdf
+ */
+const RECOMMENDED_SHIFT_IDX = 35;
+const KEYS = ["seed"];
+const OBJECT_NAME = "RNG";
+export function copyRNG(rng, serializationType = SerializationType.NONE) {
+    switch (serializationType) {
+        case SerializationType.NONE: {
+            if (!isRNG(rng)) {
+                error(`Failed to copy a ${OBJECT_NAME} object since the provided object was not a userdata ${OBJECT_NAME} class.`);
+            }
+            const seed = rng.GetSeed();
+            return newRNG(seed);
+        }
+        case SerializationType.SERIALIZE: {
+            if (!isRNG(rng)) {
+                error(`Failed to serialize a ${OBJECT_NAME} object since the provided object was not a userdata ${OBJECT_NAME} class.`);
+            }
+            const seed = rng.GetSeed();
+            const rngTable = new LuaTable();
+            rngTable.set("seed", seed);
+            rngTable.set(SerializationBrand.RNG, "");
+            return rngTable;
+        }
+        case SerializationType.DESERIALIZE: {
+            if (!isTable(rng)) {
+                error(`Failed to deserialize a ${OBJECT_NAME} object since the provided object was not a Lua table.`);
+            }
+            const [seedNumber] = getNumbersFromTable(rng, OBJECT_NAME, ...KEYS);
+            const seed = seedNumber;
+            return newRNG(seed);
+        }
+    }
+}
+/**
+ * Helper function to get a random `Seed` value to be used in spawning entities and so on. Use this
+ * instead of calling the `Random` function directly since that can return a value of 0 and crash
+ * the game.
+ */
+export function getRandomSeed() {
+    const randomNumber = Random();
+    const safeRandomNumber = randomNumber === 0 ? 1 : randomNumber;
+    return safeRandomNumber;
+}
+/** Helper function to check if something is an instantiated RNG object. */
+export function isRNG(object) {
+    return isIsaacAPIClassOfType(object, OBJECT_NAME);
+}
+/**
+ * Used to determine is the given table is a serialized `RNG` object created by the save data
+ * manager and/or the `deepCopy` function.
+ */
+export function isSerializedRNG(object) {
+    if (!isTable(object)) {
+        return false;
+    }
+    return tableHasKeys(object, ...KEYS) && object.has(SerializationBrand.RNG);
+}
+/**
+ * Helper function to initialize an RNG object using Blade's recommended shift index.
+ *
+ * @param seed The seed to initialize it with. Default is `getRandomSeed()`.
+ */
+export function newRNG(seed = getRandomSeed()) {
+    const rng = RNG();
+    setSeed(rng, seed);
+    return rng;
+}
+export function rngEquals(rng1, rng2) {
+    return isaacAPIClassEquals(rng1, rng2, KEYS);
+}
+/**
+ * Helper function to iterate over the provided object and set the seed for all of the values that
+ * are RNG objects equal to a particular seed.
+ */
+export function setAllRNGToSeed(object, seed) {
+    if (!isTable(object)) {
+        error(`Failed to iterate over the object containing RNG objects since the type of the provided object was: ${typeof object}`);
+    }
+    let setAtLeastOneSeed = false;
+    for (const [_key, value] of pairs(object)) {
+        if (isRNG(value)) {
+            setSeed(value, seed);
+            setAtLeastOneSeed = true;
+        }
+    }
+    if (!setAtLeastOneSeed) {
+        error(`Failed to set all RNG objects to seed ${seed} because the parent object did not contain any RNG objects.`);
+    }
+}
+/**
+ * Helper function to iterate over the provided object and set the seed for all of the values that
+ * are RNG objects equal to the start seed for the current run.
+ */
+export function setAllRNGToStartSeed(object) {
+    const seeds = game.GetSeeds();
+    const startSeed = seeds.GetStartSeed();
+    setAllRNGToSeed(object, startSeed);
+}
+/** Helper function to set a seed to an RNG object using Blade's recommended shift index. */
+export function setSeed(rng, seed) {
+    if (seed === 0) {
+        error("You cannot set an RNG object to a seed of 0, or the game will crash.");
+    }
+    // The game expects seeds in the range of 1 to 4294967295 (1^32 - 1).
+    rng.SetSeed(seed, RECOMMENDED_SHIFT_IDX);
+}
+//# sourceMappingURL=rng.js.map

package/dist/functions/rng.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rng.js","sourceRoot":"../src/","sources":["functions/rng.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AACzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAC7E,OAAO,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAYlC;;;;GAIG;AACH,MAAM,qBAAqB,GAAG,EAAE,CAAC;AAEjC,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;AACtB,MAAM,WAAW,GAAG,KAAK,CAAC;AAgB1B,MAAM,UAAU,OAAO,CACrB,GAAwB,EACxB,iBAAiB,GAAG,iBAAiB,CAAC,IAAI;IAE1C,QAAQ,iBAAiB,EAAE;QACzB,KAAK,iBAAiB,CAAC,IAAI,CAAC,CAAC;YAC3B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;gBACf,KAAK,CACH,oBAAoB,WAAW,wDAAwD,WAAW,SAAS,CAC5G,CAAC;aACH;YAED,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;YAC3B,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;SACrB;QAED,KAAK,iBAAiB,CAAC,SAAS,CAAC,CAAC;YAChC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;gBACf,KAAK,CACH,yBAAyB,WAAW,wDAAwD,WAAW,SAAS,CACjH,CAAC;aACH;YAED,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;YAC3B,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAmB,CAAC;YACjD,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC3B,QAAQ,CAAC,GAAG,CAAC,kBAAkB,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YACzC,OAAO,QAAyB,CAAC;SAClC;QAED,KAAK,iBAAiB,CAAC,WAAW,CAAC,CAAC;YAClC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;gBACjB,KAAK,CACH,2BAA2B,WAAW,wDAAwD,CAC/F,CAAC;aACH;YAED,MAAM,CAAC,UAAU,CAAC,GAAG,mBAAmB,CACtC,GAAgC,EAChC,WAAW,EACX,GAAG,IAAI,CACR,CAAC;YACF,MAAM,IAAI,GAAG,UAAkB,CAAC;YAChC,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;SACrB;KACF;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa;IAC3B,MAAM,YAAY,GAAG,MAAM,EAAE,CAAC;IAC9B,MAAM,gBAAgB,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;IAC/D,OAAO,gBAAwB,CAAC;AAClC,CAAC;AAED,2EAA2E;AAC3E,MAAM,UAAU,KAAK,CAAC,MAAe;IACnC,OAAO,qBAAqB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AACpD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,MAAe;IAC7C,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QACpB,OAAO,KAAK,CAAC;KACd;IAED,OAAO,YAAY,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;AAC7E,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,MAAM,CAAC,IAAI,GAAG,aAAa,EAAE;IAC3C,MAAM,GAAG,GAAG,GAAG,EAAE,CAAC;IAClB,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACnB,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,IAAS,EAAE,IAAS;IAC5C,OAAO,mBAAmB,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAC/C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,MAAe,EAAE,IAAU;IACzD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QACpB,KAAK,CACH,uGAAuG,OAAO,MAAM,EAAE,CACvH,CAAC;KACH;IAED,IAAI,iBAAiB,GAAG,KAAK,CAAC;IAC9B,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,EAAE;QACzC,IAAI,KAAK,CAAC,KAAK,CAAC,EAAE;YAChB,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YACrB,iBAAiB,GAAG,IAAI,CAAC;SAC1B;KACF;IAED,IAAI,CAAC,iBAAiB,EAAE;QACtB,KAAK,CACH,yCAAyC,IAAI,6DAA6D,CAC3G,CAAC;KACH;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAC,MAAe;IAClD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC9B,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC;IAEvC,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AACrC,CAAC;AAED,4FAA4F;AAC5F,MAAM,UAAU,OAAO,CAAC,GAAQ,EAAE,IAAU;IAC1C,IAAI,IAAI,KAAK,CAAC,EAAE;QACd,KAAK,CACH,sEAAsE,CACvE,CAAC;KACH;IAED,qEAAqE;IACrE,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC;AAC3C,CAAC"}

package/dist/functions/rng.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/rng.ts"],"names":[],"mappings":";;;MAsBM,uBAGA;AAzBN,0BAAqB;AAAZ;AACT,+BAAmC;AAA1B;AACT,8BAAkC;AAAzB;AACT,0BAA2D;AAAlD;AAAqB;AAC9B,kBAAkD;AAAzC;AAAqB;AAC9B,kBAAwB;AAAf;;;;AAyFT;AACQ,yBAAe;AACf,6BAAmB,gBAAiB,MAAI,KAAI;AAClD,WAAO;AAHT;;AAOA,iCAAsB;AACpB,WAAO,2BAAsB,QAAQ;AADvC;;;;AAqBA,kCAAuB;OAAA;QAAA,OAAO;;AACtB,gBAAM;IACZ,yBAAQ,KAAK;AACb,WAAO;AAHT;;AAgDA,mCAAwB,KAAU;OAC5B,QAAS;QACX,MACE;;IAKJ,IAAI,QAAQ,MAAM;AARpB;AApJM,wBAAwB;AAExB,aAAO,CAAC;AACR,cAAc;;;;;;AAgBpB,mCACE,KACA;OAAA;QAAA,oBAAoB;;;4BAEZ;yCACD;;;uBACE,uBAAM;oBACT,SACE,uBAAoB,gBAAW,4DAAwD,gBAAW;;AAIhG,6BAAO,IAAI;AACjB,uBAAO,wBAAO;;;gDAGX;;;uBACE,uBAAM;oBACT,SACE,4BAAyB,gBAAW,4DAAwD,gBAAW;;AAIrG,6BAAO,IAAI;AACX,iCAAW;AACjB,yBAAa,OAAQ;AACrB,yBAAa,0BAAwB;AACrC,uBAAO;;;gDAGJ;;;uBACE,aAAQ;oBACX,OACE,8BAA2B,gBAAW;;AAIrB,sBAAd,aAAc;;oBACnB;oBACA;oBACA,aAAG;;AAEC,6BAAO;AACb,uBAAO,wBAAO;;;;AA3CpB;;;AAoEA,2CAAgC;WACzB,aAAQ;AACX,eAAO;;AAGT,WAAO;;QAAa;QAAQ,aAAG;UAAS,OAAW;AALrD;AAmBA,qCAA0B,MAAW;AACnC,WAAO,yBAAoB,MAAM,MAAM;AADzC;;;AAQA,2CAAgC,QAAiB;WAC1C,aAAQ;QACX,MACE,0GAAuG,aAAO;;AAI9G,8BAAoB;AACxB,QAAY,MAAM,SAAU,MAAM;WAC5B,uBAAM;YACR,yBAAQ,OAAO;AACf,gCAAoB;;;WAInB;QACH,OACE,qDAAyC,UAAI;;AAjBnD;;;AA0BA,gDAAqC;AAC7B,kBAAQ,KAAK;AACb,sBAAY,MAAM;IAExB,iCAAgB,QAAQ;AAJ1B","file":"rng.lua","sourceRoot":"../src/"}

package/dist/functions/roomData.js

@@ -0,0 +1,174 @@
+import { DoorSlotFlag, } from "isaac-typescript-definitions";
+import { game } from "../cachedClasses";
+import { doorSlotFlagToDoorSlot } from "./doors";
+import { getEnumValues } from "./enums";
+import { hasFlag } from "./flag";
+/**
+ * Helper function to get the set of allowed door slots for the room at the supplied grid index.
+ * This corresponds to the doors that are enabled in the STB/XML file for the room.
+ */
+export function getRoomAllowedDoors(roomGridIndex) {
+    const allowedDoors = new Set();
+    const roomData = getRoomData(roomGridIndex);
+    if (roomData === undefined) {
+        return allowedDoors;
+    }
+    const doorSlotFlags = getEnumValues(DoorSlotFlag);
+    for (const doorSlotFlag of doorSlotFlags) {
+        if (hasFlag(roomData.Doors, doorSlotFlag)) {
+            const doorSlot = doorSlotFlagToDoorSlot(doorSlotFlag);
+            allowedDoors.add(doorSlot);
+        }
+    }
+    return allowedDoors;
+}
+/**
+ * Helper function to get the room data for the provided room.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ */
+export function getRoomData(roomGridIndex) {
+    const roomDescriptor = getRoomDescriptor(roomGridIndex);
+    return roomDescriptor.Data;
+}
+/**
+ * Helper function to get the descriptor for a room.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ */
+export function getRoomDescriptor(roomGridIndex) {
+    const level = game.GetLevel();
+    if (roomGridIndex === undefined) {
+        roomGridIndex = getRoomGridIndex();
+    }
+    return level.GetRoomByIdx(roomGridIndex);
+}
+/**
+ * Alias for the `Level.GetCurrentRoomDesc` method. Use this to make it more clear what type of
+ * `RoomDescriptor` object that you are retrieving.
+ */
+export function getRoomDescriptorReadOnly() {
+    const level = game.GetLevel();
+    return level.GetCurrentRoomDesc();
+}
+/**
+ * Helper function to get the grid index of the current room.
+ *
+ * - If the current room is inside of the grid, this function will return the `SafeGridIndex` from
+ *   the room descriptor. (The safe grid index is defined as the top-left 1x1 section that the room
+ *   overlaps with, or the top-right 1x1 section of a `RoomType.SHAPE_LTL` room.)
+ * - If the current room is outside of the grid, it will return the index from the
+ *   `Level.GetCurrentRoomIndex` method (since `SafeGridIndex` is bugged for these cases).
+ *
+ * Use this function instead of the `Level.GetCurrentRoomIndex` method directly because the latter
+ * will return the specific 1x1 quadrant that the player entered the room at. For most situations,
+ * using the safe grid index is more reliable than this.
+ *
+ * Data structures that store data per room should use the room's `ListIndex` instead of
+ * `SafeGridIndex`, since the former is unique across different dimensions.
+ */
+export function getRoomGridIndex() {
+    const level = game.GetLevel();
+    const currentRoomIndex = level.GetCurrentRoomIndex();
+    // Both `RoomDescriptor.GridIndex` and `RoomDescriptor.SafeGridIndex` will always be equal to -1
+    // for rooms outside of the grid. Thus, we revert to using the `Level.GetCurrentRoomIndex` method
+    // for these cases.
+    if (currentRoomIndex < 0) {
+        return currentRoomIndex;
+    }
+    const roomDescriptor = getRoomDescriptorReadOnly();
+    return roomDescriptor.SafeGridIndex;
+}
+/**
+ * Helper function to get the list grid index of the provided room, which is equal to the index in
+ * the `RoomList.Get` method. In other words, this is equal to the order that the room was created
+ * by the floor generation algorithm.
+ *
+ * Use this as an index for data structures that store data per room, since it is unique across
+ * different dimensions.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ */
+export function getRoomListIndex(roomGridIndex) {
+    const roomDescriptor = getRoomDescriptor(roomGridIndex);
+    return roomDescriptor.ListIndex;
+}
+/**
+ * Helper function to get the name of the room as it appears in the STB/XML data.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ * @returns The room name. Returns "Unknown" if the type was not found.
+ */
+export function getRoomName(roomGridIndex) {
+    const roomData = getRoomData(roomGridIndex);
+    return roomData === undefined ? "Unknown" : roomData.Name;
+}
+/**
+ * Helper function to get the name of the room as it appears in the STB/XML data.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ * @returns The room name. Returns "Unknown" if the type was not found.
+ */
+export function getRoomShape(roomGridIndex) {
+    const roomData = getRoomData(roomGridIndex);
+    return roomData === undefined ? undefined : roomData.Shape;
+}
+/**
+ * Helper function to get the stage ID for a room from the XML/STB data. The room stage ID will
+ * correspond to the first number in the filename of the XML/STB file. For example, a Depths room
+ * would have a stage ID of 7.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ * @returns The room stage ID. Returns -1 if the stage ID was not found.
+ */
+export function getRoomStageID(roomGridIndex) {
+    const roomData = getRoomData(roomGridIndex);
+    return roomData === undefined ? -1 : roomData.StageID;
+}
+/**
+ * Helper function to get the sub-type for a room from the XML/STB data. The room sub-type will
+ * correspond to different things depending on what XML/STB file it draws from. For example, in the
+ * "00.special rooms.stb" file, an Angel Room with a sub-type of 0 will correspond to a normal Angel
+ * Room and a sub-type of 1 will correspond to an Angel Room shop for The Stairway.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ * @returns The room sub-type. Returns -1 if the sub-type was not found.
+ */
+export function getRoomSubType(roomGridIndex) {
+    const roomData = getRoomData(roomGridIndex);
+    return roomData === undefined ? -1 : roomData.Subtype;
+}
+/**
+ * Helper function for getting the type of the room with the given grid index.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ * @returns The room data type. Returns -1 if the type was not found.
+ */
+export function getRoomType(roomGridIndex) {
+    const roomData = getRoomData(roomGridIndex);
+    return roomData === undefined ? -1 : roomData.Type;
+}
+/**
+ * Helper function to get the variant for a room from the XML/STB data. You can think of a room
+ * variant as its identifier. For example, to go to Basement room #123, you would use a console
+ * command of `goto d.123` while on the Basement.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ * @returns The room variant. Returns -1 if the variant was not found.
+ */
+export function getRoomVariant(roomGridIndex) {
+    const roomData = getRoomData(roomGridIndex);
+    return roomData === undefined ? -1 : roomData.Variant;
+}
+/**
+ * Note that the room visited count will be inaccurate during the period before the PostNewRoom
+ * callback has fired (i.e. when entities are initializing and performing their first update). This
+ * is because the variable is only incremented immediately before the PostNewRoom callback fires.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ */
+export function getRoomVisitedCount(roomGridIndex) {
+    const roomDescriptor = getRoomDescriptor(roomGridIndex);
+    return roomDescriptor.VisitedCount;
+}
+//# sourceMappingURL=roomData.js.map

package/dist/functions/roomData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"roomData.js","sourceRoot":"../src/","sources":["functions/roomData.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,YAAY,GAIb,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AAEjC;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,aAAmB;IACrD,MAAM,YAAY,GAAG,IAAI,GAAG,EAAY,CAAC;IAEzC,MAAM,QAAQ,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAC5C,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC1B,OAAO,YAAY,CAAC;KACrB;IAED,MAAM,aAAa,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;IAClD,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE;QACxC,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC,EAAE;YACzC,MAAM,QAAQ,GAAG,sBAAsB,CAAC,YAAY,CAAC,CAAC;YACtD,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;SAC5B;KACF;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,aAAmB;IAC7C,MAAM,cAAc,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC;IACxD,OAAO,cAAc,CAAC,IAAI,CAAC;AAC7B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,aAAmB;IACnD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAE9B,IAAI,aAAa,KAAK,SAAS,EAAE;QAC/B,aAAa,GAAG,gBAAgB,EAAE,CAAC;KACpC;IAED,OAAO,KAAK,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;AAC3C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,yBAAyB;IACvC,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC9B,OAAO,KAAK,CAAC,kBAAkB,EAAE,CAAC;AACpC,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,gBAAgB;IAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC9B,MAAM,gBAAgB,GAAG,KAAK,CAAC,mBAAmB,EAAE,CAAC;IAErD,gGAAgG;IAChG,iGAAiG;IACjG,mBAAmB;IACnB,IAAI,gBAAgB,GAAG,CAAC,EAAE;QACxB,OAAO,gBAAgB,CAAC;KACzB;IAED,MAAM,cAAc,GAAG,yBAAyB,EAAE,CAAC;IACnD,OAAO,cAAc,CAAC,aAAa,CAAC;AACtC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,gBAAgB,CAAC,aAAmB;IAClD,MAAM,cAAc,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC;IACxD,OAAO,cAAc,CAAC,SAAS,CAAC;AAClC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,aAAmB;IAC7C,MAAM,QAAQ,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAC5C,OAAO,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;AAC5D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,aAAmB;IAC9C,MAAM,QAAQ,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAC5C,OAAO,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;AAC7D,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAC,aAAmB;IAChD,MAAM,QAAQ,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAC5C,OAAO,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC;AACxD,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,cAAc,CAAC,aAAmB;IAChD,MAAM,QAAQ,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAC5C,OAAO,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC;AACxD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,aAAmB;IAC7C,MAAM,QAAQ,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAC5C,OAAO,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;AACrD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAC,aAAmB;IAChD,MAAM,QAAQ,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAC5C,OAAO,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC;AACxD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,aAAmB;IACrD,MAAM,cAAc,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC;IACxD,OAAO,cAAc,CAAC,YAAY,CAAC;AACrC,CAAC"}

package/dist/functions/roomData.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/roomData.ts"],"names":[],"mappings":";;;;AAAA,6CAMO;AAJL;AAKF,0BAAqB;AAAZ;AACT,kBAAuC;AAA9B;AACT,kBAA8B;AAArB;AACT,iBAAwB;AAAf;;;;AA8BT,uCAA4B;AACpB,2BAAiB,mCAAkB;AACzC,WAAO;AAFT;;;;AAUA,6CAAkC;AAC1B,kBAAQ,KAAK;OAEf;AACF,wBAAgB;;AAGlB,WAAO,MAAM,aAAa;AAP5B;;;AAcA;AACQ,kBAAQ,KAAK;AACnB,WAAO,MAAM;AAFf;;;;;;;;;;;;;;;AAqBA;AACQ,kBAAQ,KAAK;AACb,6BAAmB,MAAM;OAK3B,mBAAmB;AACrB,eAAO;;AAGH,2BAAiB;AACvB,WAAO;AAZT;;;AArEA,+CAAoC;AAC5B,yBAAe,UAAI;AAEnB,qBAAW,6BAAY;OACzB;AACF,eAAO;;AAGH,0BAAgB,mBAAc;AACpC,cAAW,uBAAgB;WACrB,aAAQ,gBAAgB;AACpB,6BAAW,4BAAuB;YACxC,aAAa,IAAI;;;AAIrB,WAAO;AAhBT;;;;;;;;;AA8FA,4CAAiC;AACzB,2BAAiB,mCAAkB;AACzC,WAAO;AAFT;;;;;AAWA,uCAA4B;AACpB,qBAAW,6BAAY;AAC7B,WAAO,oBAAyB,aAAY;AAF9C;;;;;AAWA,wCAA6B;AACrB,qBAAW,6BAAY;AACtB;OAAA;AAAyB;;AAAY;;AAA5C;AAFF;;;;;;;AAaA,0CAA+B;AACvB,qBAAW,6BAAY;AAC7B,WAAO,qBAA0B,KAAI;AAFvC;;;;;;;;AAcA,0CAA+B;AACvB,qBAAW,6BAAY;AAC7B,WAAO,qBAA0B,KAAI;AAFvC;;;;;AAWA,uCAA4B;AACpB,qBAAW,6BAAY;AAC7B,WAAO,qBAA0B,KAAI;AAFvC;;;;;;;AAaA,0CAA+B;AACvB,qBAAW,6BAAY;AAC7B,WAAO,qBAA0B,KAAI;AAFvC;;;;;;AAYA,+CAAoC;AAC5B,2BAAiB,mCAAkB;AACzC,WAAO;AAFT","file":"roomData.lua","sourceRoot":"../src/"}

package/dist/functions/roomGrid.js

@@ -0,0 +1,81 @@
+import { L_ROOM_SHAPE_TO_RECTANGLES } from "../objects/LRoomShapeToRectangles";
+import { inRectangle } from "./math";
+import { getRoomShapeBottomRightPosition, getRoomShapeTopLeftPosition, getRoomShapeWidth, isLRoom, } from "./roomShape";
+/**
+ * Helper function to convert grid coordinates to a world position `Vector`.
+ *
+ * For example, the coordinates of (0, 0) are equal to `Vector(80, 160)`.
+ */
+export function gridCoordinatesToWorldPosition(x, y) {
+    const gridPosition = Vector(x, y);
+    return gridPositionToWorldPosition(gridPosition);
+}
+/**
+ * Helper function to convert a grid index to a grid position.
+ *
+ * For example, in a 1x1 room, grid index 0 is equal to "Vector(-1, -1) and grid index 16 is equal
+ * to "Vector(0, 0)".
+ */
+export function gridIndexToGridPosition(gridIndex, roomShape) {
+    const gridWidth = getRoomShapeWidth(roomShape);
+    const x = (gridIndex % gridWidth) - 1;
+    const y = Math.floor(gridIndex / gridWidth) - 1;
+    return Vector(x, y);
+}
+/**
+ * Helper function to convert a grid position `Vector` to a world position `Vector`.
+ *
+ * For example, the coordinates of (0, 0) are equal to `Vector(80, 160)`.
+ */
+export function gridPositionToWorldPosition(gridPosition) {
+    const x = (gridPosition.X + 2) * 40;
+    const y = (gridPosition.Y + 4) * 40;
+    return Vector(x, y);
+}
+/**
+ * Test if a grid position is actually in the given `RoomShape`.
+ *
+ * In this context, the grid position of the top-left wall is "Vector(-1, -1)".
+ */
+export function isValidGridPosition(gridPosition, roomShape) {
+    return isLRoom(roomShape)
+        ? isValidGridPositionLRoom(gridPosition, roomShape)
+        : isValidGridPositionNormal(gridPosition, roomShape);
+}
+function isValidGridPositionNormal(gridPosition, roomShape) {
+    const topLeft = getRoomShapeTopLeftPosition(roomShape);
+    const bottomRight = getRoomShapeBottomRightPosition(roomShape);
+    return inRectangle(gridPosition, topLeft, bottomRight);
+}
+function isValidGridPositionLRoom(gridPosition, roomShape) {
+    const rectangles = L_ROOM_SHAPE_TO_RECTANGLES[roomShape];
+    if (rectangles === undefined) {
+        return false;
+    }
+    const [verticalTopLeft, verticalBottomRight, horizontalTopLeft, horizontalBottomRight,] = rectangles;
+    return (inRectangle(gridPosition, verticalTopLeft, verticalBottomRight) ||
+        inRectangle(gridPosition, horizontalTopLeft, horizontalBottomRight));
+}
+/**
+ * Helper function to convert a world position `Vector` to a grid position `Vector`.
+ *
+ * In this context, the grid position of the top-left wall is "Vector(-1, -1)".
+ */
+export function worldPositionToGridPosition(worldPos) {
+    const x = Math.round(worldPos.X / 40 - 2);
+    const y = Math.round(worldPos.Y / 40 - 4);
+    return Vector(x, y);
+}
+/**
+ * Helper function to convert a world position `Vector` to a grid position `Vector`.
+ *
+ * In this context, the grid position of the top-left wall is "Vector(-1, -1)".
+ *
+ * This is similar to the `worldPositionToGridPosition` function, but the values are not rounded.
+ */
+export function worldPositionToGridPositionFast(worldPos) {
+    const x = worldPos.X / 40 - 2;
+    const y = worldPos.Y / 40 - 4;
+    return Vector(x, y);
+}
+//# sourceMappingURL=roomGrid.js.map

package/dist/functions/roomGrid.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"roomGrid.js","sourceRoot":"../src/","sources":["functions/roomGrid.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAC;AAC/E,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,EACL,+BAA+B,EAC/B,2BAA2B,EAC3B,iBAAiB,EACjB,OAAO,GACR,MAAM,aAAa,CAAC;AAErB;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,CAAC,CAAM,EAAE,CAAM;IAC3D,MAAM,YAAY,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAClC,OAAO,2BAA2B,CAAC,YAAY,CAAC,CAAC;AACnD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CACrC,SAAc,EACd,SAAoB;IAEpB,MAAM,SAAS,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAE/C,MAAM,CAAC,GAAG,CAAC,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;IACtC,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;IAChD,OAAO,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AACtB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,2BAA2B,CAAC,YAAoB;IAC9D,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;IACpC,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;IACpC,OAAO,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AACtB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CACjC,YAAoB,EACpB,SAAoB;IAEpB,OAAO,OAAO,CAAC,SAAS,CAAC;QACvB,CAAC,CAAC,wBAAwB,CAAC,YAAY,EAAE,SAAS,CAAC;QACnD,CAAC,CAAC,yBAAyB,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;AACzD,CAAC;AAED,SAAS,yBAAyB,CAAC,YAAoB,EAAE,SAAoB;IAC3E,MAAM,OAAO,GAAG,2BAA2B,CAAC,SAAS,CAAC,CAAC;IACvD,MAAM,WAAW,GAAG,+BAA+B,CAAC,SAAS,CAAC,CAAC;IAC/D,OAAO,WAAW,CAAC,YAAY,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;AACzD,CAAC;AAED,SAAS,wBAAwB,CAAC,YAAoB,EAAE,SAAoB;IAC1E,MAAM,UAAU,GAAG,0BAA0B,CAAC,SAAS,CAAC,CAAC;IACzD,IAAI,UAAU,KAAK,SAAS,EAAE;QAC5B,OAAO,KAAK,CAAC;KACd;IAED,MAAM,CACJ,eAAe,EACf,mBAAmB,EACnB,iBAAiB,EACjB,qBAAqB,EACtB,GAAG,UAAU,CAAC;IACf,OAAO,CACL,WAAW,CAAC,YAAY,EAAE,eAAe,EAAE,mBAAmB,CAAC;QAC/D,WAAW,CAAC,YAAY,EAAE,iBAAiB,EAAE,qBAAqB,CAAC,CACpE,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,2BAA2B,CAAC,QAAgB;IAC1D,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IAC1C,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IAC1C,OAAO,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AACtB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,+BAA+B,CAAC,QAAgB;IAC9D,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC9B,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC9B,OAAO,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AACtB,CAAC"}

package/dist/functions/roomGrid.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/roomGrid.ts"],"names":[],"mappings":";MA8DS,2BAMA;AAnET,mCAA2C;AAAlC;AACT,iBAA4B;AAAnB;AACT,sBAKO;AAJL;AACA;AACA;AACA;;;;AAmCF,uDAA4C;AACpC,cAAI,CAAC,iBAAiB,KAAK;AAC3B,cAAI,CAAC,iBAAiB,KAAK;AACjC,WAAO,OAAO,GAAG;AAHnB;AAoBA,SAAS,gCAA0B,cAAsB;AACjD,oBAAU,iCAA4B;AACtC,wBAAc,qCAAgC;AACpD,WAAO,iBAAY,cAAc,SAAS;;AAG5C,SAAS,+BAAyB,cAAsB;AAChD,uBAAa,2BAA2B;OAC1C;AACF,eAAO;;AAQL,UAJF,iBACA,qBACA,mBACA,wBACE;AACJ,WACE,iBAAY,cAAc,iBAAiB,wBAC3C,iBAAY,cAAc,mBAAmB;;;;;AAnEjD,0DAA+C,GAAQ;AAC/C,yBAAe,OAAO,GAAG;AAC/B,WAAO,6CAA4B;AAFrC;;;;;AAWA,mDACE,WACA;AAEM,sBAAY,uBAAkB;AAE9B,cAAI,YAAa,YAAa;AAC9B,cAAI,WAAW,YAAY,aAAa;AAC9C,WAAO,OAAO,GAAG;AARnB;;;;AA2BA,+CACE,cACA;AAEO;OAAA,aAAQ;AACX,6DAAyB,cAAc;;AACvC,8DAA0B,cAAc;;AAF5C;AAJF;;;;AAsCA,uDAA4C;AACpC,cAAI,WAAW,aAAa,KAAK;AACjC,cAAI,WAAW,aAAa,KAAK;AACvC,WAAO,OAAO,GAAG;AAHnB;;;;;;AAaA,2DAAgD;AACxC,cAAI,aAAa,KAAK;AACtB,cAAI,aAAa,KAAK;AAC5B,WAAO,OAAO,GAAG;AAHnB","file":"roomGrid.lua","sourceRoot":"../src/"}