isaacscript-common 52.0.0 → 52.0.1

package/src/functions/gridEntities.ts

@@ -17,7 +17,7 @@ import {
   DEFAULT_TOP_LEFT_WALL_GRID_INDEX,
   ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP,
 } from "../maps/roomShapeToTopLeftWallGridIndexMap";
-import { GRID_ENTITY_TYPE_TO_ANM2_PATH } from "../objects/gridEntityTypeToANM2Path";
+import { GRID_ENTITY_TYPE_TO_ANM2_NAME } from "../objects/gridEntityTypeToANM2Name";
 import { POOP_GRID_ENTITY_XML_TYPES_SET } from "../sets/poopGridEntityXMLTypesSet";
 import type { AnyGridEntity } from "../types/AnyGridEntity";
 import type { GridEntityID } from "../types/GridEntityID";
@@ -341,15 +341,22 @@ export function getGridEntitiesMap(
 /** Helper function to get the ANM2 path for a grid entity type. */
 export function getGridEntityANM2Path(
   gridEntityType: GridEntityType,
+): string | undefined {
+  const gridEntityANM2Name = getGridEntityANM2Name(gridEntityType);
+  return `gfx/grid/${gridEntityANM2Name}`;
+}
+
+function getGridEntityANM2Name(
+  gridEntityType: GridEntityType,
 ): string | undefined {
   switch (gridEntityType) {
     // 1
     case GridEntityType.DECORATION: {
-      return getGridEntityANM2PathDecoration();
+      return getGridEntityANM2NameDecoration();
     }
 
     default: {
-      return GRID_ENTITY_TYPE_TO_ANM2_PATH[gridEntityType];
+      return GRID_ENTITY_TYPE_TO_ANM2_NAME[gridEntityType];
     }
   }
 }
@@ -358,7 +365,7 @@ export function getGridEntityANM2Path(
  * Helper function to get the ANM2 path for a decoration. This depends on the current room's
  * backdrop. The values are taken from the "backdrops.xml" file.
  */
-export function getGridEntityANM2PathDecoration(): string {
+function getGridEntityANM2NameDecoration(): string {
   const room = game.GetRoom();
   const backdropType = room.GetBackdropType();
 
@@ -370,7 +377,7 @@ export function getGridEntityANM2PathDecoration(): string {
     case BackdropType.DOWNPOUR_ENTRANCE:
     case BackdropType.ISAACS_BEDROOM:
     case BackdropType.CLOSET: {
-      return "gfx/grid/Props_01_Basement.anm2";
+      return "Props_01_Basement.anm2";
     }
 
     // 4, 5, 6, 37
@@ -378,7 +385,7 @@ export function getGridEntityANM2PathDecoration(): string {
     case BackdropType.CATACOMBS:
     case BackdropType.FLOODED_CAVES:
     case BackdropType.MINES_ENTRANCE: {
-      return "gfx/grid/Props_03_Caves.anm2";
+      return "Props_03_Caves.anm2";
     }
 
     // 7, 8, 9, 30, 33, 38, 39, 40, 41, 42, 53, 60
@@ -394,50 +401,50 @@ export function getGridEntityANM2PathDecoration(): string {
     case BackdropType.MAUSOLEUM_4:
     case BackdropType.CLOSET_B:
     case BackdropType.DARK_CLOSET: {
-      return "gfx/grid/Props_05_Depths.anm2";
+      return "Props_05_Depths.anm2";
     }
 
     // 10, 12
     case BackdropType.WOMB:
     case BackdropType.SCARRED_WOMB: {
-      return "gfx/grid/Props_07_The Womb.anm2";
+      return "Props_07_The Womb.anm2";
     }
 
     // 11
     case BackdropType.UTERO: {
-      return "gfx/grid/Props_07_Utero.anm2";
+      return "Props_07_Utero.anm2";
     }
 
     // 13, 27
     case BackdropType.BLUE_WOMB:
     case BackdropType.BLUE_WOMB_PASS: {
-      return "gfx/grid/Props_07_The Womb_blue.anm2";
+      return "Props_07_The Womb_blue.anm2";
     }
 
     // 14, 47
     case BackdropType.SHEOL:
     case BackdropType.GEHENNA: {
-      return "gfx/grid/Props_09_Sheol.anm2";
+      return "Props_09_Sheol.anm2";
     }
 
     // 15
     case BackdropType.CATHEDRAL: {
-      return "gfx/grid/Props_10_Cathedral.anm2";
+      return "Props_10_Cathedral.anm2";
     }
 
     // 17
     case BackdropType.CHEST: {
-      return "gfx/grid/Props_11_The Chest.anm2";
+      return "Props_11_The Chest.anm2";
     }
 
     // 28
     case BackdropType.GREED_SHOP: {
-      return "gfx/grid/Props_12_Greed.anm2";
+      return "Props_12_Greed.anm2";
     }
 
     // 31
     case BackdropType.DOWNPOUR: {
-      return "gfx/grid/props_01x_downpour.anm2";
+      return "props_01x_downpour.anm2";
     }
 
     // 32, 46, 58, 59
@@ -445,7 +452,7 @@ export function getGridEntityANM2PathDecoration(): string {
     case BackdropType.ASHPIT:
     case BackdropType.MINES_SHAFT:
     case BackdropType.ASHPIT_SHAFT: {
-      return "gfx/grid/props_03x_mines.anm2";
+      return "props_03x_mines.anm2";
     }
 
     // 34, 43, 44, 48
@@ -453,16 +460,16 @@ export function getGridEntityANM2PathDecoration(): string {
     case BackdropType.CORPSE_2:
     case BackdropType.CORPSE_3:
     case BackdropType.MORTIS: {
-      return "gfx/grid/props_07_the corpse.anm2";
+      return "props_07_the corpse.anm2";
     }
 
     // 45
     case BackdropType.DROSS: {
-      return "gfx/grid/props_02x_dross.anm2";
+      return "props_02x_dross.anm2";
     }
 
     default: {
-      return "gfx/grid/Props_01_Basement.anm2";
+      return "Props_01_Basement.anm2";
     }
   }
 }
@@ -521,8 +528,15 @@ export function 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.
+ *
+ * All of the rock PNGs are in the "gfx/grid" directory.
  */
 export function getRockPNGPath(): string {
+  const rockPNGName = getRockPNGName();
+  return `gfx/grid/${rockPNGName}`;
+}
+
+function getRockPNGName(): string {
   const room = game.GetRoom();
   const backdropType = room.GetBackdropType();
 

package/src/objects/gridEntityTypeToANM2Name.ts

@@ -0,0 +1,36 @@
+import { GridEntityType } from "isaac-typescript-definitions";
+
+// cspell:disable
+
+/** These files exist in the "gfx/grid" directory. */
+export const GRID_ENTITY_TYPE_TO_ANM2_NAME = {
+  [GridEntityType.NULL]: undefined, // 0
+  // There are more decoration ANM2 files; see the `getGridEntityANM2Path` function.
+  [GridEntityType.DECORATION]: "Props_01_Basement.anm2", // 1
+  [GridEntityType.ROCK]: "grid_rock.anm2", // 2
+  [GridEntityType.BLOCK]: "grid_rock.anm2", // 3
+  [GridEntityType.ROCK_TINTED]: "grid_rock.anm2", // 4
+  [GridEntityType.ROCK_BOMB]: "grid_rock.anm2", // 5
+  [GridEntityType.ROCK_ALT]: "grid_rock.anm2", // 6
+  [GridEntityType.PIT]: "grid_pit.anm2", // 7
+  [GridEntityType.SPIKES]: "grid_spikes.anm2", // 8
+  [GridEntityType.SPIKES_ON_OFF]: "grid_spikes.anm2", // 9
+  [GridEntityType.SPIDER_WEB]: "grid_web.anm2", // 10
+  [GridEntityType.LOCK]: "grid_locks.anm2", // 11
+  [GridEntityType.TNT]: "grid_tnt.anm2", // 12
+  [GridEntityType.FIREPLACE]: "grid_fireplace.anm2", // 13
+  [GridEntityType.POOP]: "grid_poop.anm2", // 14
+  [GridEntityType.WALL]: undefined, // 15
+  [GridEntityType.DOOR]: undefined, // 16
+  [GridEntityType.TRAPDOOR]: "Door_11_TrapDoor.anm2", // 17
+  [GridEntityType.CRAWL_SPACE]: "door_20_secrettrapdoor.anm2", // 18
+  [GridEntityType.GRAVITY]: undefined, // 19
+  [GridEntityType.PRESSURE_PLATE]: "grid_pressureplate.anm2", // 20
+  [GridEntityType.STATUE]: undefined, // 21
+  [GridEntityType.ROCK_SUPER_SPECIAL]: "grid_rock.anm2", // 22
+  [GridEntityType.TELEPORTER]: "grid_teleporter.anm2", // 23
+  [GridEntityType.PILLAR]: "grid_rock.anm2", // 24
+  [GridEntityType.ROCK_SPIKED]: "grid_rock.anm2", // 25
+  [GridEntityType.ROCK_ALT_2]: "grid_rock.anm2", // 26
+  [GridEntityType.ROCK_GOLD]: "grid_rock.anm2", // 27
+} as const satisfies Record<GridEntityType, string | undefined>;

package/dist/src/objects/gridEntityTypeToANM2Path.d.ts

@@ -1,31 +0,0 @@
-export declare const GRID_ENTITY_TYPE_TO_ANM2_PATH: {
-    readonly 0: undefined;
-    readonly 1: "gfx/grid/Props_01_Basement.anm2";
-    readonly 2: "gfx/grid/grid_rock.anm2";
-    readonly 3: "gfx/grid/grid_rock.anm2";
-    readonly 4: "gfx/grid/grid_rock.anm2";
-    readonly 5: "gfx/grid/grid_rock.anm2";
-    readonly 6: "gfx/grid/grid_rock.anm2";
-    readonly 7: "gfx/grid/grid_pit.anm2";
-    readonly 8: "gfx/grid/grid_spikes.anm2";
-    readonly 9: "gfx/grid/grid_spikes.anm2";
-    readonly 10: "gfx/grid/grid_web.anm2";
-    readonly 11: "gfx/grid/grid_locks.anm2";
-    readonly 12: "gfx/grid/grid_tnt.anm2";
-    readonly 13: "gfx/grid/grid_fireplace.anm2";
-    readonly 14: "gfx/grid/grid_poop.anm2";
-    readonly 15: undefined;
-    readonly 16: undefined;
-    readonly 17: "gfx/grid/Door_11_TrapDoor.anm2";
-    readonly 18: "gfx/grid/door_20_secrettrapdoor.anm2";
-    readonly 19: undefined;
-    readonly 20: "gfx/grid/grid_pressureplate.anm2";
-    readonly 21: undefined;
-    readonly 22: "gfx/grid/grid_rock.anm2";
-    readonly 23: "gfx/grid/grid_teleporter.anm2";
-    readonly 24: "gfx/grid/grid_rock.anm2";
-    readonly 25: "gfx/grid/grid_rock.anm2";
-    readonly 26: "gfx/grid/grid_rock.anm2";
-    readonly 27: "gfx/grid/grid_rock.anm2";
-};
-//# sourceMappingURL=gridEntityTypeToANM2Path.d.ts.map

package/dist/src/objects/gridEntityTypeToANM2Path.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"gridEntityTypeToANM2Path.d.ts","sourceRoot":"","sources":["../../../src/objects/gridEntityTypeToANM2Path.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8BqB,CAAC"}

package/dist/src/objects/gridEntityTypeToANM2Path.lua

@@ -1,34 +0,0 @@
-local ____exports = {}
-local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
-local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
-____exports.GRID_ENTITY_TYPE_TO_ANM2_PATH = {
-    [GridEntityType.NULL] = nil,
-    [GridEntityType.DECORATION] = "gfx/grid/Props_01_Basement.anm2",
-    [GridEntityType.ROCK] = "gfx/grid/grid_rock.anm2",
-    [GridEntityType.BLOCK] = "gfx/grid/grid_rock.anm2",
-    [GridEntityType.ROCK_TINTED] = "gfx/grid/grid_rock.anm2",
-    [GridEntityType.ROCK_BOMB] = "gfx/grid/grid_rock.anm2",
-    [GridEntityType.ROCK_ALT] = "gfx/grid/grid_rock.anm2",
-    [GridEntityType.PIT] = "gfx/grid/grid_pit.anm2",
-    [GridEntityType.SPIKES] = "gfx/grid/grid_spikes.anm2",
-    [GridEntityType.SPIKES_ON_OFF] = "gfx/grid/grid_spikes.anm2",
-    [GridEntityType.SPIDER_WEB] = "gfx/grid/grid_web.anm2",
-    [GridEntityType.LOCK] = "gfx/grid/grid_locks.anm2",
-    [GridEntityType.TNT] = "gfx/grid/grid_tnt.anm2",
-    [GridEntityType.FIREPLACE] = "gfx/grid/grid_fireplace.anm2",
-    [GridEntityType.POOP] = "gfx/grid/grid_poop.anm2",
-    [GridEntityType.WALL] = nil,
-    [GridEntityType.DOOR] = nil,
-    [GridEntityType.TRAPDOOR] = "gfx/grid/Door_11_TrapDoor.anm2",
-    [GridEntityType.CRAWL_SPACE] = "gfx/grid/door_20_secrettrapdoor.anm2",
-    [GridEntityType.GRAVITY] = nil,
-    [GridEntityType.PRESSURE_PLATE] = "gfx/grid/grid_pressureplate.anm2",
-    [GridEntityType.STATUE] = nil,
-    [GridEntityType.ROCK_SUPER_SPECIAL] = "gfx/grid/grid_rock.anm2",
-    [GridEntityType.TELEPORTER] = "gfx/grid/grid_teleporter.anm2",
-    [GridEntityType.PILLAR] = "gfx/grid/grid_rock.anm2",
-    [GridEntityType.ROCK_SPIKED] = "gfx/grid/grid_rock.anm2",
-    [GridEntityType.ROCK_ALT_2] = "gfx/grid/grid_rock.anm2",
-    [GridEntityType.ROCK_GOLD] = "gfx/grid/grid_rock.anm2"
-}
-return ____exports

package/src/objects/gridEntityTypeToANM2Path.ts

@@ -1,35 +0,0 @@
-import { GridEntityType } from "isaac-typescript-definitions";
-
-// cspell:disable
-
-export const GRID_ENTITY_TYPE_TO_ANM2_PATH = {
-  [GridEntityType.NULL]: undefined, // 0
-  // There are more decoration ANM2 files; see the `getGridEntityANM2Path` function.
-  [GridEntityType.DECORATION]: "gfx/grid/Props_01_Basement.anm2", // 1
-  [GridEntityType.ROCK]: "gfx/grid/grid_rock.anm2", // 2
-  [GridEntityType.BLOCK]: "gfx/grid/grid_rock.anm2", // 3
-  [GridEntityType.ROCK_TINTED]: "gfx/grid/grid_rock.anm2", // 4
-  [GridEntityType.ROCK_BOMB]: "gfx/grid/grid_rock.anm2", // 5
-  [GridEntityType.ROCK_ALT]: "gfx/grid/grid_rock.anm2", // 6
-  [GridEntityType.PIT]: "gfx/grid/grid_pit.anm2", // 7
-  [GridEntityType.SPIKES]: "gfx/grid/grid_spikes.anm2", // 8
-  [GridEntityType.SPIKES_ON_OFF]: "gfx/grid/grid_spikes.anm2", // 9
-  [GridEntityType.SPIDER_WEB]: "gfx/grid/grid_web.anm2", // 10
-  [GridEntityType.LOCK]: "gfx/grid/grid_locks.anm2", // 11
-  [GridEntityType.TNT]: "gfx/grid/grid_tnt.anm2", // 12
-  [GridEntityType.FIREPLACE]: "gfx/grid/grid_fireplace.anm2", // 13
-  [GridEntityType.POOP]: "gfx/grid/grid_poop.anm2", // 14
-  [GridEntityType.WALL]: undefined, // 15
-  [GridEntityType.DOOR]: undefined, // 16
-  [GridEntityType.TRAPDOOR]: "gfx/grid/Door_11_TrapDoor.anm2", // 17
-  [GridEntityType.CRAWL_SPACE]: "gfx/grid/door_20_secrettrapdoor.anm2", // 18
-  [GridEntityType.GRAVITY]: undefined, // 19
-  [GridEntityType.PRESSURE_PLATE]: "gfx/grid/grid_pressureplate.anm2", // 20
-  [GridEntityType.STATUE]: undefined, // 21
-  [GridEntityType.ROCK_SUPER_SPECIAL]: "gfx/grid/grid_rock.anm2", // 22
-  [GridEntityType.TELEPORTER]: "gfx/grid/grid_teleporter.anm2", // 23
-  [GridEntityType.PILLAR]: "gfx/grid/grid_rock.anm2", // 24
-  [GridEntityType.ROCK_SPIKED]: "gfx/grid/grid_rock.anm2", // 25
-  [GridEntityType.ROCK_ALT_2]: "gfx/grid/grid_rock.anm2", // 26
-  [GridEntityType.ROCK_GOLD]: "gfx/grid/grid_rock.anm2", // 27
-} as const satisfies Record<GridEntityType, string | undefined>;