isaacscript-common 51.2.3 → 51.3.0

package/dist/index.rollup.d.ts

@@ -75,7 +75,7 @@ import { RoomTransitionAnim } from 'isaac-typescript-definitions';
 import { RoomType } from 'isaac-typescript-definitions';
 import type { SackSubType } from 'isaac-typescript-definitions';
 import { SeedEffect } from 'isaac-typescript-definitions';
-import type { SlotVariant } from 'isaac-typescript-definitions';
+import { SlotVariant } from 'isaac-typescript-definitions';
 import type { StageID } from 'isaac-typescript-definitions';
 import { StageType } from 'isaac-typescript-definitions';
 import { TearFlag } from 'isaac-typescript-definitions';
@@ -7427,6 +7427,17 @@ export declare function getShootActions(controllerIndex: ControllerIndex): Butto
  */
 export declare function getSirenHelper(familiar: EntityFamiliar): Entity | undefined;
 
+/**
+ * Helper function to get the name of a slot, as listed in the "entities2.xml" file. Returns
+ * "Unknown" if the provided slot variant is not valid.
+ *
+ * This function only works for vanilla slot variants.
+ *
+ * For example, `getSlotName(SlotVariant.BLOOD_DONATION_MACHINE)` would return "Blood Donation
+ * Machine".
+ */
+export declare function getSlotName(slotVariant: SlotVariant): string;
+
 /**
  * Helper function to get all of the slots in the room.
  *

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 51.2.3
+isaacscript-common 51.3.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -39681,6 +39681,33 @@ function PlayerReorderedCallbacks.prototype.____constructor(self, postPEffectUpd
     self.postPlayerRenderReordered = postPlayerRenderReordered
     self.postPlayerUpdateReordered = postPlayerUpdateReordered
 end
+return ____exports
+ end,
+["src.objects.slotNames"] = function(...) 
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
+local SlotVariant = ____isaac_2Dtypescript_2Ddefinitions.SlotVariant
+____exports.DEFAULT_SLOT_NAME = "Unknown"
+____exports.SLOT_NAMES = {
+    [SlotVariant.SLOT_MACHINE] = "Slot Machine",
+    [SlotVariant.BLOOD_DONATION_MACHINE] = "Blood Donation Machine",
+    [SlotVariant.FORTUNE_TELLING_MACHINE] = "Fortune Telling Machine",
+    [SlotVariant.BEGGAR] = "Beggar",
+    [SlotVariant.DEVIL_BEGGAR] = "Devil Beggar",
+    [SlotVariant.SHELL_GAME] = "Shell Game",
+    [SlotVariant.KEY_MASTER] = "Key Master",
+    [SlotVariant.DONATION_MACHINE] = "Donation Machine",
+    [SlotVariant.BOMB_BUM] = "Bomb Bum",
+    [SlotVariant.SHOP_RESTOCK_MACHINE] = "Shop Restock Machine",
+    [SlotVariant.GREED_DONATION_MACHINE] = "Greed Donation Machine",
+    [SlotVariant.MOMS_DRESSING_TABLE] = "Mom's Dressing Table",
+    [SlotVariant.BATTERY_BUM] = "Battery Bum",
+    [SlotVariant.ISAAC_SECRET] = "Isaac (secret)",
+    [SlotVariant.HELL_GAME] = "Hell Game",
+    [SlotVariant.CRANE_GAME] = "Crane Game",
+    [SlotVariant.CONFESSIONAL] = "Confessional",
+    [SlotVariant.ROTTEN_BEGGAR] = "Rotten Beggar"
+}
 return ____exports
  end,
 ["src.functions.slots"] = function(...) 
@@ -39689,6 +39716,9 @@ local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
 local SlotVariant = ____isaac_2Dtypescript_2Ddefinitions.SlotVariant
+local ____slotNames = require("src.objects.slotNames")
+local DEFAULT_SLOT_NAME = ____slotNames.DEFAULT_SLOT_NAME
+local SLOT_NAMES = ____slotNames.SLOT_NAMES
 local ____ReadonlySet = require("src.types.ReadonlySet")
 local ReadonlySet = ____ReadonlySet.ReadonlySet
 local ____entityTypes = require("src.functions.entityTypes")
@@ -39704,6 +39734,9 @@ local SLOT_MACHINE_VARIANTS = __TS__New(ReadonlySet, {
     SlotVariant.CRANE_GAME,
     SlotVariant.CONFESSIONAL
 })
+function ____exports.getSlotName(self, slotVariant)
+    return SLOT_NAMES[slotVariant] or DEFAULT_SLOT_NAME
+end
 function ____exports.isSlotMachine(self, entity)
     if not isSlot(nil, entity) then
         return false
@@ -39921,6 +39954,7 @@ return ____exports
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
 local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
+____exports.DEFAULT_CHEST_NAME = "Unknown"
 ____exports.CHEST_NAMES = {
     [PickupVariant.CHEST] = "Chest",
     [PickupVariant.BOMB_CHEST] = "Bomb Chest",
@@ -40394,6 +40428,7 @@ local BOMB_NAMES = ____bombNames.BOMB_NAMES
 local DEFAULT_BOMB_NAME = ____bombNames.DEFAULT_BOMB_NAME
 local ____chestNames = require("src.objects.chestNames")
 local CHEST_NAMES = ____chestNames.CHEST_NAMES
+local DEFAULT_CHEST_NAME = ____chestNames.DEFAULT_CHEST_NAME
 local ____coinNames = require("src.objects.coinNames")
 local COIN_NAMES = ____coinNames.COIN_NAMES
 local DEFAULT_COIN_NAME = ____coinNames.DEFAULT_COIN_NAME
@@ -40428,7 +40463,7 @@ function ____exports.getBombName(self, bombSubType)
 end
 function ____exports.getChestName(self, pickupVariant)
     local chestNames = CHEST_NAMES
-    return chestNames[pickupVariant] or "Unknown"
+    return chestNames[pickupVariant] or DEFAULT_CHEST_NAME
 end
 function ____exports.getCoinName(self, coinSubType)
     return COIN_NAMES[coinSubType] or DEFAULT_COIN_NAME

package/dist/src/functions/pickups.lua

@@ -11,6 +11,7 @@ local BOMB_NAMES = ____bombNames.BOMB_NAMES
 local DEFAULT_BOMB_NAME = ____bombNames.DEFAULT_BOMB_NAME
 local ____chestNames = require("src.objects.chestNames")
 local CHEST_NAMES = ____chestNames.CHEST_NAMES
+local DEFAULT_CHEST_NAME = ____chestNames.DEFAULT_CHEST_NAME
 local ____coinNames = require("src.objects.coinNames")
 local COIN_NAMES = ____coinNames.COIN_NAMES
 local DEFAULT_COIN_NAME = ____coinNames.DEFAULT_COIN_NAME
@@ -64,7 +65,7 @@ end
 -- For example, `getChestName(PickupVariant.SPIKED_CHEST)` would return "Spiked Chest".
 function ____exports.getChestName(self, pickupVariant)
     local chestNames = CHEST_NAMES
-    return chestNames[pickupVariant] or "Unknown"
+    return chestNames[pickupVariant] or DEFAULT_CHEST_NAME
 end
 --- Helper function to get the name of a coin, as listed in the "entities2.xml" file. Returns
 -- "Unknown" if the provided coin sub-type is not valid.

package/dist/src/functions/slots.d.ts

@@ -1,4 +1,14 @@
-/// <reference types="isaac-typescript-definitions" />
+import { SlotVariant } from "isaac-typescript-definitions";
+/**
+ * Helper function to get the name of a slot, as listed in the "entities2.xml" file. Returns
+ * "Unknown" if the provided slot variant is not valid.
+ *
+ * This function only works for vanilla slot variants.
+ *
+ * For example, `getSlotName(SlotVariant.BLOOD_DONATION_MACHINE)` would return "Blood Donation
+ * Machine".
+ */
+export declare function getSlotName(slotVariant: SlotVariant): string;
 /** Returns true for the specific variants of `EntityType.SLOT` that are machines. */
 export declare function isSlotMachine(entity: Entity): boolean;
 //# sourceMappingURL=slots.d.ts.map

package/dist/src/functions/slots.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"slots.d.ts","sourceRoot":"","sources":["../../../src/functions/slots.ts"],"names":[],"mappings":";AAgBA,qFAAqF;AACrF,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAMrD"}
+{"version":3,"file":"slots.d.ts","sourceRoot":"","sources":["../../../src/functions/slots.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAiB3D;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAI5D;AAED,qFAAqF;AACrF,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAMrD"}

package/dist/src/functions/slots.lua

@@ -3,6 +3,9 @@ local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local SlotVariant = ____isaac_2Dtypescript_2Ddefinitions.SlotVariant
+local ____slotNames = require("src.objects.slotNames")
+local DEFAULT_SLOT_NAME = ____slotNames.DEFAULT_SLOT_NAME
+local SLOT_NAMES = ____slotNames.SLOT_NAMES
 local ____ReadonlySet = require("src.types.ReadonlySet")
 local ReadonlySet = ____ReadonlySet.ReadonlySet
 local ____entityTypes = require("src.functions.entityTypes")
@@ -18,6 +21,16 @@ local SLOT_MACHINE_VARIANTS = __TS__New(ReadonlySet, {
     SlotVariant.CRANE_GAME,
     SlotVariant.CONFESSIONAL
 })
+--- Helper function to get the name of a slot, as listed in the "entities2.xml" file. Returns
+-- "Unknown" if the provided slot variant is not valid.
+-- 
+-- This function only works for vanilla slot variants.
+-- 
+-- For example, `getSlotName(SlotVariant.BLOOD_DONATION_MACHINE)` would return "Blood Donation
+-- Machine".
+function ____exports.getSlotName(self, slotVariant)
+    return SLOT_NAMES[slotVariant] or DEFAULT_SLOT_NAME
+end
 --- Returns true for the specific variants of `EntityType.SLOT` that are machines.
 function ____exports.isSlotMachine(self, entity)
     if not isSlot(nil, entity) then

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

@@ -1,3 +1,4 @@
+export declare const DEFAULT_CHEST_NAME = "Unknown";
 /** Taken from "entities2.xml". */
 export declare const CHEST_NAMES: {
     readonly 50: "Chest";

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

@@ -1 +1 @@
-{"version":3,"file":"chestNames.d.ts","sourceRoot":"","sources":["../../../src/objects/chestNames.ts"],"names":[],"mappings":"AAGA,kCAAkC;AAClC,eAAO,MAAM,WAAW;;;;;;;;;;;;;CAamD,CAAC"}
+{"version":3,"file":"chestNames.d.ts","sourceRoot":"","sources":["../../../src/objects/chestNames.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,kBAAkB,YAAY,CAAC;AAE5C,kCAAkC;AAClC,eAAO,MAAM,WAAW;;;;;;;;;;;;;CAamD,CAAC"}

package/dist/src/objects/chestNames.lua

@@ -1,6 +1,7 @@
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
+____exports.DEFAULT_CHEST_NAME = "Unknown"
 --- Taken from "entities2.xml".
 ____exports.CHEST_NAMES = {
     [PickupVariant.CHEST] = "Chest",

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

@@ -0,0 +1,23 @@
+export declare const DEFAULT_SLOT_NAME = "Unknown";
+/** Taken from "entities2.xml". */
+export declare const SLOT_NAMES: {
+    readonly 1: "Slot Machine";
+    readonly 2: "Blood Donation Machine";
+    readonly 3: "Fortune Telling Machine";
+    readonly 4: "Beggar";
+    readonly 5: "Devil Beggar";
+    readonly 6: "Shell Game";
+    readonly 7: "Key Master";
+    readonly 8: "Donation Machine";
+    readonly 9: "Bomb Bum";
+    readonly 10: "Shop Restock Machine";
+    readonly 11: "Greed Donation Machine";
+    readonly 12: "Mom's Dressing Table";
+    readonly 13: "Battery Bum";
+    readonly 14: "Isaac (secret)";
+    readonly 15: "Hell Game";
+    readonly 16: "Crane Game";
+    readonly 17: "Confessional";
+    readonly 18: "Rotten Beggar";
+};
+//# sourceMappingURL=slotNames.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"slotNames.d.ts","sourceRoot":"","sources":["../../../src/objects/slotNames.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,iBAAiB,YAAY,CAAC;AAE3C,kCAAkC;AAClC,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;CAmByB,CAAC"}

package/dist/src/objects/slotNames.lua

@@ -0,0 +1,26 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local SlotVariant = ____isaac_2Dtypescript_2Ddefinitions.SlotVariant
+____exports.DEFAULT_SLOT_NAME = "Unknown"
+--- Taken from "entities2.xml".
+____exports.SLOT_NAMES = {
+    [SlotVariant.SLOT_MACHINE] = "Slot Machine",
+    [SlotVariant.BLOOD_DONATION_MACHINE] = "Blood Donation Machine",
+    [SlotVariant.FORTUNE_TELLING_MACHINE] = "Fortune Telling Machine",
+    [SlotVariant.BEGGAR] = "Beggar",
+    [SlotVariant.DEVIL_BEGGAR] = "Devil Beggar",
+    [SlotVariant.SHELL_GAME] = "Shell Game",
+    [SlotVariant.KEY_MASTER] = "Key Master",
+    [SlotVariant.DONATION_MACHINE] = "Donation Machine",
+    [SlotVariant.BOMB_BUM] = "Bomb Bum",
+    [SlotVariant.SHOP_RESTOCK_MACHINE] = "Shop Restock Machine",
+    [SlotVariant.GREED_DONATION_MACHINE] = "Greed Donation Machine",
+    [SlotVariant.MOMS_DRESSING_TABLE] = "Mom's Dressing Table",
+    [SlotVariant.BATTERY_BUM] = "Battery Bum",
+    [SlotVariant.ISAAC_SECRET] = "Isaac (secret)",
+    [SlotVariant.HELL_GAME] = "Hell Game",
+    [SlotVariant.CRANE_GAME] = "Crane Game",
+    [SlotVariant.CONFESSIONAL] = "Confessional",
+    [SlotVariant.ROTTEN_BEGGAR] = "Rotten Beggar"
+}
+return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "51.2.3",
+  "version": "51.3.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/functions/pickups.ts

@@ -10,7 +10,7 @@ import type {
 import { CHEST_PICKUP_VARIANTS_SET } from "../core/constants";
 import { BATTERY_NAMES, DEFAULT_BATTERY_NAME } from "../objects/batteryNames";
 import { BOMB_NAMES, DEFAULT_BOMB_NAME } from "../objects/bombNames";
-import { CHEST_NAMES } from "../objects/chestNames";
+import { CHEST_NAMES, DEFAULT_CHEST_NAME } from "../objects/chestNames";
 import { COIN_NAMES, DEFAULT_COIN_NAME } from "../objects/coinNames";
 import {
   COIN_SUB_TYPE_TO_VALUE,
@@ -62,7 +62,7 @@ export function getBombName(bombSubType: BombSubType): string {
  */
 export function getChestName(pickupVariant: PickupVariant): string {
   const chestNames = CHEST_NAMES as Partial<Record<PickupVariant, string>>;
-  return chestNames[pickupVariant] ?? "Unknown";
+  return chestNames[pickupVariant] ?? DEFAULT_CHEST_NAME;
 }
 
 /**

package/src/functions/slots.ts

@@ -1,4 +1,5 @@
 import { SlotVariant } from "isaac-typescript-definitions";
+import { DEFAULT_SLOT_NAME, SLOT_NAMES } from "../objects/slotNames";
 import { ReadonlySet } from "../types/ReadonlySet";
 import { isSlot } from "./entityTypes";
 
@@ -14,6 +15,21 @@ const SLOT_MACHINE_VARIANTS = new ReadonlySet<SlotVariant>([
   SlotVariant.CONFESSIONAL, // 17
 ]);
 
+/**
+ * Helper function to get the name of a slot, as listed in the "entities2.xml" file. Returns
+ * "Unknown" if the provided slot variant is not valid.
+ *
+ * This function only works for vanilla slot variants.
+ *
+ * For example, `getSlotName(SlotVariant.BLOOD_DONATION_MACHINE)` would return "Blood Donation
+ * Machine".
+ */
+export function getSlotName(slotVariant: SlotVariant): string {
+  // Handle modded slots.
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+  return SLOT_NAMES[slotVariant] ?? DEFAULT_SLOT_NAME;
+}
+
 /** Returns true for the specific variants of `EntityType.SLOT` that are machines. */
 export function isSlotMachine(entity: Entity): boolean {
   if (!isSlot(entity)) {

package/src/objects/chestNames.ts

@@ -1,6 +1,8 @@
 import { PickupVariant } from "isaac-typescript-definitions";
 import type { CHEST_PICKUP_VARIANTS } from "../core/constants";
 
+export const DEFAULT_CHEST_NAME = "Unknown";
+
 /** Taken from "entities2.xml". */
 export const CHEST_NAMES = {
   [PickupVariant.CHEST]: "Chest", // 50

package/src/objects/slotNames.ts

@@ -0,0 +1,25 @@
+import { SlotVariant } from "isaac-typescript-definitions";
+
+export const DEFAULT_SLOT_NAME = "Unknown";
+
+/** Taken from "entities2.xml". */
+export const SLOT_NAMES = {
+  [SlotVariant.SLOT_MACHINE]: "Slot Machine", // 1
+  [SlotVariant.BLOOD_DONATION_MACHINE]: "Blood Donation Machine", // 2
+  [SlotVariant.FORTUNE_TELLING_MACHINE]: "Fortune Telling Machine", // 3
+  [SlotVariant.BEGGAR]: "Beggar", // 4
+  [SlotVariant.DEVIL_BEGGAR]: "Devil Beggar", // 5
+  [SlotVariant.SHELL_GAME]: "Shell Game", // 6
+  [SlotVariant.KEY_MASTER]: "Key Master", // 7
+  [SlotVariant.DONATION_MACHINE]: "Donation Machine", // 8
+  [SlotVariant.BOMB_BUM]: "Bomb Bum", // 9
+  [SlotVariant.SHOP_RESTOCK_MACHINE]: "Shop Restock Machine", // 10
+  [SlotVariant.GREED_DONATION_MACHINE]: "Greed Donation Machine", // 11
+  [SlotVariant.MOMS_DRESSING_TABLE]: "Mom's Dressing Table", // 12
+  [SlotVariant.BATTERY_BUM]: "Battery Bum", // 13
+  [SlotVariant.ISAAC_SECRET]: "Isaac (secret)", // 14
+  [SlotVariant.HELL_GAME]: "Hell Game", // 15
+  [SlotVariant.CRANE_GAME]: "Crane Game", // 16
+  [SlotVariant.CONFESSIONAL]: "Confessional", // 17
+  [SlotVariant.ROTTEN_BEGGAR]: "Rotten Beggar", // 18
+} as const satisfies Record<SlotVariant, string>;