isaacscript-common 12.3.7 → 12.4.0

package/src/features/saveDataManager/main.ts

@@ -138,6 +138,18 @@ function makeGlowingHourGlassBackup() {
   iterateTableInOrder(
     saveDataMap,
     (subscriberName, saveData) => {
+      // We make the Glowing Hour Glass backup using `SerializationType.SERIALIZE`, which means that
+      // we cannot operate on unserializable data, such as functions. Save data that utilizes
+      // unserializable data will typically be marked using a conditional function that evaluates to
+      // false, so we skip all save data that matches this criteria.
+      const conditionalFunc = saveDataConditionalFuncMap.get(subscriberName);
+      if (conditionalFunc !== undefined) {
+        const shouldSave = conditionalFunc();
+        if (!shouldSave) {
+          return;
+        }
+      }
+
       for (const saveDataKey of SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_BACKUP_KEYS) {
         const childTable = saveData[saveDataKey];
         if (childTable === undefined) {
@@ -180,6 +192,18 @@ function restoreGlowingHourGlassBackup() {
   iterateTableInOrder(
     saveDataMap,
     (subscriberName, saveData) => {
+      // We make the Glowing Hour Glass backup using `SerializationType.SERIALIZE`, which means that
+      // we cannot operate on unserializable data, such as functions. Save data that utilizes
+      // unserializable data will typically be marked using a conditional function that evaluates to
+      // false, so we skip all save data that matches this criteria.
+      const conditionalFunc = saveDataConditionalFuncMap.get(subscriberName);
+      if (conditionalFunc !== undefined) {
+        const shouldSave = conditionalFunc();
+        if (!shouldSave) {
+          return;
+        }
+      }
+
       for (const saveDataKey of SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_BACKUP_KEYS) {
         const childTable = saveData[saveDataKey];
         if (childTable === undefined) {

package/src/functions/ui.ts

@@ -4,24 +4,21 @@ import { UI_HEART_WIDTH, VectorZero } from "../core/constants";
 import { copyVector } from "./vector";
 
 /**
- * In the options menu, players have the ability to set a HUD offset. However, mods do not have
- * access to this value. To get around this, Mod Config Menu provides a separate HUD offset setting
- * on the first page of the menu. This is intended to be set by end-users to match their vanilla HUD
- * offset setting so that mods can render UI elements to the screen in the correct position.
+ * In the options menu, players have the ability to set a HUD offset. This uses the current HUD
+ * offset to generate a vector that should be added to the corresponding position that you want to
+ * draw a UI element.
  *
- * @returns If the user does not have Mod Config Menu enabled, or does not have this option set,
- *          then this function will return `Vector.Zero.` Otherwise, it will return a Vector that
- *          represents a HUD offset that should be added to the position of a UI element.
+ * For example:
+ * - If the user does not have a HUD offset configured, this function will return `Vector(0, 0)`.
+ * - If the user has a HUD offset of 1.0 configured, this function will return 10
  */
 export function getHUDOffsetVector(): Vector {
-  const defaultVector = copyVector(VectorZero);
-
   // Convert e.g. 0.4 to 4.
   const hudOffset = math.floor(Options.HUDOffset * 10);
 
   // Expected values are integers between 1 and 10.
   if (hudOffset < 1 || hudOffset > 10) {
-    return defaultVector;
+    return copyVector(VectorZero);
   }
 
   const x = hudOffset * 2;

package/src/sets/entitiesWithArmorSet.ts

@@ -0,0 +1,58 @@
+import {
+  BeastVariant,
+  BoomFlyVariant,
+  DogmaVariant,
+  EntityType,
+  HiveVariant,
+  HopperVariant,
+  MotherVariant,
+  PooterVariant,
+} from "isaac-typescript-definitions";
+
+/**
+ * Corresponds to:
+ * https://bindingofisaacrebirth.fandom.com/wiki/Damage_Scaling#Entities_with_Armor_Values
+ *
+ * We use the entity ID instead of type + variant tuple so that we can have O(1) lookups.
+ */
+export const ENTITIES_WITH_ARMOR_SET = new Set([
+  `${EntityType.POOTER}.${PooterVariant.TAINTED_POOTER}`, // 14.2
+  `${EntityType.HIVE}.${HiveVariant.TAINTED_MULLIGAN}`, // 22.3
+  `${EntityType.BOOM_FLY}.${BoomFlyVariant.TAINTED_BOOM_FLY}`, // 22.6
+  `${EntityType.HOPPER}.${HopperVariant.TAINTED_HOPPER}`, // 29.3
+  `${EntityType.SPITTY}`, // 31.1
+  // 61.7
+  // 102.2
+  // 240.3
+  // 244.2
+  // 244.3
+  // 274.0
+  // 274.1
+  // 274.2
+  // 275.0
+  // 275.1
+  // 275.2
+  // 406.0
+  // 407.0
+  // 412.0
+  // 802.0
+  // 802.1
+  // 812.1
+  // 827.1
+  // 829.1
+  // 831.0
+  // 850.0
+  // 850.1
+  // 850.2
+  // 855.0
+  // 855.1
+  // 888.0
+  `${EntityType.MOTHER}.${MotherVariant.MOTHER_1}`, // 912.0
+  `${EntityType.MOTHER}.${MotherVariant.MOTHER_2}`, // 912.10
+  `${EntityType.DOGMA}.${DogmaVariant.DOGMA_PHASE_1}`, // 950.0
+  `${EntityType.BEAST}.${BeastVariant.BEAST}`, // 951.0
+  `${EntityType.BEAST}.${BeastVariant.ULTRA_FAMINE}`, // 951.10
+  `${EntityType.BEAST}.${BeastVariant.ULTRA_PESTILENCE}`, // 951.20
+  `${EntityType.BEAST}.${BeastVariant.ULTRA_WAR}`, // 951.30
+  `${EntityType.BEAST}.${BeastVariant.ULTRA_DEATH}`, // 951.40
+]);

package/dist/src/indexLua.d.ts

@@ -1,181 +0,0 @@
-export * from "./classes/DefaultMap";
-export * from "./classes/ModUpgraded";
-export * from "./core/cachedClasses";
-export * from "./core/constants";
-export * from "./core/constantsFirstLast";
-export * from "./core/upgradeMod";
-export * from "./enums/AmbushType";
-export * from "./enums/CornerType";
-export * from "./enums/HealthType";
-export * from "./enums/ModCallbackCustom";
-export * from "./enums/PocketItemType";
-export * from "./enums/RockAltType";
-export * from "./enums/SaveDataKey";
-export * from "./enums/SerializationType";
-export * from "./enums/SlotDestructionType";
-export * from "./enums/StatType";
-export * from "./features/characterHealthConversion";
-export * from "./features/characterStats";
-export * from "./features/collectibleItemPoolType";
-export * from "./features/customDoor";
-export * from "./features/customGridEntity";
-export * from "./features/customPickup";
-export * from "./features/customStage/exports";
-export * from "./features/customTrapdoor/exports";
-export * from "./features/debugDisplay/exports";
-export * from "./features/deployJSONRoom";
-export * from "./features/disableAllSound";
-export * from "./features/disableInputs";
-export * from "./features/extraConsoleCommands/exports";
-export * from "./features/fadeInRemover";
-export * from "./features/fastReset";
-export * from "./features/firstLast";
-export * from "./features/forgottenSwitch";
-export * from "./features/pause";
-export * from "./features/persistentEntities";
-export * from "./features/pickupIndex";
-export * from "./features/playerInventory";
-export * from "./features/ponyDetection";
-export * from "./features/preventChildEntities";
-export * from "./features/preventCollectibleRotation";
-export * from "./features/registerHotkey";
-export * from "./features/roomClearFrame";
-export * from "./features/roomHistory";
-export * from "./features/runInNFrames";
-export * from "./features/saveDataManager/exports";
-export * from "./features/sirenHelpers";
-export * from "./features/stageHistory";
-export * from "./features/taintedLazarusPlayers";
-export * from "./functions/ambush";
-export * from "./functions/array";
-export * from "./functions/arrayLua";
-export * from "./functions/benchmark";
-export * from "./functions/bitSet128";
-export * from "./functions/bitwise";
-export * from "./functions/bombs";
-export * from "./functions/bosses";
-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/debugFunctions";
-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/hex";
-export * from "./functions/initArray";
-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/playerStats";
-export * from "./functions/pocketItems";
-export * from "./functions/positionVelocity";
-export * from "./functions/pressurePlate";
-export * from "./functions/projectiles";
-export * from "./functions/random";
-export * from "./functions/reorderedCallbacks";
-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/roomTransition";
-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/trinketSet";
-export * from "./functions/tstlClass";
-export * from "./functions/types";
-export * from "./functions/ui";
-export * from "./functions/utils";
-export * from "./functions/vector";
-export * from "./functions/weighted";
-export * from "./interfaces/ChargeBarSprites";
-export * from "./interfaces/Corner";
-export * from "./interfaces/CustomStageTSConfig";
-export * from "./interfaces/GridEntityCustomData";
-export * from "./interfaces/JSONRoomsFile";
-export * from "./interfaces/PlayerHealth";
-export * from "./interfaces/PocketItemDescription";
-export * from "./interfaces/RoomDescription";
-export * from "./interfaces/SaveData";
-export * from "./interfaces/StatTypeType";
-export * from "./interfaces/TrinketSituation";
-export * from "./maps/cardNameToTypeMap";
-export * from "./maps/characterNameToTypeMap";
-export * from "./maps/pillNameToEffectMap";
-export * from "./maps/roomNameToTypeMap";
-export * from "./objects/colors";
-export * from "./objects/kColors";
-export * from "./types/AnyEntity";
-export * from "./types/AnyGridEntity";
-export * from "./types/CollectibleIndex";
-export * from "./types/Immutable";
-export * from "./types/PickingUpItem";
-export * from "./types/PickupIndex";
-export * from "./types/PlayerIndex";
-export * from "./types/PossibleStatType";
-export * from "./types/TSTLClass";
-export * from "./types/WeightedArray";
-export * from "isaac-typescript-definitions";
-//# sourceMappingURL=indexLua.d.ts.map

package/dist/src/indexLua.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"indexLua.d.ts","sourceRoot":"","sources":["../../src/indexLua.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kBAAkB,CAAC;AACjC,cAAc,sCAAsC,CAAC;AACrD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oCAAoC,CAAC;AACnD,cAAc,uBAAuB,CAAC;AACtC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mCAAmC,CAAC;AAClD,cAAc,iCAAiC,CAAC;AAChD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,yCAAyC,CAAC;AACxD,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,kBAAkB,CAAC;AACjC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,uCAAuC,CAAC;AACtD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,oCAAoC,CAAC;AACnD,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kCAAkC,CAAC;AACjD,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oCAAoC,CAAC;AACnD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,8BAA8B,CAAC"}