isaacscript-common 6.17.1 → 6.20.0

package/src/features/customTrapdoor/init.ts

@@ -10,6 +10,7 @@ import { StageTravelState } from "../../enums/private/StageTravelState";
 import { movePlayersToCenter } from "../../functions/playerCenter";
 import { getAllPlayers } from "../../functions/playerIndex";
 import { getRoomGridIndex, getRoomListIndex } from "../../functions/roomData";
+import { teleport } from "../../functions/rooms";
 import { setStage } from "../../functions/stage";
 import { isString } from "../../functions/types";
 import { setCustomStage } from "../customStage/exports";
@@ -65,8 +66,10 @@ function checkAllPlayersJumpComplete() {
   v.run.stateRenderFrame = renderFrameCount;
 
   // In order to display the pixelation effect that should happen when we go to a new floor, we need
-  // to start a room transition. We arbitrarily pick the current room for this purpose.
-  game.StartRoomTransition(
+  // to start a room transition. We arbitrarily pick the current room for this purpose. (We do not
+  // have to worry about Curse of the Maze here, because even if we are taken to a different room,
+  // it will not matter, since we will be traveling to a new floor after the screen fades to black.)
+  teleport(
     roomGridIndex,
     Direction.NO_DIRECTION,
     RoomTransitionAnim.PIXELATION,
@@ -99,10 +102,11 @@ function checkPixelationToBlackComplete() {
 
   // Start another pixelation effect. This time, we will keep the screen black with the sprite, and
   // then remove the black sprite once the pixelation effect is halfway complete.
-  game.StartRoomTransition(
+  teleport(
     roomGridIndex,
     Direction.NO_DIRECTION,
     RoomTransitionAnim.PIXELATION,
+    true,
   );
 }
 

package/src/features/extraConsoleCommands/commandsSubroutines.ts

@@ -9,10 +9,11 @@ import { game } from "../../cachedClasses";
 import { HealthType } from "../../enums/HealthType";
 import { directionToVector } from "../../functions/direction";
 import { spawnGridEntityWithVariant } from "../../functions/gridEntities";
+import { getRoomGridIndexesForType } from "../../functions/levelGrid";
 import { logAllEntities, logAllGridEntities } from "../../functions/log";
 import { addPlayerHealthType } from "../../functions/playerHealth";
 import { getRoomData, getRoomDescriptor } from "../../functions/roomData";
-import { changeRoom, getRoomGridIndexesForType } from "../../functions/rooms";
+import { changeRoom } from "../../functions/rooms";
 import { printConsole } from "../../functions/utils";
 import {
   DEFAULT_ROOM_TYPE_NAME,

package/src/features/extraConsoleCommands/listCommands.ts

@@ -63,6 +63,7 @@ import { getNPCs } from "../../functions/entitiesSpecific";
 import { getEnumValues } from "../../functions/enums";
 import { addFlag } from "../../functions/flag";
 import { spawnGridEntity } from "../../functions/gridEntities";
+import { getRoomGridIndexesForType } from "../../functions/levelGrid";
 import {
   logPlayerEffects,
   logRoom,
@@ -85,7 +86,7 @@ import {
   useActiveItemTemp,
 } from "../../functions/players";
 import { gridCoordinatesToWorldPosition } from "../../functions/roomGrid";
-import { changeRoom, getRoomGridIndexesForType } from "../../functions/rooms";
+import { changeRoom } from "../../functions/rooms";
 import { onSetSeed, restart, setUnseeded } from "../../functions/run";
 import { getGoldenTrinketType } from "../../functions/trinkets";
 import { irange, printConsole, printEnabled } from "../../functions/utils";

package/src/features/playerInventory.ts

@@ -5,7 +5,7 @@ import { ModCallbackCustom } from "../enums/ModCallbackCustom";
 import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
 import { arrayRemoveInPlace, copyArray } from "../functions/array";
 import { isActiveCollectible } from "../functions/collectibles";
-import { getCollectibleSet } from "../functions/collectibleSet";
+import { getCollectibleArray } from "../functions/collectibleSet";
 import {
   defaultMapGetPlayer,
   mapSetPlayer,
@@ -30,8 +30,7 @@ const v = {
 function newPlayerInventory(player: EntityPlayer) {
   const inventory: CollectibleType[] = [];
 
-  const collectibleSet = getCollectibleSet();
-  for (const collectibleType of collectibleSet.values()) {
+  for (const collectibleType of getCollectibleArray()) {
     const numCollectibles = player.GetCollectibleNum(collectibleType, true);
     repeat(numCollectibles, () => {
       inventory.push(collectibleType);

package/src/functions/curses.ts

@@ -0,0 +1,9 @@
+import { LevelCurse } from "isaac-typescript-definitions";
+import { game } from "../cachedClasses";
+import { hasFlag } from "./flag";
+
+export function hasCurse(curse: LevelCurse): boolean {
+  const level = game.GetLevel();
+  const curses = level.GetCurses();
+  return hasFlag(curses, curse);
+}

package/src/functions/dimensions.ts

@@ -0,0 +1,41 @@
+import { Dimension } from "isaac-typescript-definitions";
+import { game } from "../cachedClasses";
+import { NUM_DIMENSIONS } from "../constants";
+import { getRoomGridIndex } from "./roomData";
+import { erange } from "./utils";
+
+/**
+ * Helper function to get an array with every valid `Dimension` (not including `Dimension.CURRENT`).
+ */
+export function getAllDimensions(): Dimension[] {
+  return erange(NUM_DIMENSIONS) as Dimension[];
+}
+
+/**
+ * Helper function to get the current dimension. Most of the time, this will be `Dimension.MAIN`,
+ * but it can change if e.g. the player is in the mirror world of Downpour/Dross.
+ */
+export function getDimension(): Dimension {
+  const level = game.GetLevel();
+  const roomGridIndex = getRoomGridIndex();
+  const roomDescription = level.GetRoomByIdx(roomGridIndex, Dimension.CURRENT);
+  const currentRoomHash = GetPtrHash(roomDescription);
+
+  for (const dimension of getAllDimensions()) {
+    const dimensionRoomDescription = level.GetRoomByIdx(
+      roomGridIndex,
+      dimension,
+    );
+    const dimensionRoomHash = GetPtrHash(dimensionRoomDescription);
+
+    if (dimensionRoomHash === currentRoomHash) {
+      return dimension;
+    }
+  }
+
+  error("Failed to get the current dimension.");
+}
+
+export function inDimension(dimension: Dimension): boolean {
+  return dimension === getDimension();
+}

package/src/functions/eden.ts

@@ -1,6 +1,6 @@
 import { CollectibleType, ItemConfigTag } from "isaac-typescript-definitions";
 import { isHiddenCollectible, isPassiveCollectible } from "./collectibles";
-import { getCollectibleSet } from "./collectibleSet";
+import { getCollectibleArray } from "./collectibleSet";
 import { collectibleHasTag } from "./collectibleTag";
 import { getRandomSeed } from "./rng";
 import { copySet, getRandomSetElement } from "./set";
@@ -8,9 +8,7 @@ import { copySet, getRandomSetElement } from "./set";
 const EDEN_PASSIVE_COLLECTIBLES_SET = new Set<CollectibleType>();
 
 function initCollectibleSet() {
-  const collectibleSet = getCollectibleSet();
-
-  for (const collectibleType of collectibleSet.values()) {
+  for (const collectibleType of getCollectibleArray()) {
     if (
       isPassiveCollectible(collectibleType) &&
       !isHiddenCollectible(collectibleType) &&

package/src/functions/itemPool.ts

@@ -7,7 +7,7 @@ import {
 } from "isaac-typescript-definitions";
 import { game } from "../cachedClasses";
 import { PlayerIndex } from "../types/PlayerIndex";
-import { getCollectibleSet } from "./collectibleSet";
+import { getCollectibleArray } from "./collectibleSet";
 import { collectibleHasTag } from "./collectibleTag";
 import { mapGetPlayer, mapSetPlayer } from "./playerDataStructures";
 import { getPlayers } from "./playerIndex";
@@ -24,17 +24,41 @@ const TRINKETS_THAT_AFFECT_ITEM_POOLS: readonly TrinketType[] = [
   TrinketType.NO,
 ];
 
+const COLLECTIBLE_TYPE_THAT_IS_NOT_IN_ANY_POOLS = CollectibleType.KEY_PIECE_1;
+
+/**
+ * Helper function to get the remaining collectibles in a given item pool. This function is
+ * expensive, so only use it in situations where the lag is acceptable.
+ */
+export function getCollectiblesInItemPool(
+  itemPoolType: ItemPoolType,
+): CollectibleType[] {
+  const collectibleArray = getCollectibleArray();
+  return collectibleArray.filter((collectibleType) =>
+    isCollectibleInItemPool(collectibleType, itemPoolType),
+  );
+}
+
 /**
  * Helper function to see if the given collectible is still present in the given item pool.
  *
  * If the collectible is non-offensive, any Tainted Losts will be temporarily changed to Isaac and
  * then changed back. (This is because Tainted Lost is not able to retrieve non-offensive
  * collectibles from item pools).
+ *
+ * Under the hood, this function works by using the `ItemPool.AddRoomBlacklist` method to blacklist
+ * every collectible except for the one provided.
  */
 export function isCollectibleInItemPool(
   collectibleType: CollectibleType,
   itemPoolType: ItemPoolType,
 ): boolean {
+  // We use a specific collectible which is known to not be in any pools as a default value. Thus,
+  // we must explicitly handle this case.
+  if (collectibleType === COLLECTIBLE_TYPE_THAT_IS_NOT_IN_ANY_POOLS) {
+    return false;
+  }
+
   // 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);
@@ -55,8 +79,8 @@ export function isCollectibleInItemPool(
 
   // Blacklist every collectible in the game except for the provided collectible.
   const itemPool = game.GetItemPool();
-  const collectibleSet = getCollectibleSet();
-  for (const collectibleTypeInSet of collectibleSet.values()) {
+  itemPool.ResetRoomBlacklist();
+  for (const collectibleTypeInSet of getCollectibleArray()) {
     if (collectibleTypeInSet !== collectibleType) {
       itemPool.AddRoomBlacklist(collectibleTypeInSet);
     }
@@ -64,12 +88,13 @@ export function isCollectibleInItemPool(
 
   // Get a collectible from the pool and see if it is the intended collectible. (We can use any
   // arbitrary value as the seed since it should not influence the result.)
+  const seed = 1 as Seed;
   const retrievedCollectibleType = itemPool.GetCollectible(
     itemPoolType,
     false,
-    1 as Seed,
+    seed,
+    COLLECTIBLE_TYPE_THAT_IS_NOT_IN_ANY_POOLS,
   );
-
   const collectibleUnlocked = retrievedCollectibleType === collectibleType;
 
   // Reset the blacklist

package/src/functions/level.ts

@@ -1,21 +1,18 @@
 import { DoorSlot } from "isaac-typescript-definitions";
 import { game } from "../cachedClasses";
 import { getEnumValues } from "./enums";
-import {
-  getNumRooms,
-  getRooms,
-  isDoorSlotValidAtGridIndexForRedRoom,
-} from "./rooms";
+import { isDoorSlotValidAtGridIndexForRedRoom } from "./levelGrid";
+import { getNumRooms, getRoomsInGrid } from "./rooms";
 
 export function fillLevelWithRedRooms(): void {
   const level = game.GetLevel();
 
-  let numRooms: int;
+  let numRoomsInGrid: int;
   do {
-    const rooms = getRooms();
-    numRooms = rooms.length;
+    const roomsInGrid = getRoomsInGrid();
+    numRoomsInGrid = roomsInGrid.length;
 
-    for (const roomDescriptor of rooms) {
+    for (const roomDescriptor of roomsInGrid) {
       for (const doorSlot of getEnumValues(DoorSlot)) {
         if (
           isDoorSlotValidAtGridIndexForRedRoom(
@@ -27,5 +24,5 @@ export function fillLevelWithRedRooms(): void {
         }
       }
     }
-  } while (numRooms !== getNumRooms());
+  } while (numRoomsInGrid !== getNumRooms());
 }