isaacscript-common 13.3.4 → 14.1.0

package/src/functions/charge.ts

@@ -25,7 +25,7 @@ import { getRoomShapeCharges } from "./roomShape";
  * - AAA Battery
  *
  * @param player The player to grant the charges to.
- * @param activeSlot The slot to grant the charges to.
+ * @param activeSlot Optional. The slot to grant the charges to. Default is `ActiveSlot.PRIMARY`.
  * @param numCharges Optional. The amount of charges to grant. Default is 1.
  * @param playSoundEffect Optional. Whether to play a charge-related sound effect. Default is true.
  * @returns The amount of charges that were actually granted. For example, if the active item was
@@ -34,7 +34,7 @@ import { getRoomShapeCharges } from "./roomShape";
  */
 export function addCharge(
   player: EntityPlayer,
-  activeSlot: ActiveSlot,
+  activeSlot = ActiveSlot.PRIMARY,
   numCharges = 1,
   playSoundEffect = true,
 ): int {
@@ -116,7 +116,8 @@ export function addRoomClearCharge(
  * - Not charging active items with `chargetype="special"`
  *
  * @param player The player to grant the charges to.
- * @param activeSlot The active item slot to grant the charges to.
+ * @param activeSlot Optional. The active item slot to grant the charges to. Default is
+ *                   `ActiveSlot.PRIMARY`.
  * @param bigRoomDoubleCharge Optional. If set to false, it will treat the current room as a 1x1
  *                            room for the purposes of calculating how much charge to grant. Default
  *                            is true.
@@ -124,7 +125,7 @@ export function addRoomClearCharge(
  */
 export function addRoomClearChargeToSlot(
   player: EntityPlayer,
-  activeSlot: ActiveSlot,
+  activeSlot = ActiveSlot.PRIMARY,
   bigRoomDoubleCharge = true,
   playSoundEffect = true,
 ): void {
@@ -202,10 +203,13 @@ export function addRoomClearCharges(bigRoomDoubleCharge = true): void {
  * This function accounts for The Battery. For example, if the player has 2/6 charges on a D6, this
  * function will return 10 (because there are 4 charges remaining on the base charge and 6 charges
  * remaining on The Battery charge).
+ *
+ * @param player The player to get the charges from.
+ * @param activeSlot Optional. The slot to get the charges from. Default is `ActiveSlot.PRIMARY`.
  */
 export function getChargesAwayFromMax(
   player: EntityPlayer,
-  activeSlot: ActiveSlot,
+  activeSlot = ActiveSlot.PRIMARY,
 ): int {
   const totalCharge = getTotalCharge(player, activeSlot);
   const activeItem = player.GetActiveItem(activeSlot);
@@ -220,10 +224,13 @@ export function getChargesAwayFromMax(
  * Helper function to get the combined normal charge and the battery charge for the player's active
  * item. This is useful because you have to add these two values together when setting the active
  * charge.
+ *
+ * @param player The player to get the charges from.
+ * @param activeSlot Optional. The slot to get the charges from. Default is `ActiveSlot.PRIMARY`.
  */
 export function getTotalCharge(
   player: EntityPlayer,
-  activeSlot: ActiveSlot,
+  activeSlot = ActiveSlot.PRIMARY,
 ): int {
   const activeCharge = player.GetActiveCharge(activeSlot);
   const batteryCharge = player.GetBatteryCharge(activeSlot);
@@ -231,9 +238,16 @@ export function getTotalCharge(
   return activeCharge + batteryCharge;
 }
 
+/**
+ * Helper function to check if a player's active item is "double charged", meaning that it has both
+ * a full normal charge and a full charge from The Battery.
+ *
+ * @param player The player to check.
+ * @param activeSlot Optional. The slot to check. Default is `ActiveSlot.PRIMARY`.
+ */
 export function isActiveSlotDoubleCharged(
   player: EntityPlayer,
-  activeSlot: ActiveSlot,
+  activeSlot = ActiveSlot.PRIMARY,
 ): boolean {
   const collectibleType = player.GetActiveItem(activeSlot);
   const batteryCharge = player.GetBatteryCharge(activeSlot);
@@ -242,9 +256,17 @@ export function isActiveSlotDoubleCharged(
   return batteryCharge >= maxCharges;
 }
 
+/**
+ * Helper function to play the appropriate sound effect for a player after getting one or more
+ * charges on their active item. (There is a different sound depending on whether the item is fully
+ * charged or not.)
+ *
+ * @param player The player to play the sound effect for.
+ * @param activeSlot Optional. The slot that was just charged. Default is `ActiveSlot.PRIMARY`.
+ */
 export function playChargeSoundEffect(
   player: EntityPlayer,
-  activeSlot: ActiveSlot,
+  activeSlot = ActiveSlot.PRIMARY,
 ): void {
   for (const soundEffect of [
     SoundEffect.BATTERY_CHARGE, // 170

package/src/functions/chargeBar.ts

@@ -5,6 +5,9 @@ const CHARGE_BAR_ANM2 = "gfx/ui/ui_chargebar.anm2";
 /**
  * Constructor for a `ChargeBarSprites` object. For more information, see the `renderChargeBar`
  * helper function.
+ *
+ * Note that this is for the vertical charge bar that represents the number of charges that an
+ * active item has, not the circular charge bar that shows e.g. the charge rate of Brimstone.
  */
 export function newChargeBarSprites(maxCharges: int): ChargeBarSprites {
   const back = Sprite();
@@ -35,6 +38,9 @@ export function newChargeBarSprites(maxCharges: int): ChargeBarSprites {
 /**
  * Helper function to render a charge bar on the screen. First, call the `newChargeBarSprites`
  * function to initialize the sprites, and then call this function on every render frame.
+ *
+ * Note that this is for the vertical charge bar that represents the number of charges that an
+ * active item has, not the circular charge bar that shows e.g. the charge rate of Brimstone.
  */
 export function renderChargeBar(
   sprites: ChargeBarSprites,

package/src/functions/decorators.ts

@@ -0,0 +1,45 @@
+import { ModCallback } from "isaac-typescript-definitions";
+import { ModFeature } from "../classes/ModFeature";
+import { ModUpgraded } from "../classes/ModUpgraded";
+import { ModCallbackCustom2 } from "../enums/ModCallbackCustom2";
+import { AddCallbackParametersCustom2 } from "../interfaces/private/AddCallbackParametersCustom2";
+import { AllButFirst } from "../types/AllButFirst";
+
+/**
+ * A decorator function that signifies that the decorated class method should be automatically
+ * registered with `Mod.AddCallback`.
+ */
+export function Callback<T extends ModCallback>(
+  modCallback: T,
+  ...optionalArgs: AllButFirst<AddCallbackParameters[T]>
+) {
+  return <Class extends ModFeature, Fn extends AddCallbackParameters[T][0]>(
+    target: Class,
+    propertyKey: string,
+    _descriptor: TypedPropertyDescriptor<Fn>,
+  ): void => {
+    const methodName = propertyKey as keyof Class;
+    const method = target[methodName] as AddCallbackParameters[T][0];
+    // @ts-expect-error The compiler is not smart enough to join the types together.
+    target.mod.AddCallback(modCallback, method, ...optionalArgs);
+  };
+}
+
+/**
+ * A decorator function that signifies that the decorated class method should be automatically
+ * registered with `ModUpgraded.AddCallbackCustom`.
+ */
+export function CallbackCustom<T extends ModCallbackCustom2>(
+  modCallbackCustom: T,
+  ...optionalArgs: AllButFirst<AddCallbackParametersCustom2[T]>
+) {
+  return <Class extends { mod: ModUpgraded }>(
+    target: Class,
+    propertyKey: string,
+  ): void => {
+    const methodName = propertyKey as keyof Class;
+    const method = target[methodName] as AddCallbackParametersCustom2[T][0];
+    // @ts-expect-error The compiler is not smart enough to join the types together.
+    target.mod.AddCallbackCustom2(modCallbackCustom, method, ...optionalArgs);
+  };
+}

package/src/functions/flying.ts

@@ -10,11 +10,11 @@ import { copySet, deleteSetsFromSet } from "./set";
 
 const FLYING_CHARACTERS: ReadonlySet<PlayerType> = new Set([
   PlayerType.AZAZEL, // 7
-  PlayerType.THE_LOST, // 10
-  PlayerType.THE_SOUL, // 17
-  PlayerType.THE_LOST_B, // 31
+  PlayerType.LOST, // 10
+  PlayerType.SOUL, // 17
+  PlayerType.LOST_B, // 31
   PlayerType.JACOB_2_B, // 39
-  PlayerType.THE_SOUL_B, // 40
+  PlayerType.SOUL_B, // 40
 ]);
 
 const FLYING_TRINKETS: ReadonlySet<TrinketType> = new Set([

package/src/functions/gridEntities.ts

@@ -63,7 +63,7 @@ export function convertXMLGridEntityType(
     );
   }
   const gridEntityType = gridEntityArray[0];
-  let gridEntityVariant = gridEntityArray[1];
+  let variant = gridEntityArray[1];
 
   // For some specific grid entities, the variant defined in the XML is what is used by the actual
   // game (which is not the case for e.g. poops).
@@ -72,10 +72,10 @@ export function convertXMLGridEntityType(
     gridEntityType === GridEntityType.PRESSURE_PLATE || // 20
     gridEntityType === GridEntityType.TELEPORTER // 23
   ) {
-    gridEntityVariant = gridEntityXMLVariant;
+    variant = gridEntityXMLVariant;
   }
 
-  return [gridEntityType, gridEntityVariant];
+  return [gridEntityType, variant];
 }
 
 /**
@@ -323,8 +323,8 @@ export function isGridEntityBreakableByExplosion(
   gridEntity: GridEntity,
 ): boolean {
   const gridEntityType = gridEntity.GetType();
-  const gridEntityVariant = gridEntity.GetVariant();
-  const gridEntityTypeVariant = `${gridEntityType}.${gridEntityVariant}`;
+  const variant = gridEntity.GetVariant();
+  const gridEntityTypeVariant = `${gridEntityType}.${variant}`;
 
   return (
     BREAKABLE_GRID_ENTITY_TYPES_BY_EXPLOSIONS.has(gridEntityType) ||

package/src/functions/gridEntitiesSpecific.ts

@@ -47,8 +47,8 @@ export function getPits(pitVariant: PitVariant = -1): GridEntityPit[] {
   for (const gridEntity of getGridEntities()) {
     const pit = gridEntity.ToPit();
     if (pit !== undefined) {
-      const gridEntityVariant = pit.GetVariant();
-      if (asNumber(pitVariant) === -1 || pitVariant === gridEntityVariant) {
+      const thisPitVariant = pit.GetVariant();
+      if (asNumber(pitVariant) === -1 || pitVariant === thisPitVariant) {
         pits.push(pit);
       }
     }
@@ -70,8 +70,8 @@ export function getPoops(
   for (const gridEntity of getGridEntities()) {
     const poop = gridEntity.ToPoop();
     if (poop !== undefined) {
-      const gridEntityVariant = poop.GetVariant();
-      if (asNumber(poopVariant) === -1 || poopVariant === gridEntityVariant) {
+      const thisPoopVariant = poop.GetVariant();
+      if (asNumber(poopVariant) === -1 || poopVariant === thisPoopVariant) {
         poops.push(poop);
       }
     }
@@ -93,10 +93,10 @@ export function getPressurePlates(
   for (const gridEntity of getGridEntities()) {
     const pressurePlate = gridEntity.ToPressurePlate();
     if (pressurePlate !== undefined) {
-      const gridEntityVariant = pressurePlate.GetVariant();
+      const thisPressurePlateVariant = pressurePlate.GetVariant();
       if (
         asNumber(pressurePlateVariant) === -1 ||
-        pressurePlateVariant === gridEntityVariant
+        pressurePlateVariant === thisPressurePlateVariant
       ) {
         pressurePlates.push(pressurePlate);
       }
@@ -119,8 +119,8 @@ export function getRocks(variant = -1): GridEntityRock[] {
   for (const gridEntity of getGridEntities()) {
     const rock = gridEntity.ToRock();
     if (rock !== undefined) {
-      const gridEntityVariant = rock.GetVariant();
-      if (variant === -1 || variant === gridEntityVariant) {
+      const thisVariant = rock.GetVariant();
+      if (variant === -1 || variant === thisVariant) {
         rocks.push(rock);
       }
     }
@@ -135,8 +135,8 @@ export function getSpikes(variant = -1): GridEntitySpikes[] {
   for (const gridEntity of getGridEntities()) {
     const spike = gridEntity.ToSpikes();
     if (spike !== undefined) {
-      const gridEntityVariant = spike.GetVariant();
-      if (variant === -1 || variant === gridEntityVariant) {
+      const thisVariant = spike.GetVariant();
+      if (variant === -1 || variant === thisVariant) {
         spikes.push(spike);
       }
     }
@@ -151,8 +151,8 @@ export function getTNT(variant = -1): GridEntityTNT[] {
   for (const gridEntity of getGridEntities()) {
     const tnt = gridEntity.ToTNT();
     if (tnt !== undefined) {
-      const gridEntityVariant = tnt.GetVariant();
-      if (variant === -1 || variant === gridEntityVariant) {
+      const thisVariant = tnt.GetVariant();
+      if (variant === -1 || variant === thisVariant) {
         tntArray.push(tnt);
       }
     }

package/src/functions/itemPool.ts

@@ -61,7 +61,7 @@ export function isCollectibleInItemPool(
 
   // On Tainted Lost, it is impossible to retrieve non-offensive collectibles from pools, so we
   // temporarily change the character to Isaac.
-  const taintedLosts = getPlayersOfType(PlayerType.THE_LOST_B);
+  const taintedLosts = getPlayersOfType(PlayerType.LOST_B);
   const isOffensive = collectibleHasTag(
     collectibleType,
     ItemConfigTag.OFFENSIVE,
@@ -108,7 +108,7 @@ export function isCollectibleInItemPool(
   // Change any players back to Tainted Lost, if necessary.
   if (changedPlayerTypes) {
     for (const player of taintedLosts) {
-      player.ChangePlayerType(PlayerType.THE_LOST_B);
+      player.ChangePlayerType(PlayerType.LOST_B);
     }
   }
 

package/src/functions/minimap.ts

@@ -8,6 +8,8 @@ import { getRoomsInsideGrid } from "./rooms";
  * Helper function to add a `DisplayFlag` to a particular room's minimap display flags (e.g. whether
  * or not it is visible and so on).
  *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
+ *
  * @param roomGridIndex Set to undefined to use the current room index.
  * @param displayFlag The `DisplayFlag` to set. (See the `DisplayFlag` enum.)
  * @param updateVisibility Optional. Whether to call the `Level.UpdateVisibility` method in order to
@@ -97,6 +99,8 @@ export function getRoomDisplayFlags(
  * This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
  * the changes will be immediately visible.
  *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
+ *
  * @param displayFlagsMap A map of the display flags that is indexed by the room's safe grid index.
  */
 export function setDisplayFlags(

package/src/functions/playerHealth.ts

@@ -177,7 +177,7 @@ export function getPlayerHealth(player: EntityPlayer): PlayerHealth {
   const bloodCharges = player.GetEffectiveBloodCharge();
 
   // The Forgotten and The Soul has special health, so we need to account for this.
-  if (character === PlayerType.THE_FORGOTTEN && subPlayer !== undefined) {
+  if (character === PlayerType.FORGOTTEN && subPlayer !== undefined) {
     // The Forgotten does not have red heart containers.
     maxHearts = boneHearts * 2;
     boneHearts = 0;
@@ -185,7 +185,7 @@ export function getPlayerHealth(player: EntityPlayer): PlayerHealth {
     // The Forgotten will always have 0 soul hearts; we need to get the soul heart amount from the
     // sub player.
     soulHearts = subPlayer.GetSoulHearts();
-  } else if (character === PlayerType.THE_SOUL && subPlayer !== undefined) {
+  } else if (character === PlayerType.SOUL && subPlayer !== undefined) {
     // The Soul will always have 0 bone hearts; we need to get the bone heart amount from the sub
     // player. We need to store it as "maxHearts" instead of "boneHearts".
     maxHearts = subPlayer.GetBoneHearts() * 2;
@@ -202,7 +202,7 @@ export function getPlayerHealth(player: EntityPlayer): PlayerHealth {
   const soulHeartTypes: SoulHeartType[] = [];
   for (let i = 0; i < extraHearts; i++) {
     let isBoneHeart = player.IsBoneHeart(i);
-    if (character === PlayerType.THE_FORGOTTEN && subPlayer !== undefined) {
+    if (character === PlayerType.FORGOTTEN && subPlayer !== undefined) {
       isBoneHeart = subPlayer.IsBoneHeart(i);
     }
     if (isBoneHeart) {
@@ -210,7 +210,7 @@ export function getPlayerHealth(player: EntityPlayer): PlayerHealth {
     } else {
       // We need to add 1 here because only the second half of a black heart is considered black.
       let isBlackHeart = player.IsBlackHeart(currentSoulHeart + 1);
-      if (character === PlayerType.THE_FORGOTTEN && subPlayer !== undefined) {
+      if (character === PlayerType.FORGOTTEN && subPlayer !== undefined) {
         isBlackHeart = subPlayer.IsBlackHeart(currentSoulHeart + 1);
       }
       if (isBlackHeart) {
@@ -520,7 +520,7 @@ export function removeAllPlayerHealth(player: EntityPlayer): void {
 
   // If we are The Soul, the `EntityPlayer.AddBoneHearts` method will not remove Forgotten's bone
   // hearts, so we need to explicitly handle this.
-  if (isCharacter(player, PlayerType.THE_SOUL)) {
+  if (isCharacter(player, PlayerType.SOUL)) {
     const forgotten = player.GetSubPlayer();
     if (forgotten !== undefined) {
       const forgottenBoneHearts = forgotten.GetBoneHearts();
@@ -559,7 +559,7 @@ export function setPlayerHealth(
   }
 
   // Add the red heart containers.
-  if (character === PlayerType.THE_SOUL && subPlayer !== undefined) {
+  if (character === PlayerType.SOUL && subPlayer !== undefined) {
     // Adding health to The Soul is a special case.
     subPlayer.AddMaxHearts(playerHealth.maxHearts, false);
   } else {

package/src/functions/playerIndex.ts

@@ -6,7 +6,7 @@ const DEFAULT_COLLECTIBLE_TYPE = CollectibleType.SAD_ONION;
 
 const EXCLUDED_CHARACTERS: ReadonlySet<PlayerType> = new Set([
   PlayerType.ESAU, // 20
-  PlayerType.THE_SOUL_B, // 40
+  PlayerType.SOUL_B, // 40
 ]);
 
 /**
@@ -122,7 +122,7 @@ function getPlayerIndexCollectibleType(
 ) {
   const character = player.GetPlayerType();
 
-  if (character === PlayerType.THE_SOUL) {
+  if (character === PlayerType.SOUL) {
     return differentiateForgottenAndSoul
       ? CollectibleType.INNER_EYE
       : DEFAULT_COLLECTIBLE_TYPE;

package/src/functions/players.ts

@@ -299,6 +299,21 @@ export function getPlayerFromEntity(entity: Entity): EntityPlayer | undefined {
   return entity.ToPlayer();
 }
 
+/**
+ * Helper function to get an `EntityPlayer` object from an `EntityPtr`. Returns undefined if the
+ * entity has gone out of scope or if the associated entity is not a player.
+ */
+export function getPlayerFromPtr(
+  entityPtr: EntityPtr,
+): EntityPlayer | undefined {
+  const entity = entityPtr.Ref;
+  if (entity === undefined) {
+    return undefined;
+  }
+
+  return entity.ToPlayer();
+}
+
 /**
  * Helper function to get the proper name of the player. Use this instead of the
  * `EntityPlayer.GetName` method because it accounts for Blue Baby, Lazarus II, and Tainted
@@ -442,7 +457,7 @@ export function hasLostCurse(player: EntityPlayer): boolean {
  * items. (Only Tainted Forgotten can pick up items.)
  */
 export function hasOpenActiveItemSlot(player: EntityPlayer): boolean {
-  if (isCharacter(player, PlayerType.THE_SOUL_B)) {
+  if (isCharacter(player, PlayerType.SOUL_B)) {
     return false;
   }
 
@@ -460,9 +475,15 @@ export function hasOpenActiveItemSlot(player: EntityPlayer): boolean {
   return activeItemPrimary === CollectibleType.NULL;
 }
 
+/**
+ * Helper function to check if the active slot of a particular player is empty.
+ *
+ * @param player The player to check.
+ * @param activeSlot Optional. The active slot to check. Default is `ActiveSlot.PRIMARY`.
+ */
 export function isActiveSlotEmpty(
   player: EntityPlayer,
-  activeSlot: ActiveSlot,
+  activeSlot = ActiveSlot.PRIMARY,
 ): boolean {
   const activeCollectibleType = player.GetActiveItem(activeSlot);
   return activeCollectibleType === CollectibleType.NULL;
@@ -546,9 +567,7 @@ export function isKeeper(player: EntityPlayer): boolean {
 export function isLost(player: EntityPlayer): boolean {
   const character = player.GetPlayerType();
 
-  return (
-    character === PlayerType.THE_LOST || character === PlayerType.THE_LOST_B
-  );
+  return character === PlayerType.LOST || character === PlayerType.LOST_B;
 }
 
 export function isModdedPlayer(player: EntityPlayer): boolean {
@@ -714,7 +733,7 @@ export function removeTrinketCostume(
  *
  * @param player The player to give the item to.
  * @param collectibleType The collectible type of the item to give.
- * @param activeSlot The slot to set.
+ * @param activeSlot Optional. The slot to set. Default is `ActiveSlot.PRIMARY`.
  * @param charge Optional. The argument of charges to set. If not specified, the item will be set
  *               with maximum charges.
  * @param keepInPools Optional. Whether or not to remove the item from pools. Default is false.
@@ -722,7 +741,7 @@ export function removeTrinketCostume(
 export function setActiveItem(
   player: EntityPlayer,
   collectibleType: CollectibleType,
-  activeSlot: ActiveSlot,
+  activeSlot = ActiveSlot.PRIMARY,
   charge?: int,
   keepInPools = false,
 ): void {

package/src/functions/pocketItems.ts

@@ -124,7 +124,7 @@ export function getPocketItems(player: EntityPlayer): PocketItemDescription[] {
  * items. (Only Tainted Forgotten can pick up items.)
  */
 export function hasOpenPocketItemSlot(player: EntityPlayer): boolean {
-  if (isCharacter(player, PlayerType.THE_SOUL_B)) {
+  if (isCharacter(player, PlayerType.SOUL_B)) {
     return false;
   }
 

package/src/functions/roomTransition.ts

@@ -1,12 +1,9 @@
 import {
   Direction,
   DoorSlot,
-  LevelCurse,
   RoomTransitionAnim,
 } from "isaac-typescript-definitions";
 import { game } from "../core/cachedClasses";
-import { runNextRoom } from "../features/runNextRoom";
-import { hasCurse } from "./curses";
 import { getRoomData, getRoomGridIndex } from "./roomData";
 
 /**
@@ -17,12 +14,7 @@ import { getRoomData, getRoomGridIndex } from "./roomData";
  */
 export function reloadRoom(): void {
   const roomGridIndex = getRoomGridIndex();
-  teleport(
-    roomGridIndex,
-    Direction.NO_DIRECTION,
-    RoomTransitionAnim.FADE,
-    true,
-  );
+  teleport(roomGridIndex, Direction.NO_DIRECTION, RoomTransitionAnim.FADE);
 }
 
 /**
@@ -33,29 +25,20 @@ export function reloadRoom(): void {
  * Use this function instead of invoking the `Game.StartRoomTransition` method directly so that:
  * - you do not forget to set the `Level.LeaveDoor` field
  * - to prevent crashing on invalid room grid indexes
- * - to automatically handle Curse of the Maze
+ *
+ * Note that if the current floor has Curse of the Maze, it may redirect the intended teleport.
  *
  * @param roomGridIndex The room grid index of the destination room.
  * @param direction Optional. Default is `Direction.NO_DIRECTION`.
  * @param roomTransitionAnim Optional. Default is `RoomTransitionAnim.TELEPORT`.
- * @param force Optional. Whether to temporarily disable Curse of the Maze. Default is false. If set
- *              to false, then this function may not go to the provided room grid index.
  */
 export function teleport(
   roomGridIndex: int,
   direction = Direction.NO_DIRECTION,
   roomTransitionAnim = RoomTransitionAnim.TELEPORT,
-  force = false,
 ): void {
   const level = game.GetLevel();
 
-  // Before starting a room transition, we must ensure that Curse of the Maze is not in effect, or
-  // else the room transition might send us to the wrong room.
-  const shouldTempDisableCurse = force && hasCurse(LevelCurse.MAZE);
-  if (shouldTempDisableCurse) {
-    level.RemoveCurses(LevelCurse.MAZE);
-  }
-
   const roomData = getRoomData(roomGridIndex);
   if (roomData === undefined) {
     error(
@@ -68,11 +51,4 @@ export function teleport(
   level.LeaveDoor = DoorSlot.NO_DOOR_SLOT;
 
   game.StartRoomTransition(roomGridIndex, direction, roomTransitionAnim);
-
-  if (shouldTempDisableCurse) {
-    runNextRoom(() => {
-      const futureLevel = game.GetLevel();
-      futureLevel.AddCurse(LevelCurse.MAZE, false);
-    });
-  }
 }

package/src/functions/rooms.ts

@@ -546,7 +546,7 @@ export function roomUpdateSafe(): void {
   setEntityVelocities(entityVelocities, entities);
 }
 
-/** Helper function to set the backdrop of the current room. */
+/** Helper function to set the backdrop (i.e. background) of the current room. */
 export function setBackdrop(backdropType: BackdropType): void {
   game.ShowHallucination(0, backdropType);
   sfxManager.Stop(SoundEffect.DEATH_CARD);

package/src/functions/run.ts

@@ -1,5 +1,6 @@
 import {
   Challenge,
+  Difficulty,
   PlayerType,
   SlotVariant,
 } from "isaac-typescript-definitions";
@@ -26,6 +27,17 @@ export function canRunUnlockAchievements(): boolean {
   return canUnlockAchievements;
 }
 
+/**
+ * Helper function to check if the difficulty of the current run is equal to `Difficulty.GREED` or
+ * `Difficulty.GREEDIER`.
+ */
+export function isGreedMode(): boolean {
+  return (
+    game.Difficulty === Difficulty.GREED ||
+    game.Difficulty === Difficulty.GREEDIER
+  );
+}
+
 /**
  * Whether or not the player is playing on a set seed (i.e. that they entered in a specific seed by
  * pressing tab on the character selection screen). When the player resets the game on a set seed,

package/src/functions/spawnCollectible.ts

@@ -1,8 +1,10 @@
 import {
   CollectibleType,
+  ItemPoolType,
   PickupVariant,
   PlayerType,
 } from "isaac-typescript-definitions";
+import { game } from "../core/cachedClasses";
 import { VectorZero } from "../core/constants";
 import { preventCollectibleRotation } from "../features/preventCollectibleRotation";
 import { areFeaturesInitialized } from "../featuresInitialized";
@@ -13,10 +15,11 @@ import { anyPlayerIs } from "./players";
 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.)
+ * 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.
@@ -74,6 +77,43 @@ export function spawnCollectible(
   return collectible;
 }
 
+/**
+ * Helper function to spawn a collectible from a specific item pool.
+ *
+ * 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 itemPoolType The item pool to draw the collectible type from.
+ * @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 spawnCollectibleFromPool(
+  itemPoolType: ItemPoolType,
+  position: Vector,
+  seedOrRNG: Seed | RNG = getRandomSeed(),
+  options = false,
+  forceFreeItem = false,
+  spawner?: Entity,
+): EntityPickupCollectible {
+  const itemPool = game.GetItemPool();
+  const collectibleType = itemPool.GetCollectible(itemPoolType);
+  return spawnCollectible(
+    collectibleType,
+    position,
+    seedOrRNG,
+    options,
+    forceFreeItem,
+    spawner,
+  );
+}
+
 /**
  * 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