isaacscript-common 6.22.0 → 6.22.1

package/src/index.ts

@@ -1,195 +1,9 @@
-export * from "./cachedClasses";
-export {
-  initCustomDoor,
-  spawnCustomDoor,
-} from "./callbacks/postCustomDoorEnter";
-export {
-  forceNewLevelCallback,
-  forceNewRoomCallback,
-  reorderedCallbacksSetStage,
-} from "./callbacks/reorderedCallbacks";
-export * from "./classes/DefaultMap";
-export * from "./classes/ModUpgraded";
-export * from "./constants";
-export * from "./constantsFirstLast";
-export * from "./enums/HealthType";
-export * from "./enums/ModCallbackCustom";
-export * from "./enums/PocketItemType";
-export * from "./enums/SerializationType";
-export {
-  ConversionHeartSubType,
-  registerCharacterHealthConversion,
-} from "./features/characterHealthConversion";
-export { registerCharacterStats } from "./features/characterStats";
-export { getCollectibleItemPoolType } from "./features/collectibleItemPoolType";
-export {
-  removeCustomGridEntity as removeCustomGrid,
-  spawnCustomGridEntity as spawnCustomGrid,
-} from "./features/customGridEntity";
-export * from "./features/customStage/exports";
-export * from "./features/customTrapdoor/exports";
-export * from "./features/debugDisplay/exports";
-export {
-  deployJSONRoom,
-  deployRandomJSONRoom,
-  emptyRoom,
-} from "./features/deployJSONRoom";
-export { disableAllSound, enableAllSound } from "./features/disableAllSound";
-export {
-  disableAllInputs,
-  disableAllInputsExceptFor,
-  disableMovementInputs,
-  disableShootingInputs,
-  enableAllInputs,
-  enableAllInputsExceptFor,
-} from "./features/disableInputs";
-export * from "./features/extraConsoleCommands/exports";
-export { removeFadeIn, restoreFadeIn } from "./features/fadeInRemover";
-export { disableFastReset, enableFastReset } from "./features/fastReset";
-export { forgottenSwitch } from "./features/forgottenSwitch";
-export { pause, unpause } from "./features/pause";
-export {
-  removePersistentEntity,
-  spawnPersistentEntity,
-} from "./features/persistentEntities";
-export * from "./features/pickupIndex";
-export { getPlayerInventory } from "./features/playerInventory";
-export {
-  anyPlayerUsingPony,
-  isPlayerUsingPony,
-} from "./features/ponyDetection";
-export { preventCollectibleRotation } from "./features/preventCollectibleRotation";
-export { registerHotkey, unregisterHotkey } from "./features/registerHotkey";
-export {
-  getRoomClearGameFrame,
-  getRoomClearRoomFrame,
-} from "./features/roomClearFrame";
-export * from "./features/roomHistory";
-export {
-  runInNGameFrames,
-  runInNRenderFrames,
-  runNextGameFrame,
-  runNextRenderFrame,
-  setIntervalGameFrames,
-  setIntervalRenderFrames,
-} from "./features/runInNFrames";
-export * from "./features/saveDataManager/exports";
-export {
-  hasSirenStolenFamiliar,
-  setFamiliarNoSirenSteal,
-} from "./features/sirenHelpers";
-export { getStageHistory, hasVisitedStage } from "./features/stageHistory";
-export { getTaintedLazarusSubPlayer } from "./features/taintedLazarusPlayers";
-export * from "./functions/ambush";
-export * from "./functions/array";
-export * from "./functions/benchmark";
-export * from "./functions/bitwise";
-export * from "./functions/bombs";
-export * from "./functions/bosses";
-export * from "./functions/cacheFlag";
-export * from "./functions/cards";
-export * from "./functions/challenges";
-export * from "./functions/characters";
-export * from "./functions/charge";
-export * from "./functions/chargeBar";
-export * from "./functions/collectibleCacheFlag";
-export * from "./functions/collectibles";
-export * from "./functions/collectibleSet";
-export * from "./functions/collectibleTag";
-export * from "./functions/color";
-export * from "./functions/curses";
-export * from "./functions/debug";
-export * from "./functions/deepCopy";
-export * from "./functions/deepCopyTests";
-export * from "./functions/dimensions";
-export * from "./functions/direction";
-export * from "./functions/doors";
-export * from "./functions/easing";
-export * from "./functions/eden";
-export * from "./functions/effects";
-export * from "./functions/entities";
-export * from "./functions/entitiesSpecific";
-export * from "./functions/entityTypes";
-export * from "./functions/enums";
-export * from "./functions/familiars";
-export * from "./functions/flag";
-export * from "./functions/flying";
-export * from "./functions/globals";
-export * from "./functions/gridEntities";
-export * from "./functions/gridEntitiesSpecific";
-export * from "./functions/input";
-export * from "./functions/isaacAPIClass";
-export * from "./functions/itemPool";
-export * from "./functions/jsonHelpers";
-export * from "./functions/jsonRoom";
-export * from "./functions/kColor";
-export * from "./functions/language";
-export * from "./functions/level";
-export * from "./functions/levelGrid";
-export * from "./functions/log";
-export * from "./functions/logEntities";
-export * from "./functions/map";
-export * from "./functions/math";
-export * from "./functions/mergeTests";
-export * from "./functions/minimap";
-export * from "./functions/nextStage";
-export * from "./functions/npcs";
-export * from "./functions/pickups";
-export * from "./functions/pickupsSpecific";
-export * from "./functions/pickupVariants";
-export * from "./functions/pills";
-export * from "./functions/playerCenter";
-export * from "./functions/playerDataStructures";
-export * from "./functions/playerHealth";
-export * from "./functions/playerIndex";
-export * from "./functions/players";
-export * from "./functions/pocketItems";
-export * from "./functions/positionVelocity";
-export * from "./functions/pressurePlate";
-export * from "./functions/projectiles";
-export * from "./functions/random";
-export * from "./functions/revive";
-export * from "./functions/rng";
-export * from "./functions/rockAlt";
-export * from "./functions/roomData";
-export * from "./functions/roomGrid";
-export * from "./functions/rooms";
-export * from "./functions/roomShape";
-export * from "./functions/run";
-export * from "./functions/saveFile";
-export * from "./functions/seeds";
-export * from "./functions/serialization";
-export * from "./functions/set";
-export * from "./functions/sound";
-export * from "./functions/spawnCollectible";
-export * from "./functions/sprites";
-export * from "./functions/stage";
-export * from "./functions/string";
-export * from "./functions/table";
-export * from "./functions/tears";
-export * from "./functions/transformations";
-export * from "./functions/trinketCacheFlag";
-export * from "./functions/trinketGive";
-export * from "./functions/trinkets";
-export * from "./functions/tstlClass";
-export * from "./functions/types";
-export * from "./functions/ui";
-export * from "./functions/utils";
-export * from "./functions/vector";
-export * from "./interfaces/AddCallbackParameterCustom";
-export * from "./interfaces/ChargeBarSprites";
-export * from "./interfaces/JSONRoomsFile";
-export * from "./interfaces/PlayerHealth";
-export * from "./interfaces/PocketItemDescription";
-export * from "./interfaces/SaveData";
-export * from "./interfaces/TrinketSituation";
-export * from "./maps/cardMap";
-export * from "./maps/characterMap";
-export * from "./maps/pillEffectMap";
-export * from "./maps/roomTypeMap";
-export * from "./objects/colors";
-export * from "./types/AnyEntity";
-export * from "./types/CollectibleIndex";
-export * from "./types/PickingUpItem";
-export * from "./types/PlayerIndex";
-export * from "./upgradeMod";
+export * from "./classes/index";
+export * from "./core/index";
+export * from "./enums/index";
+export * from "./features/index";
+export * from "./functions/index";
+export * from "./interfaces/index";
+export * from "./maps/index";
+export * from "./objects/index";
+export * from "./types/index";

package/src/indexTypeDoc.ts

@@ -0,0 +1,13 @@
+// We need a separate index for documentation purposes so that we can automatically sort the exports
+// of this library into directories. (This isn't desired for the normal index because we want
+// everything to be accessible at the root-level as a flat export for end-users.)
+
+export * as Classes from "./classes/indexTypeDoc";
+export * as Core from "./core/indexTypeDoc";
+export * as Enums from "./enums/indexTypeDoc";
+export * as Features from "./features/indexTypeDoc";
+export * as Functions from "./functions/indexTypeDoc";
+export * as Interfaces from "./interfaces/indexTypeDoc";
+export * as Maps from "./maps/indexTypeDoc";
+export * as Objects from "./objects/indexTypeDoc";
+export * as Types from "./types/indexTypeDoc";

package/src/interfaces/CustomStageLua.ts

@@ -9,7 +9,6 @@
  *
  * The `CustomStageLua` interface extends this, adding room metadata.
  */
-
 // ts-prune-ignore-next
 export type CustomStageTSConfig = Readonly<{
   /** Mandatory. The name of the custom stage. */
@@ -26,7 +25,8 @@ export type CustomStageTSConfig = Readonly<{
    * stage.
    *
    * Make sure the chosen prefix does not conflict with any other mods. You can find a list of
-   * registered room variant prefixes on the IsaacScript website.
+   * registered room variant prefixes on the IsaacScript website:
+   * https://isaacscript.github.io/main/custom-stages
    */
   roomVariantPrefix: number;
 
@@ -318,6 +318,9 @@ export type CustomStageTSConfig = Readonly<{
     "2x2"?: readonly CustomStageShadow[];
   }>;
 
+  /** Optional. An array containing the bosses that should be used for the stage. */
+  bossPool?: readonly CustomStageBossPoolEntry[];
+
   /** Optional. A collection of colors used in the boss "versus" screen. */
   versusScreen?: Readonly<{
     /**
@@ -355,7 +358,8 @@ export type CustomStageTSConfig = Readonly<{
  * A description of a custom stage shadow. (In this context, "shadows" are the outlines from things
  * on the roof. For example, in Basement, a shadow of a sideways V is used, among others.)
  */
-type CustomStageShadow = Readonly<{
+// ts-prune-ignore-next
+export type CustomStageShadow = Readonly<{
   /**
    * The full path to the shadow overlay PNG file.
    *
@@ -379,6 +383,25 @@ type CustomStageShadow = Readonly<{
   }>;
 }>;
 
+/** An object that represents a possible boss for a custom stage. */
+export interface CustomStageBossPoolEntry {
+  /**
+   * The name of the boss. This must correspond to the entry in "entities2.xml".
+   *
+   * Note that since there is no way to determine the corresponding `EntityType` of the boss during
+   * compile-time, you must specify the `EntityType` at run-time when your mod first loads using the
+   * `registerCustomBoss` helper function.
+   */
+  name: string;
+
+  /**
+   * The weight of the boss. This is used when randomly selecting which boss to use for the floor.
+   * For example, use a value of 1 if you want this boss to be equally likely as any other boss, 0.5
+   * if you want it to be half as likely, 2 if you want it to be twice as likely, and so on.
+   */
+  weight: number;
+}
+
 /**
  * An object that represents a custom stage. The "metadata.lua" file contains an array of these
  * objects. Besides the room metadata, the data is the same as what is specified inside the

package/src/interfaces/index.ts

@@ -0,0 +1,10 @@
+export * from "./ChargeBarSprites";
+export * from "./Corner";
+export * from "./CustomStageLua";
+export * from "./GridEntityCustomData";
+export * from "./JSONRoomsFile";
+export * from "./PlayerHealth";
+export * from "./PocketItemDescription";
+export * from "./RoomDescription";
+export * from "./SaveData";
+export * from "./TrinketSituation";

package/src/interfaces/indexTypeDoc.ts

@@ -0,0 +1,10 @@
+export * as ChargeBarSprites from "./ChargeBarSprites";
+export * as Corner from "./Corner";
+export * as CustomStageLua from "./CustomStageLua";
+export * as GridEntityCustomData from "./GridEntityCustomData";
+export * as JSONRoomsFile from "./JSONRoomsFile";
+export * as PlayerHealth from "./PlayerHealth";
+export * as PocketItemDescription from "./PocketItemDescription";
+export * as RoomDescription from "./RoomDescription";
+export * as SaveData from "./SaveData";
+export * as TrinketSituation from "./TrinketSituation";

package/src/interfaces/{AddCallbackParameterCustom.ts → private/AddCallbackParameterCustom.ts}

@@ -1,91 +1,91 @@
-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 { PostCollectibleEmptyRegisterParameters } from "../callbacks/subscriptions/postCollectibleEmpty";
-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 { PostGridEntityCustomBrokenRegisterParameters } from "../callbacks/subscriptions/postGridEntityCustomBroken";
-import { PostGridEntityCustomCollisionRegisterParameters } from "../callbacks/subscriptions/postGridEntityCustomCollision";
-import { PostGridEntityCustomRenderRegisterParameters } from "../callbacks/subscriptions/postGridEntityCustomRender";
-import { PostGridEntityCustomUpdateRegisterParameters } from "../callbacks/subscriptions/postGridEntityCustomUpdate";
-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 { PostPlayerInitFirstRegisterParameters } from "../callbacks/subscriptions/postPlayerInitFirst";
-import { PostPlayerInitLateRegisterParameters } from "../callbacks/subscriptions/postPlayerInitLate";
-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";
+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 { PostCollectibleEmptyRegisterParameters } from "../../callbacks/subscriptions/postCollectibleEmpty";
+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 { PostGridEntityCustomBrokenRegisterParameters } from "../../callbacks/subscriptions/postGridEntityCustomBroken";
+import { PostGridEntityCustomCollisionRegisterParameters } from "../../callbacks/subscriptions/postGridEntityCustomCollision";
+import { PostGridEntityCustomRenderRegisterParameters } from "../../callbacks/subscriptions/postGridEntityCustomRender";
+import { PostGridEntityCustomUpdateRegisterParameters } from "../../callbacks/subscriptions/postGridEntityCustomUpdate";
+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 { PostPlayerInitFirstRegisterParameters } from "../../callbacks/subscriptions/postPlayerInitFirst";
+import { PostPlayerInitLateRegisterParameters } from "../../callbacks/subscriptions/postPlayerInitLate";
+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;

package/src/interfaces/{CustomStage.ts → private/CustomStage.ts}

@@ -3,7 +3,7 @@ import {
   RoomShape,
   RoomType,
 } from "isaac-typescript-definitions";
-import { CustomStageLua, CustomStageRoomMetadata } from "./CustomStageLua";
+import { CustomStageLua, CustomStageRoomMetadata } from "../CustomStageLua";
 
 export interface CustomStage extends CustomStageLua {
   /** A map that makes it easier to select certain room type/shape/door combinations. */

package/src/maps/index.ts

@@ -0,0 +1,4 @@
+export * from "./cardMap";
+export * from "./characterMap";
+export * from "./pillEffectMap";
+export * from "./roomTypeMap";

package/src/maps/indexTypeDoc.ts

@@ -0,0 +1,4 @@
+export * as CardMap from "./cardMap";
+export * as CharacterMap from "./characterMap";
+export * as PillEffectMap from "./pillEffectMap";
+export * as RoomTypeMap from "./roomTypeMap";

package/src/objects/LRoomShapeToRectangles.ts

@@ -1,5 +1,5 @@
 import { RoomShape } from "isaac-typescript-definitions";
-import { VectorZero } from "../constants";
+import { VectorZero } from "../core/constants";
 
 const TWO_BY_TWO_BOTTOM_RIGHT = Vector(25, 13);
 

package/src/objects/callbackRegisterFunctions.ts

@@ -86,7 +86,7 @@ import { preCustomReviveRegister } from "../callbacks/subscriptions/preCustomRev
 import { preItemPickupRegister } from "../callbacks/subscriptions/preItemPickup";
 import { preNewLevelRegister } from "../callbacks/subscriptions/preNewLevel";
 import { ModCallbackCustom } from "../enums/ModCallbackCustom";
-import { AddCallbackParameterCustom } from "../interfaces/AddCallbackParameterCustom";
+import { AddCallbackParameterCustom } from "../interfaces/private/AddCallbackParameterCustom";
 
 export const CALLBACK_REGISTER_FUNCTIONS: {
   readonly [key in ModCallbackCustom]: (

package/src/objects/directionToVector.ts

@@ -1,5 +1,5 @@
 import { Direction } from "isaac-typescript-definitions";
-import { VectorZero } from "../constants";
+import { VectorZero } from "../core/constants";
 
 export const DIRECTION_TO_VECTOR: {
   readonly [key in Direction]: Readonly<Vector>;

package/src/objects/index.ts

@@ -0,0 +1 @@
+export * from "./colors";

package/src/objects/indexTypeDoc.ts

@@ -0,0 +1 @@
+export * as Colors from "./colors";

package/src/objects/roomShapeToDoorSlotsToGridIndexDelta.ts

@@ -1,5 +1,5 @@
 import { DoorSlot, RoomShape } from "isaac-typescript-definitions";
-import { LEVEL_GRID_ROW_WIDTH } from "../constants";
+import { LEVEL_GRID_ROW_WIDTH } from "../core/constants";
 
 const LEFT = -1;
 const UP = -LEVEL_GRID_ROW_WIDTH;

package/src/objects/roomShapeToTopLeftPosition.ts

@@ -1,5 +1,5 @@
 import { RoomShape } from "isaac-typescript-definitions";
-import { VectorZero } from "../constants";
+import { VectorZero } from "../core/constants";
 
 const NARROW_HORIZONTAL_TOP_LEFT_POSITION = Vector(0, 2);
 const NARROW_VERTICAL_TOP_LEFT_POSITION = Vector(4, 0);

package/src/patchErrorFunctions.ts

@@ -29,8 +29,6 @@ let vanillaError: ErrorFunction | undefined;
  *
  * Traceback functionality can only be added if the "--luadebug" flag is turned on, so this function
  * does nothing if the "--luadebug" flag is disabled.
- *
- * @internal
  */
 export function patchErrorFunction(): void {
   // Only replace the function if the "--luadebug" launch flag is enabled.

package/src/types/Immutable.ts

@@ -0,0 +1,26 @@
+/**
+ * Immutable is a type that will make the given array/map/set/object recursively read-only.
+ *
+ * From: https://stackoverflow.com/questions/41879327/deepreadonly-object-typescript
+ */
+export type Immutable<T> = T extends ImmutablePrimitive
+  ? T
+  : T extends Array<infer U>
+  ? ImmutableArray<U>
+  : T extends Map<infer K, infer V>
+  ? ImmutableMap<K, V>
+  : T extends Set<infer M>
+  ? ImmutableSet<M>
+  : ImmutableObject<T>;
+
+type ImmutablePrimitive =
+  | undefined
+  | null
+  | boolean
+  | string
+  | number
+  | Function; // eslint-disable-line @typescript-eslint/ban-types
+type ImmutableArray<T> = ReadonlyArray<Immutable<T>>;
+type ImmutableMap<K, V> = ReadonlyMap<Immutable<K>, Immutable<V>>;
+type ImmutableSet<T> = ReadonlySet<Immutable<T>>;
+type ImmutableObject<T> = { readonly [K in keyof T]: Immutable<T[K]> };

package/src/types/PickingUpItem.ts

@@ -45,7 +45,6 @@ export interface PickingUpItemTrinket {
 const DEFAULT_ITEM_TYPE = ItemType.NULL;
 const DEFAULT_SUB_TYPE = CollectibleType.NULL;
 
-/** @internal */
 export function newPickingUpItem(): PickingUpItem {
   return {
     itemType: DEFAULT_ITEM_TYPE,
@@ -53,7 +52,6 @@ export function newPickingUpItem(): PickingUpItem {
   };
 }
 
-/** @internal */
 export function resetPickingUpItem(pickingUpItem: PickingUpItem): void {
   pickingUpItem.itemType = DEFAULT_ITEM_TYPE;
   pickingUpItem.subType = DEFAULT_SUB_TYPE;