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

package/dist/functions/sound.lua

@@ -0,0 +1,13 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local SoundEffect = ____isaac_2Dtypescript_2Ddefinitions.SoundEffect
+local ____cachedClasses = require("cachedClasses")
+local sfxManager = ____cachedClasses.sfxManager
+local ____enums = require("functions.enums")
+local getEnumValues = ____enums.getEnumValues
+function ____exports.stopAllSoundEffects(self)
+    for ____, soundEffect in ipairs(getEnumValues(nil, SoundEffect)) do
+        sfxManager:Stop(soundEffect)
+    end
+end
+return ____exports

package/dist/functions/sound.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/sound.ts"],"names":[],"mappings":";AAAA,6CAA4B;AAAnB;AACT,0BAA2B;AAAlB;AACT,kBAA8B;AAArB;AAET;AACE,cAAW,sBAAe,mBAAc;QACtC,WAAW,KAAK;;AAFpB","file":"sound.lua","sourceRoot":"../src/"}

package/dist/functions/spawnCollectible.js

@@ -0,0 +1,66 @@
+import { CollectibleType, PickupVariant, PlayerType, } from "isaac-typescript-definitions";
+import { VectorZero } from "../constants";
+import { preventCollectibleRotation } from "../features/preventCollectibleRotation";
+import { areFeaturesInitialized } from "../featuresInitialized";
+import { setCollectibleEmpty } from "./collectibles";
+import { isQuestCollectible } from "./collectibleTag";
+import { spawnPickupWithSeed } from "./entitySpecific";
+import { anyPlayerIs } from "./player";
+import { getRandomSeed, isRNG } from "./rng";
+/**
+ * Helper function to spawn a collectible. Use this instead of the `Game.Spawn` method because it
+ * handles the cases of Tainted Keeper collectibles costing coins and preventing quest items from
+ * being rotated by Tainted Isaac's rotation mechanic. (Rotation prevention will only occur in
+ * upgraded mods.)
+ *
+ * @param collectibleType The collectible type to spawn.
+ * @param position The position to spawn the collectible at.
+ * @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 options Optional. Set to true to make the collectible a "There's Options" style
+ *                collectible. Default is false.
+ * @param forceFreeItem Optional. Set to true to disable the logic that gives the item a price for
+ *                      Tainted Keeper. Default is false.
+ * @param spawner Optional.
+ */
+export function spawnCollectible(collectibleType, position, seedOrRNG = getRandomSeed(), options = false, forceFreeItem = false, spawner) {
+    const seed = isRNG(seedOrRNG) ? seedOrRNG.Next() : seedOrRNG;
+    const collectible = spawnPickupWithSeed(PickupVariant.COLLECTIBLE, collectibleType, position, seed, VectorZero, spawner);
+    if (options) {
+        collectible.OptionsPickupIndex = 1;
+    }
+    if (anyPlayerIs(PlayerType.KEEPER_B) &&
+        !isQuestCollectible(collectibleType) &&
+        !forceFreeItem) {
+        // When playing Tainted Keeper, collectibles are supposed to have a price, and manually spawned
+        // items will not have a price, so we have to set it manually.
+        // Setting the shop item ID in this way prevents the bug where the item will sometimes change to
+        // 99 cents.
+        collectible.ShopItemId = -1;
+        // We can set the price to any arbitrary value; it will auto-update to the true price on the
+        // next frame.
+        collectible.Price = 15;
+    }
+    if (isQuestCollectible(collectibleType) && areFeaturesInitialized()) {
+        preventCollectibleRotation(collectible, collectibleType);
+    }
+    return collectible;
+}
+/**
+ * Helper function to spawn an empty collectible. Doing this is tricky since spawning a collectible
+ * with `CollectibleType.NULL` will result in spawning a collectible with a random type from the
+ * current room's item pool.
+ *
+ * Instead, this function arbitrarily spawns a collectible with `CollectibleType.SAD_ONION`, and
+ * then converts it to an empty pedestal afterward.
+ *
+ * @param position The position to spawn the empty collectible at.
+ * @param seedOrRNG 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 spawnEmptyCollectible(position, seedOrRNG = getRandomSeed()) {
+    const collectible = spawnCollectible(CollectibleType.SAD_ONION, position, seedOrRNG, false, true);
+    setCollectibleEmpty(collectible);
+    return collectible;
+}
+//# sourceMappingURL=spawnCollectible.js.map

package/dist/functions/spawnCollectible.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spawnCollectible.js","sourceRoot":"../src/","sources":["functions/spawnCollectible.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EAEf,aAAa,EACb,UAAU,GACX,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAC;AACpF,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAE7C;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,gBAAgB,CAC9B,eAAgC,EAChC,QAAgB,EAChB,YAAwB,aAAa,EAAE,EACvC,OAAO,GAAG,KAAK,EACf,aAAa,GAAG,KAAK,EACrB,OAAgB;IAEhB,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7D,MAAM,WAAW,GAAG,mBAAmB,CACrC,aAAa,CAAC,WAAW,EACzB,eAAe,EACf,QAAQ,EACR,IAAI,EACJ,UAAU,EACV,OAAO,CACmB,CAAC;IAE7B,IAAI,OAAO,EAAE;QACX,WAAW,CAAC,kBAAkB,GAAG,CAAC,CAAC;KACpC;IAED,IACE,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC;QAChC,CAAC,kBAAkB,CAAC,eAAe,CAAC;QACpC,CAAC,aAAa,EACd;QACA,+FAA+F;QAC/F,8DAA8D;QAE9D,gGAAgG;QAChG,YAAY;QACZ,WAAW,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;QAE5B,4FAA4F;QAC5F,cAAc;QACd,WAAW,CAAC,KAAK,GAAG,EAAiB,CAAC;KACvC;IAED,IAAI,kBAAkB,CAAC,eAAe,CAAC,IAAI,sBAAsB,EAAE,EAAE;QACnE,0BAA0B,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;KAC1D;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,qBAAqB,CACnC,QAAgB,EAChB,YAAwB,aAAa,EAAE;IAEvC,MAAM,WAAW,GAAG,gBAAgB,CAClC,eAAe,CAAC,SAAS,EACzB,QAAQ,EACR,SAAS,EACT,KAAK,EACL,IAAI,CACL,CAAC;IACF,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAEjC,OAAO,WAAW,CAAC;AACrB,CAAC"}

package/dist/functions/spawnCollectible.lua

@@ -0,0 +1,94 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
+local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
+local ____preventCollectibleRotation = require("features.preventCollectibleRotation")
+local preventCollectibleRotation = ____preventCollectibleRotation.preventCollectibleRotation
+local ____featuresInitialized = require("featuresInitialized")
+local areFeaturesInitialized = ____featuresInitialized.areFeaturesInitialized
+local ____collectibles = require("functions.collectibles")
+local setCollectibleEmpty = ____collectibles.setCollectibleEmpty
+local ____collectibleTag = require("functions.collectibleTag")
+local isQuestCollectible = ____collectibleTag.isQuestCollectible
+local ____entitySpecific = require("functions.entitySpecific")
+local spawnPickupWithSeed = ____entitySpecific.spawnPickupWithSeed
+local ____player = require("functions.player")
+local anyPlayerIs = ____player.anyPlayerIs
+local ____rng = require("functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
+local isRNG = ____rng.isRNG
+--- Helper function to spawn a collectible. Use this instead of the `Game.Spawn` method because it
+-- handles the cases of Tainted Keeper collectibles costing coins and preventing quest items from
+-- being rotated by Tainted Isaac's rotation mechanic. (Rotation prevention will only occur in
+-- upgraded mods.)
+-- 
+-- @param collectibleType The collectible type to spawn.
+-- @param position The position to spawn the collectible at.
+-- @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 options Optional. Set to true to make the collectible a "There's Options" style
+-- collectible. Default is false.
+-- @param forceFreeItem Optional. Set to true to disable the logic that gives the item a price for
+-- Tainted Keeper. Default is false.
+-- @param spawner Optional.
+function ____exports.spawnCollectible(self, collectibleType, position, seedOrRNG, options, forceFreeItem, spawner)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    if options == nil then
+        options = false
+    end
+    if forceFreeItem == nil then
+        forceFreeItem = false
+    end
+    local seed = isRNG(nil, seedOrRNG) and seedOrRNG:Next() or seedOrRNG
+    local collectible = spawnPickupWithSeed(
+        nil,
+        PickupVariant.COLLECTIBLE,
+        collectibleType,
+        position,
+        seed,
+        VectorZero,
+        spawner
+    )
+    if options then
+        collectible.OptionsPickupIndex = 1
+    end
+    if anyPlayerIs(nil, PlayerType.KEEPER_B) and not isQuestCollectible(nil, collectibleType) and not forceFreeItem then
+        collectible.ShopItemId = -1
+        collectible.Price = 15
+    end
+    if isQuestCollectible(nil, collectibleType) and areFeaturesInitialized(nil) then
+        preventCollectibleRotation(nil, collectible, collectibleType)
+    end
+    return collectible
+end
+--- Helper function to spawn an empty collectible. Doing this is tricky since spawning a collectible
+-- with `CollectibleType.NULL` will result in spawning a collectible with a random type from the
+-- current room's item pool.
+-- 
+-- Instead, this function arbitrarily spawns a collectible with `CollectibleType.SAD_ONION`, and
+-- then converts it to an empty pedestal afterward.
+-- 
+-- @param position The position to spawn the empty collectible at.
+-- @param seedOrRNG The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+-- `RNG.Next` method will be called. Default is `getRandomSeed()`.
+function ____exports.spawnEmptyCollectible(self, position, seedOrRNG)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    local collectible = ____exports.spawnCollectible(
+        nil,
+        CollectibleType.SAD_ONION,
+        position,
+        seedOrRNG,
+        false,
+        true
+    )
+    setCollectibleEmpty(nil, collectible)
+    return collectible
+end
+return ____exports

package/dist/functions/spawnCollectible.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/spawnCollectible.ts"],"names":[],"mappings":";AAAA,6CAKO;AAJL;AAEA;AACA;AAEF,sBAA2B;AAAlB;AACT,uCAA2C;AAAlC;AACT,gCAAuC;AAA9B;AACT,yBAAoC;AAA3B;AACT,2BAAmC;AAA1B;AACT,2BAAoC;AAA3B;AACT,mBAA4B;AAAnB;AACT,gBAAqC;AAA5B;AAAe;;;;;;;;;;;;;;;AAkBxB,4CACE,iBACA,UACA,WACA,SACA,eACA;OAHA;QAAA,YAAwB;;OACxB;QAAA,UAAU;;OACV;QAAA,gBAAgB;;AAGV,iBAAO,WAAM,eAAa,UAAU,UAAS;AAC7C,wBAAc;;QAClB;QACA;QACA;QACA;QACA;QACA;;OAGE;AACF,yCAAiC;;OAIjC,iBAAY,6BACX,wBAAmB,yBACnB;AAOD,kCAA0B;AAI1B,4BAAoB;;OAGlB,wBAAmB,qBAAoB;QACzC,gCAA2B,aAAa;;AAG1C,WAAO;AA3CT;;;;;;;;;;;AA0DA,iDACE,UACA;OAAA;QAAA,YAAwB;;AAElB,wBAAc;;QAClB;QACA;QACA;QACA;QACA;;IAEF,yBAAoB;AAEpB,WAAO;AAbT","file":"spawnCollectible.lua","sourceRoot":"../src/"}

package/dist/functions/sprite.js

@@ -0,0 +1,80 @@
+import { EMPTY_PNG_PATH, VectorZero } from "../constants";
+import { kColorEquals } from "./kColor";
+import { erange } from "./utils";
+/**
+ * Helper function to clear all layers or specific layers from a sprite.
+ *
+ * This function is variadic, so pass as many layer IDs as you want to clear. If no specific layers
+ * are passed, it will clear every layer.
+ *
+ * Since there is no official API method to "clear" a sprite, we can work around it by setting the
+ * spritesheet to a non-existent or completely transparent file. If the path to the spritesheet does
+ * not exist, then this function might cause spurious errors to appear in the "log.txt file". To
+ * silence these errors, create a transparent 1 pixel PNG file in your mod's resources folder at the
+ * path corresponding to the "EMPTY_PNG_PATH" constant.
+ */
+export function clearSprite(sprite, ...layerIDs) {
+    if (layerIDs.length === 0) {
+        const numLayers = sprite.GetLayerCount();
+        layerIDs = erange(numLayers);
+    }
+    for (const layerID of layerIDs) {
+        sprite.ReplaceSpritesheet(layerID, EMPTY_PNG_PATH);
+    }
+    sprite.LoadGraphics();
+}
+/**
+ * Helper function that returns the number of the final frame in a particular animation for a
+ * sprite. By default, it will use the currently playing animation, but you can also specify a
+ * specific animation to check.
+ *
+ * Note that this function is bugged with the Stop Watch or the Broken Watch, since using the
+ * `Sprite.SetFrame` method will reset the internal accumulator used to slow down the playback speed
+ * of the animation. (The `PlaybackSpeed` property of the sprite is not used.) Thus, it is only safe
+ * to use this function on animations that are not slowed down by Stop Watch or Broken Watch, such
+ * as player animations.
+ */
+export function getLastFrameOfAnimation(sprite, animation) {
+    // Record the current sprite status.
+    const currentAnimation = sprite.GetAnimation();
+    const currentFrame = sprite.GetFrame();
+    // Get the final frame.
+    if (animation !== undefined && animation !== currentAnimation) {
+        sprite.SetAnimation(animation);
+    }
+    sprite.SetLastFrame();
+    const finalFrame = sprite.GetFrame();
+    // Set the sprite back to the way it was.
+    if (animation !== undefined && animation !== currentAnimation) {
+        sprite.Play(currentAnimation, true);
+    }
+    sprite.SetFrame(currentFrame);
+    return finalFrame;
+}
+/**
+ * Helper function to check if two sprite layers have the same sprite sheet by using the
+ * `Sprite.GetTexel` method.
+ *
+ * Since checking every single texel in the entire sprite is very expensive, this function requires
+ * that you provide a range of specific texels to check.
+ */
+export function spriteEquals(sprite1, sprite2, layerID, xStart, xFinish, xIncrement, yStart, yFinish, yIncrement) {
+    // Iterate over N texels, checking for equality at each step. The center of the sprite is equal to
+    // the "pivot" point in the anm2 file.
+    for (let x = xStart; x <= xFinish; x += xIncrement) {
+        for (let y = yStart; y <= yFinish; y += yIncrement) {
+            const position = Vector(x, y);
+            if (!texelEquals(sprite1, sprite2, position, layerID)) {
+                return false;
+            }
+        }
+    }
+    return true;
+}
+/** Helper function to check if two texels on a sprite are equivalent to each other. */
+export function texelEquals(sprite1, sprite2, position, layerID) {
+    const kColor1 = sprite1.GetTexel(position, VectorZero, 1, layerID);
+    const kColor2 = sprite2.GetTexel(position, VectorZero, 1, layerID);
+    return kColorEquals(kColor1, kColor2);
+}
+//# sourceMappingURL=sprite.js.map

package/dist/functions/sprite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sprite.js","sourceRoot":"../src/","sources":["functions/sprite.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,WAAW,CAAC,MAAc,EAAE,GAAG,QAAe;IAC5D,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;QACzB,MAAM,SAAS,GAAG,MAAM,CAAC,aAAa,EAAE,CAAC;QACzC,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;KAC9B;IAED,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;QAC9B,MAAM,CAAC,kBAAkB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;KACpD;IAED,MAAM,CAAC,YAAY,EAAE,CAAC;AACxB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,uBAAuB,CACrC,MAAc,EACd,SAAkB;IAElB,oCAAoC;IACpC,MAAM,gBAAgB,GAAG,MAAM,CAAC,YAAY,EAAE,CAAC;IAC/C,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;IAEvC,uBAAuB;IACvB,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,gBAAgB,EAAE;QAC7D,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;KAChC;IACD,MAAM,CAAC,YAAY,EAAE,CAAC;IACtB,MAAM,UAAU,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;IAErC,yCAAyC;IACzC,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,gBAAgB,EAAE;QAC7D,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;KACrC;IACD,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IAE9B,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAC1B,OAAe,EACf,OAAe,EACf,OAAY,EACZ,MAAW,EACX,OAAY,EACZ,UAAe,EACf,MAAW,EACX,OAAY,EACZ,UAAe;IAEf,kGAAkG;IAClG,sCAAsC;IACtC,KAAK,IAAI,CAAC,GAAG,MAAM,EAAE,CAAC,IAAI,OAAO,EAAE,CAAC,IAAI,UAAU,EAAE;QAClD,KAAK,IAAI,CAAC,GAAG,MAAM,EAAE,CAAC,IAAI,OAAO,EAAE,CAAC,IAAI,UAAU,EAAE;YAClD,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAC9B,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE;gBACrD,OAAO,KAAK,CAAC;aACd;SACF;KACF;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,uFAAuF;AACvF,MAAM,UAAU,WAAW,CACzB,OAAe,EACf,OAAe,EACf,QAAgB,EAChB,OAAY;IAEZ,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,UAAU,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IACnE,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,UAAU,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IACnE,OAAO,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AACxC,CAAC"}

package/dist/functions/sprite.lua

@@ -0,0 +1,89 @@
+local ____exports = {}
+local ____constants = require("constants")
+local EMPTY_PNG_PATH = ____constants.EMPTY_PNG_PATH
+local VectorZero = ____constants.VectorZero
+local ____kColor = require("functions.kColor")
+local kColorEquals = ____kColor.kColorEquals
+local ____utils = require("functions.utils")
+local erange = ____utils.erange
+--- Helper function to check if two texels on a sprite are equivalent to each other.
+function ____exports.texelEquals(self, sprite1, sprite2, position, layerID)
+    local kColor1 = sprite1:GetTexel(position, VectorZero, 1, layerID)
+    local kColor2 = sprite2:GetTexel(position, VectorZero, 1, layerID)
+    return kColorEquals(nil, kColor1, kColor2)
+end
+--- Helper function to clear all layers or specific layers from a sprite.
+-- 
+-- This function is variadic, so pass as many layer IDs as you want to clear. If no specific layers
+-- are passed, it will clear every layer.
+-- 
+-- Since there is no official API method to "clear" a sprite, we can work around it by setting the
+-- spritesheet to a non-existent or completely transparent file. If the path to the spritesheet does
+-- not exist, then this function might cause spurious errors to appear in the "log.txt file". To
+-- silence these errors, create a transparent 1 pixel PNG file in your mod's resources folder at the
+-- path corresponding to the "EMPTY_PNG_PATH" constant.
+function ____exports.clearSprite(self, sprite, ...)
+    local layerIDs = {...}
+    if #layerIDs == 0 then
+        local numLayers = sprite:GetLayerCount()
+        layerIDs = erange(nil, numLayers)
+    end
+    for ____, layerID in ipairs(layerIDs) do
+        sprite:ReplaceSpritesheet(layerID, EMPTY_PNG_PATH)
+    end
+    sprite:LoadGraphics()
+end
+--- Helper function that returns the number of the final frame in a particular animation for a
+-- sprite. By default, it will use the currently playing animation, but you can also specify a
+-- specific animation to check.
+-- 
+-- Note that this function is bugged with the Stop Watch or the Broken Watch, since using the
+-- `Sprite.SetFrame` method will reset the internal accumulator used to slow down the playback speed
+-- of the animation. (The `PlaybackSpeed` property of the sprite is not used.) Thus, it is only safe
+-- to use this function on animations that are not slowed down by Stop Watch or Broken Watch, such
+-- as player animations.
+function ____exports.getLastFrameOfAnimation(self, sprite, animation)
+    local currentAnimation = sprite:GetAnimation()
+    local currentFrame = sprite:GetFrame()
+    if animation ~= nil and animation ~= currentAnimation then
+        sprite:SetAnimation(animation)
+    end
+    sprite:SetLastFrame()
+    local finalFrame = sprite:GetFrame()
+    if animation ~= nil and animation ~= currentAnimation then
+        sprite:Play(currentAnimation, true)
+    end
+    sprite:SetFrame(currentFrame)
+    return finalFrame
+end
+--- Helper function to check if two sprite layers have the same sprite sheet by using the
+-- `Sprite.GetTexel` method.
+-- 
+-- Since checking every single texel in the entire sprite is very expensive, this function requires
+-- that you provide a range of specific texels to check.
+function ____exports.spriteEquals(self, sprite1, sprite2, layerID, xStart, xFinish, xIncrement, yStart, yFinish, yIncrement)
+    do
+        local x = xStart
+        while x <= xFinish do
+            do
+                local y = yStart
+                while y <= yFinish do
+                    local position = Vector(x, y)
+                    if not ____exports.texelEquals(
+                        nil,
+                        sprite1,
+                        sprite2,
+                        position,
+                        layerID
+                    ) then
+                        return false
+                    end
+                    y = y + yIncrement
+                end
+            end
+            x = x + xIncrement
+        end
+    end
+    return true
+end
+return ____exports

package/dist/functions/sprite.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/sprite.ts"],"names":[],"mappings":";AAAA,sBAA2C;AAAlC;AAAgB;AACzB,mBAA6B;AAApB;AACT,kBAAuB;AAAd;;AA+FT,uCACE,SACA,SACA,UACA;AAEM,oBAAU,QAAQ,SAAS,UAAU,YAAY,GAAG;AACpD,oBAAU,QAAQ,SAAS,UAAU,YAAY,GAAG;AAC1D,WAAO,kBAAa,SAAS;AAR/B;;;;;;;;;;;AAjFA,uCAA4B;UAAmB;OACzC,aAAoB;AAChB,0BAAY,OAAO;AACzB,mBAAW,YAAO;;AAGpB,cAAW,kBAAW;QACpB,OAAO,mBAAmB,SAAS;;IAGrC,OAAO;AAVT;;;;;;;;;;AAwBA,mDACE,QACA;AAGM,6BAAmB,OAAO;AAC1B,yBAAe,OAAO;OAGxB,qBAA2B,aAAc;QAC3C,OAAO,aAAa;;IAEtB,OAAO;AACD,uBAAa,OAAO;OAGtB,qBAA2B,aAAc;QAC3C,OAAO,KAAK,kBAAkB;;IAEhC,OAAO,SAAS;AAEhB,WAAO;AArBT;;;;;;AA+BA,wCACE,SACA,SACA,SACA,QACA,SACA,YACA,QACA,SACA;;AAIS,kBAAI;cAAQ,KAAK;;AACf,0BAAI;sBAAQ,KAAK;AAClB,qCAAW,OAAO,GAAG;2BACtB;;wBAAY;wBAAS;wBAAS;wBAAU;;AAC3C,+BAAO;;AAHwB,4BAAK;;;AADP,oBAAK;;;AASxC,WAAO;AAtBT","file":"sprite.lua","sourceRoot":"../src/"}

package/dist/functions/stage.js

@@ -0,0 +1,172 @@
+import { LevelStage, StageType } from "isaac-typescript-definitions";
+import { game } from "../cachedClasses";
+import { ROOM_TYPE_GOTO_PREFIXES } from "../objects/roomTypeGotoPrefixes";
+import { STAGE_TYPE_SUFFIXES } from "../objects/stageTypeSuffixes";
+import { STAGE_TYPE_TO_LETTER } from "../objects/stageTypeToLetter";
+/**
+ * Helper function that calculates what the stage type should be for the provided stage. This
+ * emulates what the game's internal code does.
+ */
+export function calculateStageType(stage) {
+    // The following is the game's internal code to determine the floor type. (This came directly from
+    // Spider.)
+    /*
+      u32 Seed = g_Game->GetSeeds().GetStageSeed(NextStage);
+      if (!g_Game->IsGreedMode()) {
+        StageType = ((Seed % 2) == 0 && (
+          ((NextStage == STAGE1_1 || NextStage == STAGE1_2) && gd.Unlocked(ACHIEVEMENT_CELLAR)) ||
+          ((NextStage == STAGE2_1 || NextStage == STAGE2_2) && gd.Unlocked(ACHIEVEMENT_CATACOMBS)) ||
+          ((NextStage == STAGE3_1 || NextStage == STAGE3_2) && gd.Unlocked(ACHIEVEMENT_NECROPOLIS)) ||
+          ((NextStage == STAGE4_1 || NextStage == STAGE4_2)))
+        ) ? STAGE_TYPE_WOTL : STAGE_TYPE_ORIGINAL;
+      if (Seed % 3 == 0 && NextStage < STAGE5)
+        StageType = STAGE_TYPE_AFTERBIRTH;
+    */
+    const seeds = game.GetSeeds();
+    const stageSeed = seeds.GetStageSeed(stage);
+    if (stageSeed % 2 === 0) {
+        return StageType.WRATH_OF_THE_LAMB;
+    }
+    if (stageSeed % 3 === 0) {
+        return StageType.AFTERBIRTH;
+    }
+    return StageType.ORIGINAL;
+}
+/**
+ * Helper function that calculates what the Repentance stage type should be for the provided stage.
+ * This emulates what the game's internal code does.
+ */
+export function calculateStageTypeRepentance(stage) {
+    // There is no alternate floor for Corpse.
+    if (stage === LevelStage.WOMB_1 || stage === LevelStage.WOMB_2) {
+        return StageType.REPENTANCE;
+    }
+    // This algorithm is from Kilburn. We add one because the alt path is offset by 1 relative to the
+    // normal path.
+    const seeds = game.GetSeeds();
+    const adjustedStage = (stage + 1);
+    const stageSeed = seeds.GetStageSeed(adjustedStage);
+    // Kilburn does not know why he divided the stage seed by 2 first.
+    const halfStageSeed = Math.floor(stageSeed / 2);
+    if (halfStageSeed % 2 === 0) {
+        return StageType.REPENTANCE_B;
+    }
+    return StageType.REPENTANCE;
+}
+/**
+ * Helper function to account for Repentance floors being offset by 1. For example, Downpour 2 is
+ * the third level of the run, but the game considers it to have a stage of 2. This function will
+ * consider Downpour 2 to have a stage of 3.
+ */
+export function getEffectiveStage() {
+    const level = game.GetLevel();
+    const stage = level.GetStage();
+    if (onRepentanceStage()) {
+        return stage + 1; // eslint-disable-line isaacscript/strict-enums
+    }
+    return stage;
+}
+/**
+ * Helper function to get the corresponding "goto" console command that would correspond to the
+ * provided room type and room variant.
+ */
+export function getGotoCommand(roomType, roomVariant) {
+    const prefix = ROOM_TYPE_GOTO_PREFIXES[roomType];
+    return `goto ${prefix}.${roomVariant}`;
+}
+/** Alias for the `Level.GetStage` method. */
+export function getStage() {
+    const level = game.GetLevel();
+    return level.GetStage();
+}
+/** Alias for the `Level.GetStageType` method. */
+export function getStageType() {
+    const level = game.GetLevel();
+    return level.GetStageType();
+}
+/** Helper function to directly warp to a specific stage using the "stage" console command. */
+export function goToStage(stage, stageType) {
+    const stageTypeLetterSuffix = stageTypeToLetter(stageType);
+    const command = `stage ${stage}${stageTypeLetterSuffix}`;
+    Isaac.ExecuteCommand(command);
+}
+export function isRepentanceStage(stageType) {
+    return (stageType === StageType.REPENTANCE || stageType === StageType.REPENTANCE_B);
+}
+export function onCathedral() {
+    const level = game.GetLevel();
+    const stage = level.GetStage();
+    const stageType = level.GetStageType();
+    return (stage === LevelStage.SHEOL_CATHEDRAL &&
+        stageType === StageType.WRATH_OF_THE_LAMB);
+}
+export function onChest() {
+    const level = game.GetLevel();
+    const stage = level.GetStage();
+    const stageType = level.GetStageType();
+    return (stage === LevelStage.DARK_ROOM_CHEST &&
+        stageType === StageType.WRATH_OF_THE_LAMB);
+}
+export function onDarkRoom() {
+    const level = game.GetLevel();
+    const stage = level.GetStage();
+    const stageType = level.GetStageType();
+    return (stage === LevelStage.DARK_ROOM_CHEST && stageType === StageType.ORIGINAL);
+}
+/**
+ * Returns whether or not the player is on the "final floor" of the particular run. The final floor
+ * is defined as one that prevents the player from entering the I AM ERROR room on.
+ *
+ * For example, when using Undefined on The Chest, it has a 50% chance of teleporting the player to
+ * the Secret Room and a 50% chance of teleporting the player to the Super Secret Room, because the
+ * I AM ERROR room is never entered into the list of possibilities.
+ */
+export function onFinalFloor() {
+    const level = game.GetLevel();
+    const stage = level.GetStage();
+    return (stage === LevelStage.DARK_ROOM_CHEST ||
+        stage === LevelStage.THE_VOID ||
+        stage === LevelStage.HOME ||
+        (stage === LevelStage.WOMB_2 && onRepentanceStage()) // Corpse 2
+    );
+}
+export function onRepentanceStage() {
+    const level = game.GetLevel();
+    const stageType = level.GetStageType();
+    return isRepentanceStage(stageType);
+}
+export function onSheol() {
+    const level = game.GetLevel();
+    const stage = level.GetStage();
+    const stageType = level.GetStageType();
+    return (stage === LevelStage.SHEOL_CATHEDRAL && stageType === StageType.ORIGINAL);
+}
+/**
+ * Helper function to warp to a new stage/level.
+ *
+ * @param stage The stage number to warp to.
+ * @param stageType The stage type to warp to.
+ * @param reseed Optional. Whether or not to reseed the floor upon arrival. Default is false. Set
+ *               this to true if you are warping to the same stage but a different stage type (or
+ *               else the floor layout will be identical to the old floor).
+ */
+export function setStage(stage, stageType, reseed = false) {
+    // Build the command that will take us to the next floor.
+    const stageTypeSuffix = STAGE_TYPE_SUFFIXES[stageType];
+    const command = `stage ${stage}${stageTypeSuffix}`;
+    Isaac.ExecuteCommand(command);
+    if (reseed) {
+        // Doing a "reseed" immediately after a "stage" command won't mess anything up.
+        Isaac.ExecuteCommand("reseed");
+    }
+}
+/**
+ * Helper function to convert a numerical `StageType` into the letter suffix supplied to the "stage"
+ * console command. For example, `StageType.REPENTANCE` is the stage type for Downpour, and the
+ * console command to go to Downpour is "stage 1c", so this function converts `StageType.REPENTANCE`
+ * to "c".
+ */
+export function stageTypeToLetter(stageType) {
+    return STAGE_TYPE_TO_LETTER[stageType];
+}
+//# sourceMappingURL=stage.js.map

package/dist/functions/stage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stage.js","sourceRoot":"../src/","sources":["functions/stage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAY,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAC/E,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AAEpE;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAiB;IAClD,kGAAkG;IAClG,WAAW;IAEX;;;;;;;;;;;MAWE;IAEF,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC9B,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAE5C,IAAI,SAAS,GAAG,CAAC,KAAK,CAAC,EAAE;QACvB,OAAO,SAAS,CAAC,iBAAiB,CAAC;KACpC;IAED,IAAI,SAAS,GAAG,CAAC,KAAK,CAAC,EAAE;QACvB,OAAO,SAAS,CAAC,UAAU,CAAC;KAC7B;IAED,OAAO,SAAS,CAAC,QAAQ,CAAC;AAC5B,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,4BAA4B,CAAC,KAAiB;IAC5D,0CAA0C;IAC1C,IAAI,KAAK,KAAK,UAAU,CAAC,MAAM,IAAI,KAAK,KAAK,UAAU,CAAC,MAAM,EAAE;QAC9D,OAAO,SAAS,CAAC,UAAU,CAAC;KAC7B;IAED,iGAAiG;IACjG,eAAe;IACf,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC9B,MAAM,aAAa,GAAG,CAAE,KAAa,GAAG,CAAC,CAAe,CAAC;IACzD,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;IAEpD,kEAAkE;IAClE,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;IAChD,IAAI,aAAa,GAAG,CAAC,KAAK,CAAC,EAAE;QAC3B,OAAO,SAAS,CAAC,YAAY,CAAC;KAC/B;IAED,OAAO,SAAS,CAAC,UAAU,CAAC;AAC9B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB;IAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC9B,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;IAE/B,IAAI,iBAAiB,EAAE,EAAE;QACvB,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,+CAA+C;KAClE;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,QAAkB,EAAE,WAAgB;IACjE,MAAM,MAAM,GAAG,uBAAuB,CAAC,QAAQ,CAAC,CAAC;IACjD,OAAO,QAAQ,MAAM,IAAI,WAAW,EAAE,CAAC;AACzC,CAAC;AAED,6CAA6C;AAC7C,MAAM,UAAU,QAAQ;IACtB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAE9B,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;AAC1B,CAAC;AAED,iDAAiD;AACjD,MAAM,UAAU,YAAY;IAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAE9B,OAAO,KAAK,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC;AAED,8FAA8F;AAC9F,MAAM,UAAU,SAAS,CAAC,KAAiB,EAAE,SAAoB;IAC/D,MAAM,qBAAqB,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAC3D,MAAM,OAAO,GAAG,SAAS,KAAK,GAAG,qBAAqB,EAAE,CAAC;IACzD,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,SAAoB;IACpD,OAAO,CACL,SAAS,KAAK,SAAS,CAAC,UAAU,IAAI,SAAS,KAAK,SAAS,CAAC,YAAY,CAC3E,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,WAAW;IACzB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC9B,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;IAC/B,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC;IAEvC,OAAO,CACL,KAAK,KAAK,UAAU,CAAC,eAAe;QACpC,SAAS,KAAK,SAAS,CAAC,iBAAiB,CAC1C,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,OAAO;IACrB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC9B,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;IAC/B,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC;IAEvC,OAAO,CACL,KAAK,KAAK,UAAU,CAAC,eAAe;QACpC,SAAS,KAAK,SAAS,CAAC,iBAAiB,CAC1C,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,UAAU;IACxB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC9B,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;IAC/B,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC;IAEvC,OAAO,CACL,KAAK,KAAK,UAAU,CAAC,eAAe,IAAI,SAAS,KAAK,SAAS,CAAC,QAAQ,CACzE,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY;IAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC9B,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;IAE/B,OAAO,CACL,KAAK,KAAK,UAAU,CAAC,eAAe;QACpC,KAAK,KAAK,UAAU,CAAC,QAAQ;QAC7B,KAAK,KAAK,UAAU,CAAC,IAAI;QACzB,CAAC,KAAK,KAAK,UAAU,CAAC,MAAM,IAAI,iBAAiB,EAAE,CAAC,CAAC,WAAW;KACjE,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iBAAiB;IAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC9B,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC;IAEvC,OAAO,iBAAiB,CAAC,SAAS,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,OAAO;IACrB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC9B,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;IAC/B,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC;IAEvC,OAAO,CACL,KAAK,KAAK,UAAU,CAAC,eAAe,IAAI,SAAS,KAAK,SAAS,CAAC,QAAQ,CACzE,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,QAAQ,CACtB,KAAiB,EACjB,SAAoB,EACpB,MAAM,GAAG,KAAK;IAEd,yDAAyD;IACzD,MAAM,eAAe,GAAG,mBAAmB,CAAC,SAAS,CAAC,CAAC;IACvD,MAAM,OAAO,GAAG,SAAS,KAAK,GAAG,eAAe,EAAE,CAAC;IACnD,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAE9B,IAAI,MAAM,EAAE;QACV,+EAA+E;QAC/E,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;KAChC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,SAAoB;IACpD,OAAO,oBAAoB,CAAC,SAAS,CAAC,CAAC;AACzC,CAAC"}