isaacscript-common 87.5.0 → 87.6.0

package/dist/functions/gridEntities.js

@@ -1,6 +1,41 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.spawnVoidPortal = exports.spawnGridEntityWithVariant = exports.spawnGridEntity = exports.spawnGiantPoop = exports.setGridEntityType = exports.setGridEntityInvisible = exports.removeGridEntity = exports.removeGridEntities = exports.removeEntitiesSpawnedFromGridEntity = exports.removeAllMatchingGridEntities = exports.removeAllGridEntitiesExcept = exports.isPostBossVoidPortal = exports.isPoopGridEntityXMLType = exports.isGridIndexAdjacentToDoor = exports.isGridEntityXMLType = exports.isGridEntityBroken = exports.isGridEntityBreakableByExplosion = exports.getTopLeftWallGridIndex = exports.getTopLeftWall = exports.getSurroundingGridIndexes = exports.getSurroundingGridEntities = exports.getRockPNGPath = exports.getMatchingGridEntities = exports.getGridEntityIDFromConstituents = exports.getGridEntityID = exports.getGridEntityCollisionPoints = exports.getGridEntityANM2Path = exports.getGridEntitiesMap = exports.getGridEntitiesInRadius = exports.getGridEntitiesExcept = exports.getGridEntities = exports.getConstituentsFromGridEntityID = exports.getCollidingEntitiesWithGridEntity = exports.getAllGridIndexes = exports.doesGridEntityExist = exports.convertXMLGridEntityType = void 0;
+exports.convertXMLGridEntityType = convertXMLGridEntityType;
+exports.doesGridEntityExist = doesGridEntityExist;
+exports.getAllGridIndexes = getAllGridIndexes;
+exports.getCollidingEntitiesWithGridEntity = getCollidingEntitiesWithGridEntity;
+exports.getConstituentsFromGridEntityID = getConstituentsFromGridEntityID;
+exports.getGridEntities = getGridEntities;
+exports.getGridEntitiesExcept = getGridEntitiesExcept;
+exports.getGridEntitiesInRadius = getGridEntitiesInRadius;
+exports.getGridEntitiesMap = getGridEntitiesMap;
+exports.getGridEntityANM2Path = getGridEntityANM2Path;
+exports.getGridEntityCollisionPoints = getGridEntityCollisionPoints;
+exports.getGridEntityID = getGridEntityID;
+exports.getGridEntityIDFromConstituents = getGridEntityIDFromConstituents;
+exports.getMatchingGridEntities = getMatchingGridEntities;
+exports.getRockPNGPath = getRockPNGPath;
+exports.getSurroundingGridEntities = getSurroundingGridEntities;
+exports.getSurroundingGridIndexes = getSurroundingGridIndexes;
+exports.getTopLeftWall = getTopLeftWall;
+exports.getTopLeftWallGridIndex = getTopLeftWallGridIndex;
+exports.isGridEntityBreakableByExplosion = isGridEntityBreakableByExplosion;
+exports.isGridEntityBroken = isGridEntityBroken;
+exports.isGridEntityXMLType = isGridEntityXMLType;
+exports.isGridIndexAdjacentToDoor = isGridIndexAdjacentToDoor;
+exports.isPoopGridEntityXMLType = isPoopGridEntityXMLType;
+exports.isPostBossVoidPortal = isPostBossVoidPortal;
+exports.removeAllGridEntitiesExcept = removeAllGridEntitiesExcept;
+exports.removeAllMatchingGridEntities = removeAllMatchingGridEntities;
+exports.removeEntitiesSpawnedFromGridEntity = removeEntitiesSpawnedFromGridEntity;
+exports.removeGridEntities = removeGridEntities;
+exports.removeGridEntity = removeGridEntity;
+exports.setGridEntityInvisible = setGridEntityInvisible;
+exports.setGridEntityType = setGridEntityType;
+exports.spawnGiantPoop = spawnGiantPoop;
+exports.spawnGridEntity = spawnGridEntity;
+exports.spawnGridEntityWithVariant = spawnGridEntityWithVariant;
+exports.spawnVoidPortal = spawnVoidPortal;
 const isaac_typescript_definitions_1 = require("isaac-typescript-definitions");
 const cachedEnumValues_1 = require("../cachedEnumValues");
 const cachedClasses_1 = require("../core/cachedClasses");
@@ -58,7 +93,6 @@ function convertXMLGridEntityType(gridEntityXMLType, gridEntityXMLVariant) {
         : gridEntityArray[1];
     return [gridEntityType, variant];
 }
-exports.convertXMLGridEntityType = convertXMLGridEntityType;
 /**
  * Helper function to check if one or more of a specific kind of grid entity is present in the
  * current room.
@@ -76,11 +110,10 @@ function doesGridEntityExist(gridEntityType, variant = -1) {
         }
         const thisGridEntityType = gridEntity.GetType();
         const thisVariant = gridEntity.GetVariant();
-        return (gridEntityType === thisGridEntityType &&
-            (variant === -1 || variant === thisVariant));
+        return (gridEntityType === thisGridEntityType
+            && (variant === -1 || variant === thisVariant));
     });
 }
-exports.doesGridEntityExist = doesGridEntityExist;
 /**
  * Helper function to get every legal grid index for the current room.
  *
@@ -91,7 +124,6 @@ function getAllGridIndexes() {
     const gridSize = room.GetGridSize();
     return (0, utils_1.eRange)(gridSize);
 }
-exports.getAllGridIndexes = getAllGridIndexes;
 /**
  * Gets the entities that have a hitbox that overlaps with any part of the square that the grid
  * entity is on.
@@ -105,13 +137,12 @@ exports.getAllGridIndexes = getAllGridIndexes;
 function getCollidingEntitiesWithGridEntity(gridEntity) {
     const { topLeft, bottomRight } = getGridEntityCollisionPoints(gridEntity);
     const closeEntities = Isaac.FindInRadius(gridEntity.Position, constants_1.DISTANCE_OF_GRID_TILE * 2);
-    return closeEntities.filter((entity) => entity.CollidesWithGrid() &&
-        (0, math_1.isCircleIntersectingRectangle)(entity.Position, 
+    return closeEntities.filter((entity) => entity.CollidesWithGrid()
+        && (0, math_1.isCircleIntersectingRectangle)(entity.Position, 
         // We arbitrarily add 0.1 to account for entities that are already pushed back by the time
         // the `POST_UPDATE` callback fires.
         entity.Size + 0.1, topLeft, bottomRight));
 }
-exports.getCollidingEntitiesWithGridEntity = getCollidingEntitiesWithGridEntity;
 /** Helper function to get the grid entity type and variant from a `GridEntityID`. */
 function getConstituentsFromGridEntityID(gridEntityID) {
     const parts = gridEntityID.split(".");
@@ -127,7 +158,6 @@ function getConstituentsFromGridEntityID(gridEntityID) {
     (0, utils_1.assertDefined)(variant, `Failed to convert the grid entity variant to an integer: ${variantString}`);
     return [gridEntityType, variant];
 }
-exports.getConstituentsFromGridEntityID = getConstituentsFromGridEntityID;
 /**
  * Helper function to get every grid entity in the current room.
  *
@@ -165,7 +195,6 @@ function getGridEntities(...gridEntityTypes) {
         return gridEntityTypesSet.has(gridEntityType);
     });
 }
-exports.getGridEntities = getGridEntities;
 /**
  * Helper function to get every grid entity in the current room except for certain specific types.
  *
@@ -183,7 +212,6 @@ function getGridEntitiesExcept(...gridEntityTypes) {
         return !gridEntityTypesSet.has(gridEntityType);
     });
 }
-exports.getGridEntitiesExcept = getGridEntitiesExcept;
 function getAllGridEntities() {
     const room = cachedClasses_1.game.GetRoom();
     const gridEntities = [];
@@ -223,7 +251,6 @@ function getGridEntitiesInRadius(targetPosition, radius) {
     }
     return gridEntities;
 }
-exports.getGridEntitiesInRadius = getGridEntitiesInRadius;
 /**
  * Helper function to get a map of every grid entity in the current room. The indexes of the map are
  * equal to the grid index. The values of the map are equal to the grid entities.
@@ -242,13 +269,11 @@ function getGridEntitiesMap(...gridEntityTypes) {
     }
     return gridEntityMap;
 }
-exports.getGridEntitiesMap = getGridEntitiesMap;
 /** Helper function to get the ANM2 path for a grid entity type. */
 function getGridEntityANM2Path(gridEntityType) {
     const gridEntityANM2Name = getGridEntityANM2Name(gridEntityType);
     return `gfx/grid/${gridEntityANM2Name}`;
 }
-exports.getGridEntityANM2Path = getGridEntityANM2Path;
 function getGridEntityANM2Name(gridEntityType) {
     switch (gridEntityType) {
         // 1
@@ -363,14 +388,12 @@ function getGridEntityCollisionPoints(gridEntity) {
     const bottomRight = Vector(gridEntity.Position.X + constants_1.DISTANCE_OF_GRID_TILE / 2, gridEntity.Position.Y + constants_1.DISTANCE_OF_GRID_TILE / 2);
     return { topLeft, bottomRight };
 }
-exports.getGridEntityCollisionPoints = getGridEntityCollisionPoints;
 /** Helper function to get a string containing the grid entity's type and variant. */
 function getGridEntityID(gridEntity) {
     const gridEntityType = gridEntity.GetType();
     const variant = gridEntity.GetVariant();
     return `${gridEntityType}.${variant}`;
 }
-exports.getGridEntityID = getGridEntityID;
 /**
  * Helper function to get a formatted string in the format returned by the `getGridEntityID`
  * function.
@@ -378,7 +401,6 @@ exports.getGridEntityID = getGridEntityID;
 function getGridEntityIDFromConstituents(gridEntityType, variant) {
     return `${gridEntityType}.${variant}`;
 }
-exports.getGridEntityIDFromConstituents = getGridEntityIDFromConstituents;
 /**
  * Helper function to get all of the grid entities in the room that specifically match the type and
  * variant provided.
@@ -389,7 +411,6 @@ function getMatchingGridEntities(gridEntityType, variant) {
     const gridEntities = getGridEntities(gridEntityType);
     return gridEntities.filter((gridEntity) => gridEntity.GetVariant() === variant);
 }
-exports.getMatchingGridEntities = getMatchingGridEntities;
 /**
  * Helper function to get the PNG path for a rock. This depends on the current room's backdrop. The
  * values are taken from the "backdrops.xml" file.
@@ -400,7 +421,6 @@ function getRockPNGPath() {
     const rockPNGName = getRockPNGName();
     return `gfx/grid/${rockPNGName}`;
 }
-exports.getRockPNGPath = getRockPNGPath;
 function getRockPNGName() {
     const room = cachedClasses_1.game.GetRoom();
     const backdropType = room.GetBackdropType();
@@ -539,7 +559,6 @@ function getSurroundingGridEntities(gridEntity) {
     }
     return surroundingGridEntities;
 }
-exports.getSurroundingGridEntities = getSurroundingGridEntities;
 /**
  * Helper function to get the grid indexes on the surrounding tiles from the provided grid index.
  *
@@ -561,7 +580,6 @@ function getSurroundingGridIndexes(gridIndex) {
         gridIndex + gridWidth + 1, // Bottom-right
     ];
 }
-exports.getSurroundingGridIndexes = getSurroundingGridIndexes;
 /**
  * Helper function to get the top left wall in the current room.
  *
@@ -572,7 +590,6 @@ function getTopLeftWall() {
     const topLeftWallGridIndex = getTopLeftWallGridIndex();
     return room.GetGridEntity(topLeftWallGridIndex);
 }
-exports.getTopLeftWall = getTopLeftWall;
 /**
  * Helper function to get the grid index of the top left wall. (This will depend on what the current
  * room shape is.)
@@ -585,7 +602,6 @@ function getTopLeftWallGridIndex() {
     const topLeftWallGridIndex = roomShapeToTopLeftWallGridIndexMap_1.ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP.get(roomShape);
     return topLeftWallGridIndex ?? roomShapeToTopLeftWallGridIndexMap_1.DEFAULT_TOP_LEFT_WALL_GRID_INDEX;
 }
-exports.getTopLeftWallGridIndex = getTopLeftWallGridIndex;
 /**
  * Helper function to detect if a particular grid entity would "break" if it was touched by an
  * explosion.
@@ -596,10 +612,9 @@ function isGridEntityBreakableByExplosion(gridEntity) {
     const gridEntityType = gridEntity.GetType();
     const variant = gridEntity.GetVariant();
     const gridEntityTypeVariant = `${gridEntityType}.${variant}`;
-    return (BREAKABLE_GRID_ENTITY_TYPES_BY_EXPLOSIONS.has(gridEntityType) ||
-        BREAKABLE_GRID_ENTITY_TYPES_VARIANTS_BY_EXPLOSIONS.has(gridEntityTypeVariant));
+    return (BREAKABLE_GRID_ENTITY_TYPES_BY_EXPLOSIONS.has(gridEntityType)
+        || BREAKABLE_GRID_ENTITY_TYPES_VARIANTS_BY_EXPLOSIONS.has(gridEntityTypeVariant));
 }
-exports.isGridEntityBreakableByExplosion = isGridEntityBreakableByExplosion;
 /**
  * Helper function to see if the provided grid entity is in its respective broken state. See the
  * `GRID_ENTITY_TYPE_TO_BROKEN_STATE_MAP` constant for more details.
@@ -612,15 +627,13 @@ function isGridEntityBroken(gridEntity) {
     const brokenState = gridEntityTypeToBrokenStateMap_1.GRID_ENTITY_TYPE_TO_BROKEN_STATE_MAP.get(gridEntityType);
     return gridEntity.State === brokenState;
 }
-exports.isGridEntityBroken = isGridEntityBroken;
 /**
  * Helper function to see if an arbitrary number is a valid `GridEntityXMLType`. This is useful in
  * the `PRE_ROOM_ENTITY_SPAWN` callback for narrowing the type of the first argument.
  */
 function isGridEntityXMLType(num) {
-    return GRID_ENTITY_XML_TYPES_SET.has(num); // eslint-disable-line isaacscript/strict-enums
+    return GRID_ENTITY_XML_TYPES_SET.has(num); // eslint-disable-line complete/strict-enums
 }
-exports.isGridEntityXMLType = isGridEntityXMLType;
 /**
  * Helper function to check if the provided grid index has a door on it or if the surrounding 8 grid
  * indexes have a door on it.
@@ -640,12 +653,10 @@ function isGridIndexAdjacentToDoor(gridIndex) {
     }
     return false;
 }
-exports.isGridIndexAdjacentToDoor = isGridIndexAdjacentToDoor;
 /** Helper function to see if a `GridEntityXMLType` is some kind of poop. */
 function isPoopGridEntityXMLType(gridEntityXMLType) {
     return poopGridEntityXMLTypesSet_1.POOP_GRID_ENTITY_XML_TYPES_SET.has(gridEntityXMLType);
 }
-exports.isPoopGridEntityXMLType = isPoopGridEntityXMLType;
 /**
  * Helper function to detect whether a given Void Portal is one that randomly spawns after a boss is
  * defeated or is one that naturally spawns in the room after Hush.
@@ -656,11 +667,11 @@ exports.isPoopGridEntityXMLType = isPoopGridEntityXMLType;
  */
 function isPostBossVoidPortal(gridEntity) {
     const saveState = gridEntity.GetSaveState();
-    return (saveState.Type === isaac_typescript_definitions_1.GridEntityType.TRAPDOOR &&
-        saveState.Variant === isaac_typescript_definitions_1.TrapdoorVariant.VOID_PORTAL &&
-        saveState.VarData === 1);
+    return (saveState.Type === isaac_typescript_definitions_1.GridEntityType.TRAPDOOR
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+        && saveState.Variant === isaac_typescript_definitions_1.TrapdoorVariant.VOID_PORTAL
+        && saveState.VarData === 1);
 }
-exports.isPostBossVoidPortal = isPostBossVoidPortal;
 /**
  * Helper function to all grid entities in the room except for ones matching the grid entity types
  * provided.
@@ -695,7 +706,6 @@ function removeAllGridEntitiesExcept(...gridEntityTypes) {
     }
     return removedGridEntities;
 }
-exports.removeAllGridEntitiesExcept = removeAllGridEntitiesExcept;
 /**
  * Helper function to remove all of the grid entities in the room that match the grid entity types
  * provided.
@@ -726,7 +736,6 @@ function removeAllMatchingGridEntities(...gridEntityType) {
     (0, rooms_1.roomUpdateSafe)();
     return gridEntities;
 }
-exports.removeAllMatchingGridEntities = removeAllMatchingGridEntities;
 /**
  * Helper function to remove all entities that just spawned from a grid entity breaking.
  * Specifically, this is any entities that overlap with the position of a grid entity and are on
@@ -735,11 +744,10 @@ exports.removeAllMatchingGridEntities = removeAllMatchingGridEntities;
  * You must specify an array of entities to look through.
  */
 function removeEntitiesSpawnedFromGridEntity(entities, gridEntity) {
-    const entitiesFromGridEntity = entities.filter((entity) => entity.FrameCount === 0 &&
-        (0, vector_1.vectorEquals)(entity.Position, gridEntity.Position));
+    const entitiesFromGridEntity = entities.filter((entity) => entity.FrameCount === 0
+        && (0, vector_1.vectorEquals)(entity.Position, gridEntity.Position));
     (0, entities_1.removeEntities)(entitiesFromGridEntity);
 }
-exports.removeEntitiesSpawnedFromGridEntity = removeEntitiesSpawnedFromGridEntity;
 /**
  * Helper function to remove all of the grid entities in the supplied array.
  *
@@ -769,7 +777,6 @@ function removeGridEntities(gridEntities, updateRoom, cap) {
     }
     return gridEntitiesRemoved;
 }
-exports.removeGridEntities = removeGridEntities;
 /**
  * Helper function to remove a grid entity by providing the grid entity object or the grid index
  * inside of the room.
@@ -806,7 +813,9 @@ function removeGridEntity(gridEntityOrGridIndex, updateRoom) {
     // In the special case of removing a Devil Statue or Angel Statue, we also need to delete the
     // corresponding effect.
     if (gridEntityType === isaac_typescript_definitions_1.GridEntityType.STATUE) {
-        const effectVariant = variant === isaac_typescript_definitions_1.StatueVariant.DEVIL
+        const effectVariant = 
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+        variant === isaac_typescript_definitions_1.StatueVariant.DEVIL
             ? isaac_typescript_definitions_1.EffectVariant.DEVIL
             : isaac_typescript_definitions_1.EffectVariant.ANGEL;
         const effects = (0, entitiesSpecific_1.getEffects)(effectVariant);
@@ -814,7 +823,6 @@ function removeGridEntity(gridEntityOrGridIndex, updateRoom) {
         (0, entities_1.removeEntities)(effectsOnTile);
     }
 }
-exports.removeGridEntity = removeGridEntity;
 /**
  * Helper function to make a grid entity invisible. This is accomplished by resetting the sprite.
  *
@@ -826,7 +834,6 @@ function setGridEntityInvisible(gridEntity) {
     const sprite = gridEntity.GetSprite();
     sprite.Reset();
 }
-exports.setGridEntityInvisible = setGridEntityInvisible;
 /**
  * Helper function to change the type of a grid entity to another type. Use this instead of the
  * `GridEntity.SetType` method since that does not properly handle updating the sprite of the grid
@@ -850,7 +857,6 @@ function setGridEntityType(gridEntity, gridEntityType) {
     const defaultAnimation = sprite.GetDefaultAnimation();
     sprite.Play(defaultAnimation, true);
 }
-exports.setGridEntityType = setGridEntityType;
 /**
  * Helper function to spawn a giant poop. This is performed by spawning each of the four quadrant
  * grid entities in the appropriate positions.
@@ -879,20 +885,23 @@ function spawnGiantPoop(topLeftGridIndex) {
     const topRight = spawnGridEntityWithVariant(isaac_typescript_definitions_1.GridEntityType.POOP, isaac_typescript_definitions_1.PoopGridEntityVariant.GIANT_TOP_RIGHT, topRightGridIndex);
     const bottomLeft = spawnGridEntityWithVariant(isaac_typescript_definitions_1.GridEntityType.POOP, isaac_typescript_definitions_1.PoopGridEntityVariant.GIANT_BOTTOM_LEFT, bottomLeftGridIndex);
     const bottomRight = spawnGridEntityWithVariant(isaac_typescript_definitions_1.GridEntityType.POOP, isaac_typescript_definitions_1.PoopGridEntityVariant.GIANT_BOTTOM_RIGHT, bottomRightGridIndex);
-    return (topLeft !== undefined &&
-        topLeft.GetType() === isaac_typescript_definitions_1.GridEntityType.POOP &&
-        topLeft.GetVariant() === isaac_typescript_definitions_1.PoopGridEntityVariant.GIANT_TOP_LEFT &&
-        topRight !== undefined &&
-        topRight.GetType() === isaac_typescript_definitions_1.GridEntityType.POOP &&
-        topRight.GetVariant() === isaac_typescript_definitions_1.PoopGridEntityVariant.GIANT_TOP_RIGHT &&
-        bottomLeft !== undefined &&
-        bottomLeft.GetType() === isaac_typescript_definitions_1.GridEntityType.POOP &&
-        bottomLeft.GetVariant() === isaac_typescript_definitions_1.PoopGridEntityVariant.GIANT_BOTTOM_LEFT &&
-        bottomRight !== undefined &&
-        bottomRight.GetType() === isaac_typescript_definitions_1.GridEntityType.POOP &&
-        bottomRight.GetVariant() === isaac_typescript_definitions_1.PoopGridEntityVariant.GIANT_BOTTOM_RIGHT);
+    return (topLeft !== undefined
+        && topLeft.GetType() === isaac_typescript_definitions_1.GridEntityType.POOP
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+        && topLeft.GetVariant() === isaac_typescript_definitions_1.PoopGridEntityVariant.GIANT_TOP_LEFT
+        && topRight !== undefined
+        && topRight.GetType() === isaac_typescript_definitions_1.GridEntityType.POOP
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+        && topRight.GetVariant() === isaac_typescript_definitions_1.PoopGridEntityVariant.GIANT_TOP_RIGHT
+        && bottomLeft !== undefined
+        && bottomLeft.GetType() === isaac_typescript_definitions_1.GridEntityType.POOP
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+        && bottomLeft.GetVariant() === isaac_typescript_definitions_1.PoopGridEntityVariant.GIANT_BOTTOM_LEFT
+        && bottomRight !== undefined
+        && bottomRight.GetType() === isaac_typescript_definitions_1.GridEntityType.POOP
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+        && bottomRight.GetVariant() === isaac_typescript_definitions_1.PoopGridEntityVariant.GIANT_BOTTOM_RIGHT);
 }
-exports.spawnGiantPoop = spawnGiantPoop;
 /**
  * Helper function to spawn a grid entity with a specific type.
  *
@@ -916,7 +925,6 @@ exports.spawnGiantPoop = spawnGiantPoop;
 function spawnGridEntity(gridEntityType, gridIndexOrPosition, removeExistingGridEntity = true) {
     return spawnGridEntityWithVariant(gridEntityType, 0, gridIndexOrPosition, removeExistingGridEntity);
 }
-exports.spawnGridEntity = spawnGridEntity;
 /**
  * Helper function to spawn a grid entity with a specific variant.
  *
@@ -976,7 +984,6 @@ function spawnGridEntityWithVariant(gridEntityType, variant, gridIndexOrPosition
     }
     return gridEntity;
 }
-exports.spawnGridEntityWithVariant = spawnGridEntityWithVariant;
 /**
  * Helper function to spawn a Void Portal. This is more complicated than simply spawning a trapdoor
  * with the appropriate variant, as the game does not give it the correct sprite automatically.
@@ -993,4 +1000,3 @@ function spawnVoidPortal(gridIndex) {
     sprite.Load("gfx/grid/voidtrapdoor.anm2", true);
     return voidPortal;
 }
-exports.spawnVoidPortal = spawnVoidPortal;