isaacscript-common 3.17.0 → 4.0.2

package/initFeatures.ts

@@ -0,0 +1,39 @@
+import { ModUpgraded } from "./classes/ModUpgraded";
+import { characterHealthConversionInit } from "./features/characterHealthConversion";
+import { characterStatsInit } from "./features/characterStats";
+import { deployJSONRoomInit } from "./features/deployJSONRoom";
+import { disableInputsInit } from "./features/disableInputs";
+import { disableSoundsInit } from "./features/disableSound";
+import { fadeInRemoverInit } from "./features/fadeInRemover";
+import { fastResetInit } from "./features/fastReset";
+import { forgottenSwitchInit } from "./features/forgottenSwitch";
+import { getCollectibleItemPoolTypeInit } from "./features/getCollectibleItemPoolType";
+import { persistentEntitiesInit } from "./features/persistentEntities";
+import { playerInventoryInit } from "./features/playerInventory";
+import { ponyDetectionInit } from "./features/ponyDetection";
+import { preventCollectibleRotationInit } from "./features/preventCollectibleRotation";
+import { runInNFramesInit } from "./features/runInNFrames";
+import { sirenHelpersInit } from "./features/sirenHelpers";
+import { taintedLazarusPlayersInit } from "./features/taintedLazarusPlayers";
+
+export function initFeaturesMajor(mod: ModUpgraded): void {
+  deployJSONRoomInit(mod);
+  runInNFramesInit(mod);
+  characterStatsInit(mod);
+  characterHealthConversionInit(mod);
+}
+
+export function initFeaturesMinor(mod: ModUpgraded): void {
+  disableInputsInit(mod);
+  disableSoundsInit(mod);
+  fadeInRemoverInit(mod);
+  fastResetInit(mod);
+  forgottenSwitchInit(mod);
+  getCollectibleItemPoolTypeInit(mod);
+  persistentEntitiesInit(mod);
+  playerInventoryInit(mod);
+  ponyDetectionInit(mod);
+  preventCollectibleRotationInit(mod);
+  sirenHelpersInit(mod);
+  taintedLazarusPlayersInit(mod);
+}

package/interfaces/AddCallbackParameterCustom.ts

@@ -0,0 +1,188 @@
+import { PostAmbushFinishedRegisterParameters } from "../callbacks/subscriptions/postAmbushFinished";
+import { PostAmbushStartedRegisterParameters } from "../callbacks/subscriptions/postAmbushStarted";
+import { PostBombInitRegisterParameters } from "../callbacks/subscriptions/postBombInitLate";
+import { PostBombExplodedRegisterParameters } from "../callbacks/subscriptions/postBoneExploded";
+import { PostBoneSwingRegisterParameters } from "../callbacks/subscriptions/postBoneSwing";
+import { PostCollectibleInitFirstRegisterParameters } from "../callbacks/subscriptions/postCollectibleInitFirst";
+import { PostCursedTeleportRegisterParameters } from "../callbacks/subscriptions/postCursedTeleport";
+import { PostCustomDoorEnterRegisterParameters } from "../callbacks/subscriptions/postCustomDoorEnter";
+import { PostCustomReviveRegisterParameters } from "../callbacks/subscriptions/postCustomRevive";
+import { PostDiceRoomActivatedRegisterParameters } from "../callbacks/subscriptions/postDiceRoomActivated";
+import { PostDoorRenderRegisterParameters } from "../callbacks/subscriptions/postDoorRender";
+import { PostDoorUpdateRegisterParameters } from "../callbacks/subscriptions/postDoorUpdate";
+import { PostEffectInitLateRegisterParameters } from "../callbacks/subscriptions/postEffectInitLate";
+import { PostEffectStateChangedRegisterParameters } from "../callbacks/subscriptions/postEffectStateChanged";
+import { PostEsauJrRegisterParameters } from "../callbacks/subscriptions/postEsauJr";
+import { PostFamiliarInitLateRegisterParameters } from "../callbacks/subscriptions/postFamiliarInitLate";
+import { PostFamiliarStateChangedRegisterParameters } from "../callbacks/subscriptions/postFamiliarStateChanged";
+import { PostFirstEsauJrRegisterParameters } from "../callbacks/subscriptions/postFirstEsauJr";
+import { PostFirstFlipRegisterParameters } from "../callbacks/subscriptions/postFirstFlip";
+import { PostFlipRegisterParameters } from "../callbacks/subscriptions/postFlip";
+import { PostGameStartedReorderedRegisterParameters } from "../callbacks/subscriptions/postGameStartedReordered";
+import { PostGreedModeWaveRegisterParameters } from "../callbacks/subscriptions/postGreedModeWave";
+import { PostGridEntityBrokenRegisterParameters } from "../callbacks/subscriptions/postGridEntityBroken";
+import { PostGridEntityCollisionRegisterParameters } from "../callbacks/subscriptions/postGridEntityCollision";
+import { PostGridEntityInitRegisterParameters } from "../callbacks/subscriptions/postGridEntityInit";
+import { PostGridEntityRemoveRegisterParameters } from "../callbacks/subscriptions/postGridEntityRemove";
+import { PostGridEntityRenderRegisterParameters } from "../callbacks/subscriptions/postGridEntityRender";
+import { PostGridEntityStateChangedRegisterParameters } from "../callbacks/subscriptions/postGridEntityStateChanged";
+import { PostGridEntityUpdateRegisterParameters } from "../callbacks/subscriptions/postGridEntityUpdate";
+import { PostHolyMantleRemovedRegisterParameters } from "../callbacks/subscriptions/postHolyMantleRemoved";
+import { PostItemDischargedRegisterParameters } from "../callbacks/subscriptions/postItemDischarged";
+import { PostItemPickupRegisterParameters } from "../callbacks/subscriptions/postItemPickup";
+import { PostKnifeInitLateRegisterParameters } from "../callbacks/subscriptions/postKnifeInitLate";
+import { PostLaserInitLateRegisterParameters } from "../callbacks/subscriptions/postLaserInitLate";
+import { PostNewLevelReorderedRegisterParameters } from "../callbacks/subscriptions/postNewLevelReordered";
+import { PostNewRoomEarlyRegisterParameters } from "../callbacks/subscriptions/postNewRoomEarly";
+import { PostNewRoomReorderedRegisterParameters } from "../callbacks/subscriptions/postNewRoomReordered";
+import { PostNPCInitLateRegisterParameters } from "../callbacks/subscriptions/postNPCInitLate";
+import { PostNPCStateChangedRegisterParameters } from "../callbacks/subscriptions/postNPCStateChanged";
+import { PostPEffectUpdateReorderedRegisterParameters } from "../callbacks/subscriptions/postPEffectUpdateReordered";
+import { PostPickupCollectRegisterParameters } from "../callbacks/subscriptions/postPickupCollect";
+import { PostPickupInitFirstRegisterParameters } from "../callbacks/subscriptions/postPickupInitFirst";
+import { PostPickupInitLateRegisterParameters } from "../callbacks/subscriptions/postPickupInitLate";
+import { PostPickupStateChangedRegisterParameters } from "../callbacks/subscriptions/postPickupStateChanged";
+import { PostPitRenderRegisterParameters } from "../callbacks/subscriptions/postPitRender";
+import { PostPitUpdateRegisterParameters } from "../callbacks/subscriptions/postPitUpdate";
+import { PostPlayerChangeHealthRegisterParameters } from "../callbacks/subscriptions/postPlayerChangeHealth";
+import { PostPlayerChangeTypeRegisterParameters } from "../callbacks/subscriptions/postPlayerChangeType";
+import { PostPlayerCollectibleAddedRegisterParameters } from "../callbacks/subscriptions/postPlayerCollectibleAdded";
+import { PostPlayerCollectibleRemovedRegisterParameters } from "../callbacks/subscriptions/postPlayerCollectibleRemoved";
+import { PostPlayerFatalDamageRegisterParameters } from "../callbacks/subscriptions/postPlayerFatalDamage";
+import { PostPlayerInitLateRegisterParameters } from "../callbacks/subscriptions/postPlayerInitLate";
+import { PostPlayerInitReorderedRegisterParameters } from "../callbacks/subscriptions/postPlayerInitReordered";
+import { PostPlayerRenderReorderedRegisterParameters } from "../callbacks/subscriptions/postPlayerRenderReordered";
+import { PostPlayerUpdateReorderedRegisterParameters } from "../callbacks/subscriptions/postPlayerUpdateReordered";
+import { PostPoopRenderRegisterParameters } from "../callbacks/subscriptions/postPoopRender";
+import { PostPoopUpdateRegisterParameters } from "../callbacks/subscriptions/postPoopUpdate";
+import { PostPressurePlateRenderRegisterParameters } from "../callbacks/subscriptions/postPressurePlateRender";
+import { PostPressurePlateUpdateRegisterParameters } from "../callbacks/subscriptions/postPressurePlateUpdate";
+import { PostProjectileInitLateRegisterParameters } from "../callbacks/subscriptions/postProjectileInitLate";
+import { PostPurchaseRegisterParameters } from "../callbacks/subscriptions/postPurchase";
+import { PostRockRenderRegisterParameters } from "../callbacks/subscriptions/postRockRender";
+import { PostRockUpdateRegisterParameters } from "../callbacks/subscriptions/postRockUpdate";
+import { PostRoomClearChangedRegisterParameters } from "../callbacks/subscriptions/postRoomClearChanged";
+import { PostSacrificeRegisterParameters } from "../callbacks/subscriptions/postSacrifice";
+import { PostSlotAnimationChangedRegisterParameters } from "../callbacks/subscriptions/postSlotAnimationChanged";
+import { PostSlotDestroyedRegisterParameters } from "../callbacks/subscriptions/postSlotDestroyed";
+import { PostSlotInitRegisterParameters } from "../callbacks/subscriptions/postSlotInit";
+import { PostSlotRenderRegisterParameters } from "../callbacks/subscriptions/postSlotRender";
+import { PostSlotUpdateRegisterParameters } from "../callbacks/subscriptions/postSlotUpdate";
+import { PostSpikesRenderRegisterParameters } from "../callbacks/subscriptions/postSpikesRender";
+import { PostSpikesUpdateRegisterParameters } from "../callbacks/subscriptions/postSpikesUpdate";
+import { PostTearInitLateRegisterParameters } from "../callbacks/subscriptions/postTearInitLate";
+import { PostTearInitVeryLateRegisterParameters } from "../callbacks/subscriptions/postTearInitVeryLate";
+import { PostTNTRenderRegisterParameters } from "../callbacks/subscriptions/postTNTRender";
+import { PostTNTUpdateRegisterParameters } from "../callbacks/subscriptions/postTNTUpdate";
+import { PostTransformationRegisterParameters } from "../callbacks/subscriptions/postTransformation";
+import { PostTrinketBreakRegisterParameters } from "../callbacks/subscriptions/postTrinketBreak";
+import { PreBerserkDeathRegisterParameters } from "../callbacks/subscriptions/preBerserkDeath";
+import { PreCustomReviveRegisterParameters } from "../callbacks/subscriptions/preCustomRevive";
+import { PreItemPickupRegisterParameters } from "../callbacks/subscriptions/preItemPickup";
+import { PreNewLevelRegisterParameters } from "../callbacks/subscriptions/preNewLevel";
+import { ModCallbackCustom } from "../enums/ModCallbackCustom";
+
+export interface AddCallbackParameterCustom {
+  [ModCallbackCustom.POST_AMBUSH_FINISHED]: PostAmbushFinishedRegisterParameters;
+  [ModCallbackCustom.POST_AMBUSH_STARTED]: PostAmbushStartedRegisterParameters;
+  [ModCallbackCustom.POST_BOMB_EXPLODED]: PostBombExplodedRegisterParameters;
+  [ModCallbackCustom.POST_BOMB_INIT_LATE]: PostBombInitRegisterParameters;
+  [ModCallbackCustom.POST_BONE_SWING]: PostBoneSwingRegisterParameters;
+  [ModCallbackCustom.POST_COLLECTIBLE_INIT_FIRST]: PostCollectibleInitFirstRegisterParameters;
+  [ModCallbackCustom.POST_CURSED_TELEPORT]: PostCursedTeleportRegisterParameters;
+  [ModCallbackCustom.POST_CUSTOM_DOOR_ENTER]: PostCustomDoorEnterRegisterParameters;
+  [ModCallbackCustom.POST_CUSTOM_REVIVE]: PostCustomReviveRegisterParameters;
+  [ModCallbackCustom.POST_DICE_ROOM_ACTIVATED]: PostDiceRoomActivatedRegisterParameters;
+  [ModCallbackCustom.POST_DOOR_RENDER]: PostDoorRenderRegisterParameters;
+  [ModCallbackCustom.POST_DOOR_UPDATE]: PostDoorUpdateRegisterParameters;
+  [ModCallbackCustom.POST_EFFECT_INIT_LATE]: PostEffectInitLateRegisterParameters;
+  [ModCallbackCustom.POST_EFFECT_STATE_CHANGED]: PostEffectStateChangedRegisterParameters;
+  [ModCallbackCustom.POST_ESAU_JR]: PostEsauJrRegisterParameters;
+  [ModCallbackCustom.POST_FAMILIAR_INIT_LATE]: PostFamiliarInitLateRegisterParameters;
+  [ModCallbackCustom.POST_FAMILIAR_STATE_CHANGED]: PostFamiliarStateChangedRegisterParameters;
+  [ModCallbackCustom.POST_FIRST_ESAU_JR]: PostFirstEsauJrRegisterParameters;
+  [ModCallbackCustom.POST_FIRST_FLIP]: PostFirstFlipRegisterParameters;
+  [ModCallbackCustom.POST_FLIP]: PostFlipRegisterParameters;
+  [ModCallbackCustom.POST_GAME_STARTED_REORDERED]: PostGameStartedReorderedRegisterParameters;
+  [ModCallbackCustom.POST_GREED_MODE_WAVE]: PostGreedModeWaveRegisterParameters;
+  [ModCallbackCustom.POST_GRID_ENTITY_BROKEN]: PostGridEntityBrokenRegisterParameters;
+  [ModCallbackCustom.POST_GRID_ENTITY_COLLISION]: PostGridEntityCollisionRegisterParameters;
+  [ModCallbackCustom.POST_GRID_ENTITY_INIT]: PostGridEntityInitRegisterParameters;
+  [ModCallbackCustom.POST_GRID_ENTITY_REMOVE]: PostGridEntityRemoveRegisterParameters;
+  [ModCallbackCustom.POST_GRID_ENTITY_RENDER]: PostGridEntityRenderRegisterParameters;
+  [ModCallbackCustom.POST_GRID_ENTITY_STATE_CHANGED]: PostGridEntityStateChangedRegisterParameters;
+  [ModCallbackCustom.POST_GRID_ENTITY_UPDATE]: PostGridEntityUpdateRegisterParameters;
+  [ModCallbackCustom.POST_HOLY_MANTLE_REMOVED]: PostHolyMantleRemovedRegisterParameters;
+  [ModCallbackCustom.POST_ITEM_DISCHARGE]: PostItemDischargedRegisterParameters;
+  [ModCallbackCustom.POST_ITEM_PICKUP]: PostItemPickupRegisterParameters;
+  [ModCallbackCustom.POST_KNIFE_INIT_LATE]: PostKnifeInitLateRegisterParameters;
+  [ModCallbackCustom.POST_LASER_INIT_LATE]: PostLaserInitLateRegisterParameters;
+  [ModCallbackCustom.POST_NEW_LEVEL_REORDERED]: PostNewLevelReorderedRegisterParameters;
+  [ModCallbackCustom.POST_NEW_ROOM_EARLY]: PostNewRoomEarlyRegisterParameters;
+  [ModCallbackCustom.POST_NEW_ROOM_REORDERED]: PostNewRoomReorderedRegisterParameters;
+  [ModCallbackCustom.POST_NPC_INIT_LATE]: PostNPCInitLateRegisterParameters;
+  [ModCallbackCustom.POST_NPC_STATE_CHANGED]: PostNPCStateChangedRegisterParameters;
+  [ModCallbackCustom.POST_PEFFECT_UPDATE_REORDERED]: PostPEffectUpdateReorderedRegisterParameters;
+  [ModCallbackCustom.POST_PICKUP_COLLECT]: PostPickupCollectRegisterParameters;
+  [ModCallbackCustom.POST_PICKUP_INIT_FIRST]: PostPickupInitFirstRegisterParameters;
+  [ModCallbackCustom.POST_PICKUP_INIT_LATE]: PostPickupInitLateRegisterParameters;
+  [ModCallbackCustom.POST_PICKUP_STATE_CHANGED]: PostPickupStateChangedRegisterParameters;
+  [ModCallbackCustom.POST_PIT_RENDER]: PostPitRenderRegisterParameters;
+  [ModCallbackCustom.POST_PIT_UPDATE]: PostPitUpdateRegisterParameters;
+  [ModCallbackCustom.POST_PLAYER_CHANGE_HEALTH]: PostPlayerChangeHealthRegisterParameters;
+  [ModCallbackCustom.POST_PLAYER_CHANGE_TYPE]: PostPlayerChangeTypeRegisterParameters;
+  [ModCallbackCustom.POST_PLAYER_COLLECTIBLE_ADDED]: PostPlayerCollectibleAddedRegisterParameters;
+  [ModCallbackCustom.POST_PLAYER_COLLECTIBLE_REMOVED]: PostPlayerCollectibleRemovedRegisterParameters;
+  [ModCallbackCustom.POST_PLAYER_FATAL_DAMAGE]: PostPlayerFatalDamageRegisterParameters;
+  [ModCallbackCustom.POST_PLAYER_INIT_LATE]: PostPlayerInitLateRegisterParameters;
+  [ModCallbackCustom.POST_PLAYER_INIT_REORDERED]: PostPlayerInitReorderedRegisterParameters;
+  [ModCallbackCustom.POST_PLAYER_RENDER_REORDERED]: PostPlayerRenderReorderedRegisterParameters;
+  [ModCallbackCustom.POST_PLAYER_UPDATE_REORDERED]: PostPlayerUpdateReorderedRegisterParameters;
+  [ModCallbackCustom.POST_POOP_RENDER]: PostPoopRenderRegisterParameters;
+  [ModCallbackCustom.POST_POOP_UPDATE]: PostPoopUpdateRegisterParameters;
+  [ModCallbackCustom.POST_PRESSURE_PLATE_RENDER]: PostPressurePlateRenderRegisterParameters;
+  [ModCallbackCustom.POST_PRESSURE_PLATE_UPDATE]: PostPressurePlateUpdateRegisterParameters;
+  [ModCallbackCustom.POST_PROJECTILE_INIT_LATE]: PostProjectileInitLateRegisterParameters;
+  [ModCallbackCustom.POST_PURCHASE]: PostPurchaseRegisterParameters;
+  [ModCallbackCustom.POST_ROCK_RENDER]: PostRockRenderRegisterParameters;
+  [ModCallbackCustom.POST_ROCK_UPDATE]: PostRockUpdateRegisterParameters;
+  [ModCallbackCustom.POST_ROOM_CLEAR_CHANGED]: PostRoomClearChangedRegisterParameters;
+  [ModCallbackCustom.POST_SACRIFICE]: PostSacrificeRegisterParameters;
+  [ModCallbackCustom.POST_SLOT_ANIMATION_CHANGED]: PostSlotAnimationChangedRegisterParameters;
+  [ModCallbackCustom.POST_SLOT_DESTROYED]: PostSlotDestroyedRegisterParameters;
+  [ModCallbackCustom.POST_SLOT_INIT]: PostSlotInitRegisterParameters;
+  [ModCallbackCustom.POST_SLOT_RENDER]: PostSlotRenderRegisterParameters;
+  [ModCallbackCustom.POST_SLOT_UPDATE]: PostSlotUpdateRegisterParameters;
+  [ModCallbackCustom.POST_SPIKES_RENDER]: PostSpikesRenderRegisterParameters;
+  [ModCallbackCustom.POST_SPIKES_UPDATE]: PostSpikesUpdateRegisterParameters;
+  [ModCallbackCustom.POST_TEAR_INIT_LATE]: PostTearInitLateRegisterParameters;
+  [ModCallbackCustom.POST_TEAR_INIT_VERY_LATE]: PostTearInitVeryLateRegisterParameters;
+  [ModCallbackCustom.POST_TNT_RENDER]: PostTNTRenderRegisterParameters;
+  [ModCallbackCustom.POST_TNT_UPDATE]: PostTNTUpdateRegisterParameters;
+  [ModCallbackCustom.POST_TRANSFORMATION]: PostTransformationRegisterParameters;
+  [ModCallbackCustom.POST_TRINKET_BREAK]: PostTrinketBreakRegisterParameters;
+  [ModCallbackCustom.PRE_BERSERK_DEATH]: PreBerserkDeathRegisterParameters;
+  [ModCallbackCustom.PRE_CUSTOM_REVIVE]: PreCustomReviveRegisterParameters;
+  [ModCallbackCustom.PRE_ITEM_PICKUP]: PreItemPickupRegisterParameters;
+  [ModCallbackCustom.PRE_NEW_LEVEL]: PreNewLevelRegisterParameters;
+}
+
+// Make copies of the objects we need to verify so that we can easily re-use the code block below.
+type EnumToCheck = ModCallbackCustom;
+type InterfaceToCheck = AddCallbackParameterCustom;
+
+// Throw a compiler error if InterfaceToCheck does not match the values of EnumToCheck.
+// From: https://stackoverflow.com/questions/51829842
+type KeysMissing = Exclude<EnumToCheck, keyof InterfaceToCheck>;
+type ExtraKeys = {
+  [K in keyof InterfaceToCheck]: Extract<EnumToCheck, K> extends never
+    ? K
+    : never;
+}[keyof InterfaceToCheck];
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+type Verify<
+  // eslint-disable-next-line @typescript-eslint/naming-convention
+  _Missing extends never = KeysMissing,
+  // eslint-disable-next-line @typescript-eslint/naming-convention
+  _Extra extends never = ExtraKeys,
+> = 0;

package/interfaces/ChargeBarSprites.ts

@@ -0,0 +1,12 @@
+/**
+ * A collection of the four sprites necessary in order to render a charge bar.
+ *
+ * Used in the `newChargeBarSprites` and related helper functions.
+ */
+export interface ChargeBarSprites {
+  back: Sprite;
+  meter: Sprite;
+  meterBattery: Sprite;
+  lines: Sprite;
+  maxCharges: int;
+}

package/interfaces/JSONDoor.d.ts

@@ -1,11 +1,11 @@
-/** Part of {@link JSONRooms}. */
+/** Part of `JSONRooms`. */
 export interface JSONDoor {
     $: {
-        /** Equal to "True" or "False". */
+        /** Equal to "True" or "False". Needs to be converted to an `boolean`. */
         exists: string;
-        /** Needs to be converted to an int. */
+        /** Needs to be converted to an `int`. */
         x: string;
-        /** Needs to be converted to an int. */
+        /** Needs to be converted to an `int`. */
         y: string;
     };
 }

package/interfaces/JSONDoor.ts

@@ -0,0 +1,13 @@
+/** Part of `JSONRooms`. */
+export interface JSONDoor {
+  $: {
+    /** Equal to "True" or "False". Needs to be converted to an `boolean`. */
+    exists: string;
+
+    /** Needs to be converted to an `int`. */
+    x: string;
+
+    /** Needs to be converted to an `int`. */
+    y: string;
+  };
+}

package/interfaces/JSONEntity.d.ts

@@ -1,13 +1,13 @@
-/** Part of {@link JSONRooms}. */
+/** Part of `JSONRooms`. */
 export interface JSONEntity {
     $: {
-        /** Needs to be converted to an int. */
+        /** Needs to be converted to an `int`. */
         type: string;
-        /** Needs to be converted to an int. */
+        /** Needs to be converted to an `int`. */
         variant: string;
-        /** Needs to be converted to an int. */
+        /** Needs to be converted to an `int`. */
         subtype: string;
-        /** Needs to be converted to a float. */
+        /** Needs to be converted to a `float`. */
         weight: string;
     };
 }

package/interfaces/JSONEntity.ts

@@ -0,0 +1,16 @@
+/** Part of `JSONRooms`. */
+export interface JSONEntity {
+  $: {
+    /** Needs to be converted to an `int`. */
+    type: string;
+
+    /** Needs to be converted to an `int`. */
+    variant: string;
+
+    /** Needs to be converted to an `int`. */
+    subtype: string;
+
+    /** Needs to be converted to a `float`. */
+    weight: string;
+  };
+}

package/interfaces/JSONRoom.d.ts

@@ -1,24 +1,24 @@
 import { JSONDoor } from "./JSONDoor";
 import { JSONSpawn } from "./JSONSpawn";
-/** Part of {@link JSONRooms}. */
+/** Part of `JSONRooms`. */
 export interface JSONRoom {
     $: {
-        /** Needs to be converted to an int. */
+        /** Needs to be converted to an `int`. */
         difficulty: string;
-        /** Needs to be converted to an int. */
+        /** Needs to be converted to an `int`. */
         height: string;
         name: string;
-        /** Needs to be converted to an int. */
+        /** Needs to be converted to an `int`. */
         shape: string;
-        /** Needs to be converted to an int. */
+        /** Needs to be converted to an `int`. */
         subtype: string;
-        /** Needs to be converted to an int. */
+        /** Needs to be converted to an `int`. */
         type: string;
-        /** Needs to be converted to an int. */
+        /** Needs to be converted to an `int`. */
         variant: string;
-        /** Needs to be converted to a float. */
+        /** Needs to be converted to a `float`. */
         weight: string;
-        /** Needs to be converted to an int. */
+        /** Needs to be converted to an `int`. */
         width: string;
     };
     door: JSONDoor[];

package/interfaces/JSONRoom.ts

@@ -0,0 +1,36 @@
+import { JSONDoor } from "./JSONDoor";
+import { JSONSpawn } from "./JSONSpawn";
+
+/** Part of `JSONRooms`. */
+export interface JSONRoom {
+  $: {
+    /** Needs to be converted to an `int`. */
+    difficulty: string;
+
+    /** Needs to be converted to an `int`. */
+    height: string;
+
+    name: string;
+
+    /** Needs to be converted to an `int`. */
+    shape: string;
+
+    /** Needs to be converted to an `int`. */
+    subtype: string;
+
+    /** Needs to be converted to an `int`. */
+    type: string;
+
+    /** Needs to be converted to an `int`. */
+    variant: string;
+
+    /** Needs to be converted to a `float`. */
+    weight: string;
+
+    /** Needs to be converted to an `int`. */
+    width: string;
+  };
+
+  door: JSONDoor[];
+  spawn: JSONSpawn[];
+}

package/interfaces/JSONRooms.ts

@@ -0,0 +1,12 @@
+import { JSONRoom } from "./JSONRoom";
+
+/**
+ * Custom rooms are created with the Basement Renovator program, which outputs XML files and STB
+ * files. A `JSONRooms` object is simply an XML file converted to JSON. You can convert your XML
+ * files using the following command: `npx convert-xml-to-json foo.xml foo.json`
+ */
+export interface JSONRooms {
+  rooms: {
+    room: JSONRoom[];
+  };
+}

package/interfaces/JSONSpawn.d.ts

@@ -1,10 +1,10 @@
 import { JSONEntity } from "./JSONEntity";
-/** Part of {@link JSONRooms}. */
+/** Part of `JSONRooms`. */
 export interface JSONSpawn {
     $: {
-        /** Needs to be converted to an int. */
+        /** Needs to be converted to an `int`. */
         x: string;
-        /** Needs to be converted to an int. */
+        /** Needs to be converted to an `int`. */
         y: string;
     };
     entity: JSONEntity[];

package/interfaces/JSONSpawn.ts

@@ -0,0 +1,14 @@
+import { JSONEntity } from "./JSONEntity";
+
+/** Part of `JSONRooms`. */
+export interface JSONSpawn {
+  $: {
+    /** Needs to be converted to an `int`. */
+    x: string;
+
+    /** Needs to be converted to an `int`. */
+    y: string;
+  };
+
+  entity: JSONEntity[];
+}

package/interfaces/PlayerHealth.ts

@@ -0,0 +1,16 @@
+import { HeartSubType } from "isaac-typescript-definitions";
+
+/** Used by the `getPlayerHealth` and `setPlayerHealth` helper functions. */
+export interface PlayerHealth {
+  maxHearts: int;
+  hearts: int;
+  eternalHearts: int;
+  soulHearts: int;
+  boneHearts: int;
+  goldenHearts: int;
+  rottenHearts: int;
+  brokenHearts: int;
+  soulCharges: int;
+  bloodCharges: int;
+  soulHeartTypes: HeartSubType[];
+}

package/interfaces/PocketItemDescription.ts

@@ -0,0 +1,9 @@
+import { PocketItemSlot } from "isaac-typescript-definitions";
+import { PocketItemType } from "../enums/PocketItemType";
+
+/** Used by the `getPocketItems` and related helper functions. */
+export interface PocketItemDescription {
+  slot: PocketItemSlot;
+  type: PocketItemType;
+  subType: int;
+}

package/interfaces/SaveData.ts

@@ -0,0 +1,29 @@
+/**
+ * This is the format of the object that you give to the save data manager. It will contains all of
+ * the variables for the particular mod feature.
+ *
+ * Depending on which object keys you use, the variables will be automatically reset at certain
+ * times and automatically saved to disk.
+ *
+ * Each sub-object of save data has a string as a key and arbitrary data as a value. However, the
+ * data has to be serializable. Specifically, this means that you can only use the following types:
+ *
+ * - `boolean`
+ * - `number`
+ * - `string`
+ * - `Map` / `DefaultMap`
+ * - `Set`
+ * - serializable Isaac API classes (such as `Color`)
+ * - TSTL classes (i.e. classes that you made yourself)
+ * - sub-objects or a `LuaTable` that contains the above values
+ *
+ * (Unfortunately, it is not possible to create a recursive type definition that matches these
+ * properties. This means that the TypeScript compiler will not be able to validate that you are
+ * passing in serializable data.)
+ */
+export interface SaveData {
+  persistent?: Record<string, unknown>;
+  run?: Record<string, unknown>;
+  level?: Record<string, unknown>;
+  room?: Record<string, unknown>;
+}

package/interfaces/TrinketSituation.ts

@@ -0,0 +1,9 @@
+import { TrinketType } from "isaac-typescript-definitions";
+
+/** Used by the `temporarilyRemoveTrinkets` and related helper functions. */
+export interface TrinketSituation {
+  trinketTypeRemoved: TrinketType;
+  trinketType1: TrinketType;
+  trinketType2: TrinketType;
+  numSmeltedTrinkets: int;
+}

package/interfaces/private/TSTLClassMetatable.ts

@@ -0,0 +1,8 @@
+export interface TSTLClassMetatable {
+  ____constructor: () => void;
+  __index: unknown;
+  constructor: {
+    name: string;
+    prototype: LuaMetatable<LuaTable<AnyNotNil, unknown>>;
+  };
+}

package/maps/PHDPillConversions.ts

@@ -0,0 +1,21 @@
+import { PillEffect } from "isaac-typescript-definitions";
+
+export const PHD_PILL_CONVERSIONS: ReadonlyMap<PillEffect, PillEffect> =
+  new Map([
+    [PillEffect.BAD_TRIP, PillEffect.BALLS_OF_STEEL], // 1
+    [PillEffect.HEALTH_DOWN, PillEffect.HEALTH_UP], // 6
+    [PillEffect.RANGE_DOWN, PillEffect.RANGE_UP], // 11
+    [PillEffect.SPEED_DOWN, PillEffect.SPEED_UP], // 13
+    [PillEffect.TEARS_DOWN, PillEffect.TEARS_UP], // 15
+    [PillEffect.LUCK_DOWN, PillEffect.LUCK_UP], // 17
+    [PillEffect.PARALYSIS, PillEffect.PHEROMONES], // 22
+    [PillEffect.AMNESIA, PillEffect.I_CAN_SEE_FOREVER], // 25
+    [PillEffect.R_U_A_WIZARD, PillEffect.POWER], // 27
+    [PillEffect.ADDICTED, PillEffect.PERCS], // 29
+    [PillEffect.QUESTION_MARKS, PillEffect.TELEPILLS], // 31
+    [PillEffect.RETRO_VISION, PillEffect.I_CAN_SEE_FOREVER], // 37
+    [PillEffect.X_LAX, PillEffect.SOMETHINGS_WRONG], // 39
+    [PillEffect.IM_EXCITED, PillEffect.IM_DROWSY], // 42
+    [PillEffect.HORF, PillEffect.GULP], // 44
+    [PillEffect.SHOT_SPEED_DOWN, PillEffect.SHOT_SPEED_UP], // 47
+  ]);