isaacscript-common 13.0.0 → 13.1.0

package/dist/src/objects/roomShapeCorners.lua

@@ -3,256 +3,313 @@ local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitio
 local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
 local ____CornerType = require("src.enums.CornerType")
 local CornerType = ____CornerType.CornerType
-local TWO_BY_TWO_CENTER_X = 580
-local TWO_BY_TWO_CENTER_Y = 420
 --- The locations of the corners for each room shape.
+-- 
+-- Note that these corner locations are not accurate for the Mother Boss Room and the Home closet
+-- rooms. (Those rooms have custom shapes.)
 ____exports.ROOM_SHAPE_CORNERS = {
     [RoomShape.SHAPE_1x1] = {
         {
             type = CornerType.TOP_LEFT,
+            gridIndex = 0,
             position = Vector(60, 140)
         },
         {
             type = CornerType.TOP_RIGHT,
+            gridIndex = 14,
             position = Vector(580, 140)
         },
         {
             type = CornerType.BOTTOM_LEFT,
+            gridIndex = 120,
             position = Vector(60, 420)
         },
         {
             type = CornerType.BOTTOM_RIGHT,
+            gridIndex = 134,
             position = Vector(580, 420)
         }
     },
     [RoomShape.IH] = {
         {
             type = CornerType.TOP_LEFT,
+            gridIndex = 30,
             position = Vector(60, 220)
         },
         {
             type = CornerType.TOP_RIGHT,
+            gridIndex = 44,
             position = Vector(580, 220)
         },
         {
             type = CornerType.BOTTOM_LEFT,
+            gridIndex = 90,
             position = Vector(60, 340)
         },
         {
             type = CornerType.BOTTOM_RIGHT,
+            gridIndex = 104,
             position = Vector(580, 340)
         }
     },
     [RoomShape.IV] = {
         {
             type = CornerType.TOP_LEFT,
+            gridIndex = 4,
             position = Vector(220, 140)
         },
         {
             type = CornerType.TOP_RIGHT,
+            gridIndex = 10,
             position = Vector(420, 140)
         },
         {
             type = CornerType.BOTTOM_LEFT,
+            gridIndex = 124,
             position = Vector(220, 420)
         },
         {
             type = CornerType.BOTTOM_RIGHT,
+            gridIndex = 130,
             position = Vector(420, 420)
         }
     },
     [RoomShape.SHAPE_1x2] = {
         {
             type = CornerType.TOP_LEFT,
+            gridIndex = 0,
             position = Vector(60, 140)
         },
         {
             type = CornerType.TOP_RIGHT,
+            gridIndex = 14,
             position = Vector(580, 140)
         },
         {
             type = CornerType.BOTTOM_LEFT,
+            gridIndex = 225,
             position = Vector(60, 700)
         },
         {
             type = CornerType.BOTTOM_RIGHT,
+            gridIndex = 239,
             position = Vector(580, 700)
         }
     },
     [RoomShape.IIV] = {
         {
             type = CornerType.TOP_LEFT,
+            gridIndex = 4,
             position = Vector(220, 140)
         },
         {
             type = CornerType.TOP_RIGHT,
+            gridIndex = 10,
             position = Vector(420, 140)
         },
         {
             type = CornerType.BOTTOM_LEFT,
+            gridIndex = 229,
             position = Vector(220, 700)
         },
         {
             type = CornerType.BOTTOM_RIGHT,
+            gridIndex = 235,
             position = Vector(420, 700)
         }
     },
     [RoomShape.SHAPE_2x1] = {
         {
             type = CornerType.TOP_LEFT,
+            gridIndex = 0,
             position = Vector(60, 140)
         },
         {
             type = CornerType.TOP_RIGHT,
+            gridIndex = 27,
             position = Vector(1100, 140)
         },
         {
             type = CornerType.BOTTOM_LEFT,
+            gridIndex = 224,
             position = Vector(60, 420)
         },
         {
             type = CornerType.BOTTOM_RIGHT,
+            gridIndex = 251,
             position = Vector(1100, 420)
         }
     },
     [RoomShape.IIH] = {
         {
             type = CornerType.TOP_LEFT,
+            gridIndex = 56,
             position = Vector(60, 220)
         },
         {
             type = CornerType.TOP_RIGHT,
+            gridIndex = 83,
             position = Vector(1100, 220)
         },
         {
             type = CornerType.BOTTOM_LEFT,
+            gridIndex = 168,
             position = Vector(60, 340)
         },
         {
             type = CornerType.BOTTOM_RIGHT,
+            gridIndex = 195,
             position = Vector(1100, 340)
         }
     },
     [RoomShape.SHAPE_2x2] = {
         {
             type = CornerType.TOP_LEFT,
+            gridIndex = 0,
             position = Vector(60, 140)
         },
         {
             type = CornerType.TOP_RIGHT,
+            gridIndex = 27,
             position = Vector(1100, 140)
         },
         {
             type = CornerType.BOTTOM_LEFT,
+            gridIndex = 420,
             position = Vector(60, 700)
         },
         {
             type = CornerType.BOTTOM_RIGHT,
+            gridIndex = 447,
             position = Vector(1100, 700)
         }
     },
     [RoomShape.LTL] = {
         {
             type = CornerType.TOP_LEFT,
-            position = Vector(TWO_BY_TWO_CENTER_X, 140)
+            gridIndex = 13,
+            position = Vector(580, 140)
         },
         {
             type = CornerType.TOP_RIGHT,
+            gridIndex = 27,
             position = Vector(1100, 140)
         },
         {
             type = CornerType.TOP_LEFT,
-            position = Vector(60, TWO_BY_TWO_CENTER_Y)
+            gridIndex = 196,
+            position = Vector(60, 420)
         },
         {
             type = CornerType.BOTTOM_RIGHT,
-            position = Vector(TWO_BY_TWO_CENTER_X, TWO_BY_TWO_CENTER_Y)
+            gridIndex = 209,
+            position = Vector(580, 420)
         },
         {
             type = CornerType.BOTTOM_LEFT,
+            gridIndex = 420,
             position = Vector(60, 700)
         },
         {
             type = CornerType.BOTTOM_RIGHT,
+            gridIndex = 447,
             position = Vector(1100, 700)
         }
     },
     [RoomShape.LTR] = {
         {
             type = CornerType.TOP_LEFT,
+            gridIndex = 0,
             position = Vector(60, 140)
         },
         {
             type = CornerType.TOP_RIGHT,
-            position = Vector(TWO_BY_TWO_CENTER_X, 140)
+            gridIndex = 14,
+            position = Vector(580, 140)
         },
         {
             type = CornerType.BOTTOM_LEFT,
-            position = Vector(TWO_BY_TWO_CENTER_X, TWO_BY_TWO_CENTER_Y)
+            gridIndex = 210,
+            position = Vector(580, 420)
         },
         {
             type = CornerType.TOP_RIGHT,
-            position = Vector(1100, TWO_BY_TWO_CENTER_Y)
+            gridIndex = 223,
+            position = Vector(1100, 420)
         },
         {
             type = CornerType.BOTTOM_LEFT,
+            gridIndex = 420,
             position = Vector(60, 700)
         },
         {
             type = CornerType.BOTTOM_RIGHT,
+            gridIndex = 447,
             position = Vector(1100, 700)
         }
     },
     [RoomShape.LBL] = {
         {
             type = CornerType.TOP_LEFT,
+            gridIndex = 0,
             position = Vector(60, 140)
         },
         {
             type = CornerType.TOP_RIGHT,
+            gridIndex = 27,
             position = Vector(1100, 140)
         },
         {
             type = CornerType.BOTTOM_LEFT,
-            position = Vector(TWO_BY_TWO_CENTER_X, 140)
+            gridIndex = 224,
+            position = Vector(580, 140)
         },
         {
             type = CornerType.TOP_RIGHT,
-            position = Vector(TWO_BY_TWO_CENTER_X, TWO_BY_TWO_CENTER_Y)
+            gridIndex = 237,
+            position = Vector(580, 420)
         },
         {
             type = CornerType.BOTTOM_LEFT,
-            position = Vector(TWO_BY_TWO_CENTER_X, 700)
+            gridIndex = 433,
+            position = Vector(580, 700)
         },
         {
             type = CornerType.BOTTOM_RIGHT,
+            gridIndex = 447,
             position = Vector(1100, 700)
         }
     },
     [RoomShape.LBR] = {
         {
             type = CornerType.TOP_LEFT,
+            gridIndex = 0,
             position = Vector(60, 140)
         },
         {
             type = CornerType.TOP_RIGHT,
+            gridIndex = 27,
             position = Vector(1100, 140)
         },
         {
             type = CornerType.TOP_LEFT,
-            position = Vector(TWO_BY_TWO_CENTER_X, TWO_BY_TWO_CENTER_Y)
+            gridIndex = 238,
+            position = Vector(580, 420)
         },
         {
             type = CornerType.BOTTOM_RIGHT,
-            position = Vector(1100, TWO_BY_TWO_CENTER_Y)
+            gridIndex = 251,
+            position = Vector(1100, 420)
         },
         {
             type = CornerType.BOTTOM_LEFT,
+            gridIndex = 420,
             position = Vector(60, 700)
         },
         {
             type = CornerType.BOTTOM_RIGHT,
-            position = Vector(TWO_BY_TWO_CENTER_X, 700)
+            gridIndex = 434,
+            position = Vector(580, 700)
         }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "13.0.0",
+  "version": "13.1.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "dist/src/index",
   "types": "dist/src/index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^7.2.6"
+    "isaac-typescript-definitions": "^7.2.7"
   }
 }

package/src/features/customStage/backdrop.ts

@@ -15,7 +15,7 @@ import { spawnEffectWithSeed } from "../../functions/entitiesSpecific";
 import { newRNG } from "../../functions/rng";
 import { isLRoom, isNarrowRoom } from "../../functions/roomShape";
 import { removeCharactersBefore, trimPrefix } from "../../functions/string";
-import { erange, irange } from "../../functions/utils";
+import { eRange, iRange } from "../../functions/utils";
 import { CustomStage } from "../../interfaces/private/CustomStage";
 import { ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH } from "./constants";
 
@@ -163,7 +163,7 @@ function spawnWallEntity(
     sprite.ReplaceSpritesheet(0, cornerPNGPath);
   }
 
-  for (const layerID of irange(1, numWallLayers)) {
+  for (const layerID of iRange(1, numWallLayers)) {
     const wallPNGPath = getBackdropPNGPath(customStage, BackdropKind.WALL, rng);
     sprite.ReplaceSpritesheet(layerID, wallPNGPath);
   }
@@ -214,7 +214,7 @@ function spawnFloorEntity(customStage: CustomStage, rng: RNG) {
 
   const numFloorLayers = getNumFloorLayers(roomShape);
   if (numFloorLayers !== undefined) {
-    for (const layerID of erange(0, numFloorLayers)) {
+    for (const layerID of eRange(0, numFloorLayers)) {
       // The wall spritesheet is used for the "normal" floors.
       const wallPNGPath = getBackdropPNGPath(
         customStage,

package/src/features/customStage/versusScreen.ts

@@ -10,7 +10,7 @@ import { arrayRemove } from "../../functions/array";
 import { getBosses } from "../../functions/bosses";
 import { getRoomSubType } from "../../functions/roomData";
 import { removeCharactersBefore } from "../../functions/string";
-import { erange } from "../../functions/utils";
+import { eRange } from "../../functions/utils";
 import { CustomStage } from "../../interfaces/private/CustomStage";
 import { BOSS_NAME_PNG_FILE_NAMES } from "../../objects/bossNamePNGFileNames";
 import { BOSS_PORTRAIT_PNG_FILE_NAMES } from "../../objects/bossPortraitPNGFileNames";
@@ -58,7 +58,7 @@ const PLAYER_PORTRAIT_ALT_ANM2_LAYER = 12;
 
 /** These are the non-special layers that we will render last. */
 const OTHER_ANM2_LAYERS: readonly int[] = arrayRemove(
-  erange(NUM_VERSUS_SCREEN_ANM2_LAYERS),
+  eRange(NUM_VERSUS_SCREEN_ANM2_LAYERS),
   BACKGROUND_ANM2_LAYER,
   BOSS_DIRT_SPOT_ANM2_LAYER,
   PLAYER_DIRT_SPOT_ANM2_LAYER,

package/src/features/deployJSONRoom.ts

@@ -7,7 +7,6 @@ import {
   ActiveSlot,
   CollectibleType,
   EntityCollisionClass,
-  EntityFlag,
   EntityGridCollisionClass,
   EntityType,
   GridEntityType,
@@ -24,8 +23,8 @@ import { game } from "../core/cachedClasses";
 import { ModCallbackCustom } from "../enums/ModCallbackCustom";
 import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
 import { emptyArray } from "../functions/array";
+import { emptyRoom } from "../functions/emptyRoom";
 import {
-  getEntities,
   getEntityIDFromConstituents,
   spawn,
   spawnWithSeed,
@@ -44,11 +43,7 @@ import { log } from "../functions/log";
 import { getRandomSeed, isRNG, newRNG } from "../functions/rng";
 import { getRoomListIndex } from "../functions/roomData";
 import { gridCoordinatesToWorldPosition } from "../functions/roomGrid";
-import {
-  roomUpdateSafe,
-  setRoomCleared,
-  setRoomUncleared,
-} from "../functions/rooms";
+import { setRoomCleared, setRoomUncleared } from "../functions/rooms";
 import { spawnCollectible } from "../functions/spawnCollectible";
 import { asCollectibleType, asNumber } from "../functions/types";
 import { JSONRoom } from "../interfaces/JSONRoomsFile";
@@ -73,22 +68,6 @@ const GRID_ENTITY_XML_TYPE_SET: ReadonlySet<number> = new Set(
   gridEntityXMLTypes,
 );
 
-const EMPTY_ROOM_BLACKLIST_ENTITY_SET: ReadonlySet<EntityType> = new Set([
-  EntityType.PLAYER, // 1
-  EntityType.TEAR, // 2
-  EntityType.FAMILIAR, // 3
-  EntityType.LASER, // 7
-  EntityType.KNIFE, // 8
-  EntityType.PROJECTILE, // 9
-  EntityType.DARK_ESAU, // 866
-]);
-
-const EMPTY_ROOM_BLACKLIST_GRID_ENTITY_SET: ReadonlySet<GridEntityType> =
-  new Set([
-    GridEntityType.WALL, // 15
-    GridEntityType.DOOR, // 16
-  ]);
-
 const v = {
   level: {
     deployedRoomListIndexes: new Set<int>(),
@@ -272,14 +251,19 @@ export function deployJSONRoom(
 
   const rng = isRNG(seedOrRNG) ? seedOrRNG : newRNG(seedOrRNG);
 
+  const roomListIndex = getRoomListIndex();
+  v.level.deployedRoomListIndexes.add(roomListIndex);
+
   if (verbose) {
     log("Starting to empty the room of entities and grid entities.");
   }
-  emptyRoom(false);
+  emptyRoom();
   if (verbose) {
     log("Finished emptying the room of entities and grid entities.");
   }
 
+  setRoomCleared();
+
   if (verbose) {
     log("Starting to spawn all of the new entities and grid entities.");
   }
@@ -343,80 +327,6 @@ export function deployRandomJSONRoom(
   return deployJSONRoom(randomJSONRoom, rng, verbose);
 }
 
-/**
- * Helper function to remove all naturally spawning entities and grid entities from a room. Notably,
- * this will not remove players (1), tears (2), familiars (3), lasers (7), knives (8), projectiles
- * (9), blacklisted NPCs such as Dark Esau, charmed NPCs, friendly NPCs, persistent NPCs, most
- * effects (1000), doors, and walls.
- *
- * @param fillWithDecorations Optional. Set to true to fill every grid tile with an invisible
- *                            decoration, which prevents vanilla entities in the room from
- *                            respawning the next time that the player enters. Default is false.
- */
-export function emptyRoom(fillWithDecorations: boolean): void {
-  errorIfFeaturesNotInitialized(FEATURE_NAME);
-
-  const roomListIndex = getRoomListIndex();
-  v.level.deployedRoomListIndexes.add(roomListIndex);
-
-  emptyRoomEntities();
-  emptyRoomGridEntities();
-  setRoomCleared();
-
-  if (fillWithDecorations) {
-    fillRoomWithDecorations();
-  }
-}
-
-/**
- * We remove entities in the `POST_NEW_ROOM` callback instead of in the `PRE_ROOM_ENTITY_SPAWN`
- * callback so that they will not re-appear when we re-enter the room.
- */
-function emptyRoomEntities() {
-  const room = game.GetRoom();
-
-  for (const entity of getEntities()) {
-    if (EMPTY_ROOM_BLACKLIST_ENTITY_SET.has(entity.Type)) {
-      continue;
-    }
-
-    if (
-      entity.HasEntityFlags(EntityFlag.CHARM) ||
-      entity.HasEntityFlags(EntityFlag.FRIENDLY) ||
-      entity.HasEntityFlags(EntityFlag.PERSISTENT)
-    ) {
-      continue;
-    }
-
-    entity.ClearEntityFlags(EntityFlag.APPEAR);
-    entity.Remove();
-
-    // When fire places are removed, they will leave behind a "path" that will prevent future grid
-    // entities from being spawned on the same tile. Thus, reset the path for this tile if this is a
-    // fire place.
-    if (entity.Type === EntityType.FIREPLACE) {
-      const gridIndex = room.GetGridIndex(entity.Position);
-      room.SetGridPath(gridIndex, 0);
-    }
-  }
-}
-
-function emptyRoomGridEntities() {
-  let removedOneOrMoreGridEntities = false;
-  for (const gridEntity of getGridEntities()) {
-    const gridEntityType = gridEntity.GetType();
-    if (EMPTY_ROOM_BLACKLIST_GRID_ENTITY_SET.has(gridEntityType)) {
-      continue;
-    }
-
-    removeGridEntity(gridEntity, false);
-    removedOneOrMoreGridEntities = true;
-  }
-  if (removedOneOrMoreGridEntities) {
-    roomUpdateSafe();
-  }
-}
-
 /**
  * We removed most normal entities, which should prevent them from respawning when the player
  * re-enters the room. However, this is not the case for grid entities; even if they are removed,

package/src/features/extraConsoleCommands/listCommands.ts

@@ -116,7 +116,7 @@ import {
   asCollectibleType,
   asTrinketType,
 } from "../../functions/types";
-import { irange, printConsole, printEnabled } from "../../functions/utils";
+import { iRange, printConsole, printEnabled } from "../../functions/utils";
 import { CARD_NAME_TO_TYPE_MAP } from "../../maps/cardNameToTypeMap";
 import { CHARACTER_NAME_TO_TYPE_MAP } from "../../maps/characterNameToTypeMap";
 import { COLLECTIBLE_NAME_TO_TYPE_MAP } from "../../maps/collectibleNameToTypeMap";
@@ -941,7 +941,7 @@ export function map(): void {
     DisplayFlag.SHOW_ICON, // 1 << 2
   );
 
-  for (const roomGridIndex of irange(MAX_LEVEL_GRID_INDEX)) {
+  for (const roomGridIndex of iRange(MAX_LEVEL_GRID_INDEX)) {
     const roomDesc = level.GetRoomByIdx(roomGridIndex);
     roomDesc.DisplayFlags = displayFlags;
   }

package/src/features/firstLast.ts

@@ -28,7 +28,7 @@ import {
   asPillEffect,
   asTrinketType,
 } from "../functions/types";
-import { irange } from "../functions/utils";
+import { iRange } from "../functions/utils";
 
 const FEATURE_NAME = "firstLast";
 
@@ -117,7 +117,7 @@ export function getModdedCollectibleTypes(): CollectibleType[] {
   }
 
   const lastCollectibleType = getLastCollectibleType();
-  return irange(firstModdedCollectibleType, lastCollectibleType);
+  return iRange(firstModdedCollectibleType, lastCollectibleType);
 }
 
 /**
@@ -202,7 +202,7 @@ export function getModdedTrinketTypes(): TrinketType[] {
   }
 
   const lastTrinketType = getLastTrinketType();
-  return irange(firstModdedTrinketType, lastTrinketType);
+  return iRange(firstModdedTrinketType, lastTrinketType);
 }
 
 /**
@@ -241,7 +241,7 @@ export function getNumModdedTrinketTypes(): int {
  */
 export function getTrinketTypes(): TrinketType[] {
   const lastTrinketType = getLastTrinketType();
-  return irange(FIRST_TRINKET_TYPE, lastTrinketType);
+  return iRange(FIRST_TRINKET_TYPE, lastTrinketType);
 }
 
 // -----
@@ -256,7 +256,7 @@ export function getTrinketTypes(): TrinketType[] {
  */
 export function getAllCardTypes(): CardType[] {
   const lastCardType = getLastCardType();
-  return irange(FIRST_CARD_TYPE, lastCardType);
+  return iRange(FIRST_CARD_TYPE, lastCardType);
 }
 
 /**
@@ -306,7 +306,7 @@ export function getModdedCardTypes(): CardType[] {
   }
 
   const lastCardType = getLastCardType();
-  return irange(firstModdedCardType, lastCardType);
+  return iRange(firstModdedCardType, lastCardType);
 }
 
 /**
@@ -348,7 +348,7 @@ export function getNumModdedCardTypes(): int {
  */
 export function getAllPillEffects(): PillEffect[] {
   const lastPillEffect = getLastPillEffect();
-  return irange(FIRST_PILL_EFFECT, lastPillEffect);
+  return iRange(FIRST_PILL_EFFECT, lastPillEffect);
 }
 
 /**
@@ -400,7 +400,7 @@ export function getModdedPillEffects(): PillEffect[] {
   }
 
   const lastPillEffect = getLastPillEffect();
-  return irange(firstModdedPillEffect, lastPillEffect);
+  return iRange(firstModdedPillEffect, lastPillEffect);
 }
 
 /**