isaacscript-common 2.2.0 → 2.3.0

package/src/functions/vector.ts

@@ -0,0 +1,145 @@
+import { Direction } from "isaac-typescript-definitions";
+import { SerializationBrand } from "../enums/private/SerializationBrand";
+import { SerializationType } from "../enums/SerializationType";
+import { isaacAPIClassEquals, isIsaacAPIClassOfType } from "./isaacAPIClass";
+import { copyValuesToTable, getNumbersFromTable, tableHasKeys } from "./table";
+import { ensureAllCases } from "./utils";
+
+type SerializedVector = LuaTable<string, unknown> & {
+  __serializedVectorBrand: void;
+};
+
+interface CopyVectorReturn {
+  [SerializationType.NONE]: Vector;
+  [SerializationType.SERIALIZE]: SerializedVector;
+  [SerializationType.DESERIALIZE]: Vector;
+}
+
+const KEYS = ["X", "Y"];
+const OBJECT_NAME = "Vector";
+
+/**
+ * Helper function to copy a `Vector` object.
+ *
+ * @param vector The vector to copy. In the case of deserialization, this will actually be a Lua
+ *               table instead of an instantiated Vector class.
+ * @param serializationType Default is `SerializationType.NONE`.
+ */
+export function copyVector<
+  V extends Vector | SerializedVector,
+  S extends SerializationType,
+>(vector: V, serializationType: S): CopyVectorReturn[S];
+export function copyVector<V extends Vector | SerializedVector>(
+  vector: V,
+): CopyVectorReturn[SerializationType.NONE];
+export function copyVector(
+  vector: Vector | SerializedVector,
+  serializationType = SerializationType.NONE,
+): CopyVectorReturn[keyof CopyVectorReturn] {
+  switch (serializationType) {
+    case SerializationType.NONE: {
+      if (!isVector(vector)) {
+        error(
+          `Failed to copy a ${OBJECT_NAME} object since the provided object was not a userdata ${OBJECT_NAME} class.`,
+        );
+      }
+
+      return Vector(vector.X, vector.Y);
+    }
+
+    case SerializationType.SERIALIZE: {
+      if (!isVector(vector)) {
+        error(
+          `Failed to serialize a ${OBJECT_NAME} object since the provided object was not a userdata ${OBJECT_NAME} class.`,
+        );
+      }
+
+      const vectorTable = new LuaTable<string, unknown>();
+      copyValuesToTable(vector, KEYS, vectorTable);
+      vectorTable.set(SerializationBrand.VECTOR, "");
+      return vectorTable as SerializedVector;
+    }
+
+    case SerializationType.DESERIALIZE: {
+      const vectorType = type(vector);
+      if (isVector(vector) || vectorType !== "table") {
+        error(
+          `Failed to deserialize a ${OBJECT_NAME} object since the provided object was not a Lua table.`,
+        );
+      }
+
+      const [x, y] = getNumbersFromTable(vector, OBJECT_NAME, ...KEYS);
+
+      if (x === undefined) {
+        error(
+          `Failed to deserialize a ${OBJECT_NAME} object since the provided object did not have a value for: x`,
+        );
+      }
+      if (y === undefined) {
+        error(
+          `Failed to deserialize a ${OBJECT_NAME} object since the provided object did not have a value for: y`,
+        );
+      }
+
+      return Vector(x, y);
+    }
+
+    default: {
+      return ensureAllCases(serializationType);
+    }
+  }
+}
+
+/**
+ * Used to determine is the given table is a serialized `Vector` object created by the save data
+ * manager and/or the `deepCopy` function.
+ */
+export function isSerializedVector(
+  object: unknown,
+): object is SerializedVector {
+  const objectType = type(object);
+  if (objectType !== "table") {
+    return false;
+  }
+
+  const table = object as LuaTable<AnyNotNil, unknown>;
+  return tableHasKeys(table, ...KEYS) && table.has(SerializationBrand.VECTOR);
+}
+
+/** Helper function to check if something is an instantiated Vector object. */
+export function isVector(object: unknown): object is Vector {
+  return isIsaacAPIClassOfType(object, OBJECT_NAME);
+}
+
+export function vectorEquals(vector1: Vector, vector2: Vector): boolean {
+  return isaacAPIClassEquals(vector1, vector2, KEYS);
+}
+
+/** Helper function for finding out which way a vector is pointing. */
+export function vectorToDirection(vector: Vector): Direction {
+  const degrees = vector.GetAngleDegrees();
+
+  if (degrees > -45 && degrees < 45) {
+    return Direction.RIGHT;
+  }
+
+  if (degrees >= 45 && degrees <= 135) {
+    return Direction.DOWN;
+  }
+
+  if (degrees <= -45 && degrees >= -135) {
+    return Direction.UP;
+  }
+
+  if (degrees > 135 || degrees < -135) {
+    return Direction.LEFT;
+  }
+
+  return Direction.NO_DIRECTION;
+}
+
+export function vectorToString(vector: Vector, round = false): string {
+  const x = round ? Math.round(vector.X) : vector.X;
+  const y = round ? Math.round(vector.Y) : vector.Y;
+  return `(${x}, ${y})`;
+}

package/src/index.ts

@@ -0,0 +1,162 @@
+/* eslint-disable sort-exports/sort-exports */
+
+export * from "./cachedClasses";
+export {
+  initCustomDoor,
+  spawnCustomDoor,
+} from "./callbacks/postCustomDoorEnter";
+export {
+  forceNewLevelCallback,
+  forceNewRoomCallback,
+} 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 * from "./features/debugDisplay/exports";
+export {
+  deployJSONRoom,
+  deployRandomJSONRoom,
+  emptyRoom,
+} from "./features/deployJSONRoom";
+export {
+  disableAllInputs,
+  disableAllInputsExceptFor,
+  disableMovementInputs,
+  disableShootingInputs,
+  enableAllInputs,
+  enableAllInputsExceptFor,
+} from "./features/disableInputs";
+export { disableAllSound, enableAllSound } from "./features/disableSound";
+export {
+  addConsoleCommand,
+  enableExtraConsoleCommands,
+  removeConsoleCommand,
+} from "./features/extraConsoleCommands/init";
+export { removeFadeIn, restoreFadeIn } from "./features/fadeInRemover";
+export { disableFastReset, enableFastReset } from "./features/fastReset";
+export { forgottenSwitch } from "./features/forgottenSwitch";
+export { getCollectibleItemPoolType } from "./features/getCollectibleItemPoolType";
+export { addCollectible, getPlayerInventory } from "./features/playerInventory";
+export * from "./features/ponyDetection";
+export { preventCollectibleRotation } from "./features/preventCollectibleRotation";
+export {
+  runInNGameFrames,
+  runInNRenderFrames,
+  runNextGameFrame,
+  runNextRenderFrame,
+} from "./features/runInNFrames";
+export * from "./features/saveDataManager/exports";
+export {
+  hasSirenStolenFamiliar,
+  setFamiliarNoSirenSteal,
+} from "./features/sirenHelpers";
+export { getTaintedLazarusSubPlayer } from "./features/taintedLazarusPlayers";
+export * from "./functions/array";
+export * from "./functions/benchmark";
+export * from "./functions/bitwise";
+export * from "./functions/boss";
+export * from "./functions/cacheFlag";
+export * from "./functions/cards";
+export * from "./functions/challenges";
+export * from "./functions/character";
+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/debug";
+export { deepCopy } from "./functions/deepCopy";
+export { deepCopyTests } from "./functions/deepCopyTests";
+export * from "./functions/direction";
+export * from "./functions/doors";
+export * from "./functions/easing";
+export * from "./functions/eden";
+export * from "./functions/entity";
+export * from "./functions/entitySpecific";
+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/gridEntity";
+export * from "./functions/gridEntitySpecific";
+export * from "./functions/input";
+export * from "./functions/isaacAPIClass";
+export * from "./functions/jsonHelpers";
+export * from "./functions/jsonRoom";
+export * from "./functions/kColor";
+export * from "./functions/language";
+export * from "./functions/level";
+export * from "./functions/log";
+export * from "./functions/map";
+export * from "./functions/math";
+export { mergeTests } from "./functions/mergeTests";
+export * from "./functions/npc";
+export * from "./functions/pickups";
+export * from "./functions/pickupVariants";
+export * from "./functions/pills";
+export * from "./functions/player";
+export * from "./functions/playerDataStructures";
+export * from "./functions/playerHealth";
+export * from "./functions/playerIndex";
+export * from "./functions/pocketItems";
+export * from "./functions/positionVelocity";
+export * from "./functions/random";
+export * from "./functions/revive";
+export * from "./functions/rng";
+export * from "./functions/roomData";
+export * from "./functions/roomGrid";
+export * from "./functions/rooms";
+export * from "./functions/roomShape";
+export * from "./functions/run";
+export * from "./functions/seeds";
+export * from "./functions/serialization";
+export * from "./functions/set";
+export * from "./functions/sound";
+export * from "./functions/spawnCollectible";
+export * from "./functions/sprite";
+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/ui";
+export * from "./functions/utils";
+export * from "./functions/vector";
+export * from "./interfaces/AddCallbackParameterCustom";
+export * from "./interfaces/JSONDoor";
+export * from "./interfaces/JSONEntity";
+export * from "./interfaces/JSONRoom";
+export * from "./interfaces/JSONRooms";
+export * from "./interfaces/JSONSpawn";
+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";

package/src/initCustomCallbacks.ts

@@ -0,0 +1,120 @@
+import { customReviveCallbacksInit } from "./callbacks/customRevive";
+import { itemPickupCallbacksInit } from "./callbacks/itemPickup";
+import { postBombInitLateCallbackInit } from "./callbacks/postBombInitLate";
+import { postBoneSwingCallbackInit } from "./callbacks/postBoneSwing";
+import { postCollectibleInitFirstCallbackInit } from "./callbacks/postCollectibleInitFirst";
+import { postCursedTeleportCallbackInit } from "./callbacks/postCursedTeleport";
+import { postCustomDoorEnterCallbackInit } from "./callbacks/postCustomDoorEnter";
+import { postDoorRenderInit } from "./callbacks/postDoorRender";
+import { postDoorUpdateInit } from "./callbacks/postDoorUpdate";
+import { postEffectInitLateCallbackInit } from "./callbacks/postEffectInitLate";
+import { postEffectStateChangedCallbackInit } from "./callbacks/postEffectStateChanged";
+import { postEsauJrCallbacksInit } from "./callbacks/postEsauJr";
+import { postFamiliarInitLateCallbackInit } from "./callbacks/postFamiliarInitLate";
+import { postFamiliarStateChangedCallbackInit } from "./callbacks/postFamiliarStateChanged";
+import { postFlipCallbacksInit } from "./callbacks/postFlip";
+import { postGreedModeWaveCallbackInit } from "./callbacks/postGreedModeWave";
+import { postGridEntityCallbacksInit } from "./callbacks/postGridEntity";
+import { postGridEntityCollisionInit } from "./callbacks/postGridEntityCollision";
+import { postGridEntityRenderInit } from "./callbacks/postGridEntityRender";
+import { postHolyMantleRemovedCallbackInit } from "./callbacks/postHolyMantleRemoved";
+import { postItemDischargeCallbackInit } from "./callbacks/postItemDischarged";
+import { postKnifeInitLateCallbackInit } from "./callbacks/postKnifeInitLate";
+import { postLaserInitLateCallbackInit } from "./callbacks/postLaserInitLate";
+import { postNPCInitLateCallbackInit } from "./callbacks/postNPCInitLate";
+import { postNPCStateChangedCallbackInit } from "./callbacks/postNPCStateChanged";
+import { postPickupCollectCallbackInit } from "./callbacks/postPickupCollect";
+import { postPickupInitLateCallbackInit } from "./callbacks/postPickupInitLate";
+import { postPickupStateChangedCallbackInit } from "./callbacks/postPickupStateChanged";
+import { postPitRenderInit } from "./callbacks/postPitRender";
+import { postPitUpdateInit } from "./callbacks/postPitUpdate";
+import { postPlayerChangeHealthCallbackInit } from "./callbacks/postPlayerChangeHealth";
+import { postPlayerChangeTypeCallbackInit } from "./callbacks/postPlayerChangeType";
+import { postPlayerFatalDamageCallbackInit } from "./callbacks/postPlayerFatalDamage";
+import { postPlayerInitLateCallbackInit } from "./callbacks/postPlayerInitLate";
+import { postPlayerReorderedCallbacksInit } from "./callbacks/postPlayerReordered";
+import { postPoopRenderInit } from "./callbacks/postPoopRender";
+import { postPoopUpdateInit } from "./callbacks/postPoopUpdate";
+import { postPressurePlateRenderInit } from "./callbacks/postPressurePlateRender";
+import { postPressurePlateUpdateInit } from "./callbacks/postPressurePlateUpdate";
+import { postProjectileInitLateCallbackInit } from "./callbacks/postProjectileInitLate";
+import { postPurchaseCallbackInit } from "./callbacks/postPurchase";
+import { postRockRenderInit } from "./callbacks/postRockRender";
+import { postRockUpdateInit } from "./callbacks/postRockUpdate";
+import { postRoomClearChangedCallbackInit } from "./callbacks/postRoomClearChanged";
+import { postSacrificeCallbackInit } from "./callbacks/postSacrifice";
+import { postSlotInitUpdateCallbacksInit } from "./callbacks/postSlotInitUpdate";
+import { postSlotRenderCallbacksInit } from "./callbacks/postSlotRender";
+import { postSpikesRenderInit } from "./callbacks/postSpikesRender";
+import { postSpikesUpdateInit } from "./callbacks/postSpikesUpdate";
+import { postTearInitLateCallbackInit } from "./callbacks/postTearInitLate";
+import { postTearInitVeryLateCallbackInit } from "./callbacks/postTearInitVeryLate";
+import { postTNTRenderInit } from "./callbacks/postTNTRender";
+import { postTNTUpdateInit } from "./callbacks/postTNTUpdate";
+import { postTransformationCallbackInit } from "./callbacks/postTransformation";
+import { postTrinketBreakCallbackInit } from "./callbacks/postTrinketBreak";
+import { preBerserkDeathCallbackInit } from "./callbacks/preBerserkDeath";
+import { preNewLevelCallbackInit } from "./callbacks/preNewLevel";
+import { reorderedCallbacksInit } from "./callbacks/reorderedCallbacks";
+import { ModUpgraded } from "./classes/ModUpgraded";
+
+export function initCustomCallbacks(mod: ModUpgraded): void {
+  customReviveCallbacksInit(mod);
+  itemPickupCallbacksInit(mod);
+  postBombInitLateCallbackInit(mod);
+  postBoneSwingCallbackInit(mod);
+  postCollectibleInitFirstCallbackInit(mod);
+  postCursedTeleportCallbackInit(mod);
+  postCustomDoorEnterCallbackInit();
+  postDoorRenderInit(mod);
+  postDoorUpdateInit(mod);
+  postEffectInitLateCallbackInit(mod);
+  postEffectStateChangedCallbackInit(mod);
+  postEsauJrCallbacksInit(mod);
+  postFamiliarInitLateCallbackInit(mod);
+  postFamiliarStateChangedCallbackInit(mod);
+  postFlipCallbacksInit(mod);
+  postGreedModeWaveCallbackInit(mod);
+  postGridEntityCallbacksInit(mod);
+  postGridEntityCollisionInit(mod);
+  postGridEntityRenderInit(mod);
+  postHolyMantleRemovedCallbackInit(mod);
+  postItemDischargeCallbackInit(mod);
+  postLaserInitLateCallbackInit(mod);
+  postKnifeInitLateCallbackInit(mod);
+  postNPCInitLateCallbackInit(mod);
+  postNPCStateChangedCallbackInit(mod);
+  postPickupCollectCallbackInit(mod);
+  postPickupInitLateCallbackInit(mod);
+  postPickupStateChangedCallbackInit(mod);
+  postPitRenderInit(mod);
+  postPitUpdateInit(mod);
+  postPlayerChangeHealthCallbackInit(mod);
+  postPlayerChangeTypeCallbackInit(mod);
+  postPlayerFatalDamageCallbackInit(mod);
+  postPlayerInitLateCallbackInit(mod);
+  postPlayerReorderedCallbacksInit(mod);
+  postPoopRenderInit(mod);
+  postPoopUpdateInit(mod);
+  postPressurePlateRenderInit(mod);
+  postPressurePlateUpdateInit(mod);
+  postProjectileInitLateCallbackInit(mod);
+  postPurchaseCallbackInit(mod);
+  postRockRenderInit(mod);
+  postRockUpdateInit(mod);
+  postRoomClearChangedCallbackInit(mod);
+  postSacrificeCallbackInit(mod);
+  postSlotInitUpdateCallbacksInit(mod);
+  postSlotRenderCallbacksInit(mod);
+  postSpikesRenderInit(mod);
+  postSpikesUpdateInit(mod);
+  postTearInitLateCallbackInit(mod);
+  postTearInitVeryLateCallbackInit(mod);
+  postTNTRenderInit(mod);
+  postTNTUpdateInit(mod);
+  postTransformationCallbackInit(mod);
+  postTrinketBreakCallbackInit(mod);
+  preBerserkDeathCallbackInit(mod);
+  preNewLevelCallbackInit(mod);
+  reorderedCallbacksInit(mod);
+}

package/src/initFeatures.ts

@@ -0,0 +1,37 @@
+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 { 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);
+  playerInventoryInit(mod);
+  ponyDetectionInit(mod);
+  preventCollectibleRotationInit(mod);
+  sirenHelpersInit(mod);
+  taintedLazarusPlayersInit(mod);
+}

package/src/interfaces/AddCallbackParameterCustom.ts

@@ -0,0 +1,174 @@
+import { PostBombInitRegisterParameters } from "../callbacks/subscriptions/postBombInitLate";
+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 { 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 { 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 { 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_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_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_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_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/src/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;
+}