isaacscript-common 87.3.0 → 87.5.0

package/dist/lualib_bundle.lua

@@ -773,10 +773,11 @@ end
 
 local __TS__AsyncAwaiter, __TS__Await
 do
-    local cocreate = coroutine.create
-    local coresume = coroutine.resume
-    local costatus = coroutine.status
-    local coyield = coroutine.yield
+    local ____coroutine = _G.coroutine or ({})
+    local cocreate = ____coroutine.create
+    local coresume = ____coroutine.resume
+    local costatus = ____coroutine.status
+    local coyield = ____coroutine.yield
     function __TS__AsyncAwaiter(generator)
         return __TS__New(
             __TS__Promise,
@@ -1417,6 +1418,22 @@ do
     Map[Symbol.species] = Map
 end
 
+local function __TS__MapGroupBy(items, keySelector)
+    local result = __TS__New(Map)
+    local i = 0
+    for ____, item in __TS__Iterator(items) do
+        local key = keySelector(nil, item, i)
+        if result:has(key) then
+            local ____temp_0 = result:get(key)
+            ____temp_0[#____temp_0 + 1] = item
+        else
+            result:set(key, {item})
+        end
+        i = i + 1
+    end
+    return result
+end
+
 local __TS__Match = string.match
 
 local __TS__MathAtan2 = math.atan2 or math.atan
@@ -1671,6 +1688,22 @@ local function __TS__ObjectFromEntries(entries)
     return obj
 end
 
+local function __TS__ObjectGroupBy(items, keySelector)
+    local result = {}
+    local i = 0
+    for ____, item in __TS__Iterator(items) do
+        local key = keySelector(nil, item, i)
+        if result[key] ~= nil then
+            local ____result_key_0 = result[key]
+            ____result_key_0[#____result_key_0 + 1] = item
+        else
+            result[key] = {item}
+        end
+        i = i + 1
+    end
+    return result
+end
+
 local function __TS__ObjectKeys(obj)
     local result = {}
     local len = 0
@@ -1994,6 +2027,64 @@ do
             end
         }
     end
+    function Set.prototype.union(self, other)
+        local result = __TS__New(Set, self)
+        for ____, item in __TS__Iterator(other) do
+            result:add(item)
+        end
+        return result
+    end
+    function Set.prototype.intersection(self, other)
+        local result = __TS__New(Set)
+        for ____, item in __TS__Iterator(self) do
+            if other:has(item) then
+                result:add(item)
+            end
+        end
+        return result
+    end
+    function Set.prototype.difference(self, other)
+        local result = __TS__New(Set, self)
+        for ____, item in __TS__Iterator(other) do
+            result:delete(item)
+        end
+        return result
+    end
+    function Set.prototype.symmetricDifference(self, other)
+        local result = __TS__New(Set, self)
+        for ____, item in __TS__Iterator(other) do
+            if self:has(item) then
+                result:delete(item)
+            else
+                result:add(item)
+            end
+        end
+        return result
+    end
+    function Set.prototype.isSubsetOf(self, other)
+        for ____, item in __TS__Iterator(self) do
+            if not other:has(item) then
+                return false
+            end
+        end
+        return true
+    end
+    function Set.prototype.isSupersetOf(self, other)
+        for ____, item in __TS__Iterator(other) do
+            if not self:has(item) then
+                return false
+            end
+        end
+        return true
+    end
+    function Set.prototype.isDisjointFrom(self, other)
+        for ____, item in __TS__Iterator(self) do
+            if other:has(item) then
+                return false
+            end
+        end
+        return true
+    end
     Set[Symbol.species] = Set
 end
 
@@ -2563,6 +2654,7 @@ return {
   __TS__Iterator = __TS__Iterator,
   __TS__LuaIteratorSpread = __TS__LuaIteratorSpread,
   Map = Map,
+  __TS__MapGroupBy = __TS__MapGroupBy,
   __TS__Match = __TS__Match,
   __TS__MathAtan2 = __TS__MathAtan2,
   __TS__MathModf = __TS__MathModf,
@@ -2582,6 +2674,7 @@ return {
   __TS__ObjectFromEntries = __TS__ObjectFromEntries,
   __TS__ObjectGetOwnPropertyDescriptor = __TS__ObjectGetOwnPropertyDescriptor,
   __TS__ObjectGetOwnPropertyDescriptors = __TS__ObjectGetOwnPropertyDescriptors,
+  __TS__ObjectGroupBy = __TS__ObjectGroupBy,
   __TS__ObjectKeys = __TS__ObjectKeys,
   __TS__ObjectRest = __TS__ObjectRest,
   __TS__ObjectValues = __TS__ObjectValues,

package/dist/maps/defaultPlayerStatMap.d.ts

@@ -1,3 +1,7 @@
 /** The default fire delay is represented in the tear stat, not the `MaxFireDelay` value. */
-export declare const DEFAULT_PLAYER_STAT_MAP: ReadonlyMap<import("isaac-typescript-definitions").CacheFlag, number>;
+export declare const DEFAULT_PLAYER_STAT_MAP: ReadonlyMap<number & {
+    readonly __bitFlagBrand: symbol;
+} & {
+    readonly __cacheFlagBrand: symbol;
+}, number>;
 //# sourceMappingURL=defaultPlayerStatMap.d.ts.map

package/dist/maps/defaultPlayerStatMap.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"defaultPlayerStatMap.d.ts","sourceRoot":"","sources":["../../src/maps/defaultPlayerStatMap.ts"],"names":[],"mappings":"AAMA,4FAA4F;AAC5F,eAAO,MAAM,uBAAuB,uEAUlC,CAAC"}
+{"version":3,"file":"defaultPlayerStatMap.d.ts","sourceRoot":"","sources":["../../src/maps/defaultPlayerStatMap.ts"],"names":[],"mappings":"AAMA,4FAA4F;AAC5F,eAAO,MAAM,uBAAuB;;;;UAUlC,CAAC"}

package/dist/objects/doorSlotToDoorSlotFlag.d.ts

@@ -1,13 +1,49 @@
 /// <reference types="isaac-typescript-definitions" />
 export declare const DOOR_SLOT_TO_DOOR_SLOT_FLAG: {
-    readonly [-1]: BitFlags<import("isaac-typescript-definitions").DoorSlotFlag>;
-    readonly 0: import("isaac-typescript-definitions").DoorSlotFlag;
-    readonly 1: import("isaac-typescript-definitions").DoorSlotFlag;
-    readonly 2: import("isaac-typescript-definitions").DoorSlotFlag;
-    readonly 3: import("isaac-typescript-definitions").DoorSlotFlag;
-    readonly 4: import("isaac-typescript-definitions").DoorSlotFlag;
-    readonly 5: import("isaac-typescript-definitions").DoorSlotFlag;
-    readonly 6: import("isaac-typescript-definitions").DoorSlotFlag;
-    readonly 7: import("isaac-typescript-definitions").DoorSlotFlag;
+    readonly [-1]: BitFlags<number & {
+        readonly __bitFlagBrand: symbol;
+    } & {
+        readonly __doorSlotFlagBrand: symbol;
+    }>;
+    readonly 0: number & {
+        readonly __bitFlagBrand: symbol;
+    } & {
+        readonly __doorSlotFlagBrand: symbol;
+    };
+    readonly 1: number & {
+        readonly __bitFlagBrand: symbol;
+    } & {
+        readonly __doorSlotFlagBrand: symbol;
+    };
+    readonly 2: number & {
+        readonly __bitFlagBrand: symbol;
+    } & {
+        readonly __doorSlotFlagBrand: symbol;
+    };
+    readonly 3: number & {
+        readonly __bitFlagBrand: symbol;
+    } & {
+        readonly __doorSlotFlagBrand: symbol;
+    };
+    readonly 4: number & {
+        readonly __bitFlagBrand: symbol;
+    } & {
+        readonly __doorSlotFlagBrand: symbol;
+    };
+    readonly 5: number & {
+        readonly __bitFlagBrand: symbol;
+    } & {
+        readonly __doorSlotFlagBrand: symbol;
+    };
+    readonly 6: number & {
+        readonly __bitFlagBrand: symbol;
+    } & {
+        readonly __doorSlotFlagBrand: symbol;
+    };
+    readonly 7: number & {
+        readonly __bitFlagBrand: symbol;
+    } & {
+        readonly __doorSlotFlagBrand: symbol;
+    };
 };
 //# sourceMappingURL=doorSlotToDoorSlotFlag.d.ts.map

package/dist/objects/doorSlotToDoorSlotFlag.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"doorSlotToDoorSlotFlag.d.ts","sourceRoot":"","sources":["../../src/objects/doorSlotToDoorSlotFlag.ts"],"names":[],"mappings":";AAMA,eAAO,MAAM,2BAA2B;;;;;;;;;;CAUW,CAAC"}
+{"version":3,"file":"doorSlotToDoorSlotFlag.d.ts","sourceRoot":"","sources":["../../src/objects/doorSlotToDoorSlotFlag.ts"],"names":[],"mappings":";AAMA,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAUW,CAAC"}

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.42.3"
+      "packageVersion": "7.47.0"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "87.3.0",
+  "version": "87.5.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -37,6 +37,6 @@
     "lint": "tsx --tsconfig ./scripts/tsconfig.json ./scripts/lint.mts"
   },
   "dependencies": {
-    "isaac-typescript-definitions": "^41.1.0"
+    "isaac-typescript-definitions": "^42.2.0"
   }
 }

package/src/classes/features/callbackLogic/ItemPickupDetection.ts

@@ -5,6 +5,7 @@ import type {
 import { ItemType } from "isaac-typescript-definitions";
 import { ModCallbackCustom } from "../../../enums/ModCallbackCustom";
 import { defaultMapGetPlayer } from "../../../functions/playerDataStructures";
+import { dequeueItem } from "../../../functions/players";
 import { asNumber } from "../../../functions/types";
 import type { PickingUpItem } from "../../../types/PickingUpItem";
 import {
@@ -78,7 +79,7 @@ export class ItemPickupDetection extends Feature {
   private queueNotEmpty(player: EntityPlayer, pickingUpItem: PickingUpItem) {
     const queuedItem = player.QueuedItem.Item;
     if (queuedItem === undefined || queuedItem.Type === ItemType.NULL) {
-      // This should never happen, since the `EntityPlayer.IsItemQueueEmpty` method returned true.
+      // This should never happen, since the `EntityPlayer.IsItemQueueEmpty` method returned false.
       return;
     }
 
@@ -90,7 +91,10 @@ export class ItemPickupDetection extends Feature {
       pickingUpItem.itemType = queuedItem.Type;
       pickingUpItem.subType = queuedItem.ID as CollectibleType | TrinketType;
 
-      this.preItemPickup.fire(player, pickingUpItem);
+      const shouldBeGranted = this.preItemPickup.fire(player, pickingUpItem);
+      if (shouldBeGranted === false) {
+        dequeueItem(player);
+      }
     }
   }
 }

package/src/enums/ModCallbackCustom.ts

@@ -1648,8 +1648,8 @@ export enum ModCallbackCustom {
   POST_PLAYER_COLLECTIBLE_REMOVED,
 
   /**
-   * Fires from the `ENTITY_TAKE_DMG` callback when a player takes fatal damage. Return false to
-   * prevent the fatal damage.
+   * Fires from the `ENTITY_TAKE_DMG` callback when a player takes fatal damage. You can optionally
+   * return false to prevent the fatal damage.
    *
    * Note that this function does properly take into account Guppy's Collar, Broken Ankh, Spirit
    * Shackles, and Mysterious Paper. It also takes into account using The Bible on Satan.
@@ -2450,7 +2450,8 @@ export enum ModCallbackCustom {
 
   /**
    * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when an item becomes queued (i.e. when
-   * the player begins to hold the item above their head).
+   * the player begins to hold the item above their head). You can optionally return false if you
+   * want the item to not be granted to the player.
    *
    * Note that this callback will only fire once per Forgotten/Soul pair.
    *
@@ -2464,7 +2465,7 @@ export enum ModCallbackCustom {
    * function preItemPickup(
    *   player: EntityPlayer,
    *   pickingUpItem: PickingUpItem,
-   * ): void {}
+   * ): boolean | undefined {}
    * ```
    */
   PRE_ITEM_PICKUP,

package/src/functions/entities.ts

@@ -640,8 +640,8 @@ export function setEntityRandomColor(entity: Entity): void {
 }
 
 /**
- * Helper function to spawn an entity. Use this instead of the `Isaac.Spawn` method if you do not
- * need to specify the velocity or spawner.
+ * Helper function to spawn an entity. Always use this instead of the `Isaac.Spawn` method, since
+ * using that method can crash the game.
  *
  * Also see the `spawnWithSeed` helper function.
  *
@@ -653,7 +653,7 @@ export function setEntityRandomColor(entity: Entity): void {
  * @param spawner Optional. The entity that will be the `SpawnerEntity`. Default is undefined.
  * @param seedOrRNG Optional. The seed or RNG object to use to generate the `InitSeed` of the
  *                  entity. Default is undefined, which will make the entity spawn with a random
- *                  seed using the `Isaac.Spawn` method.
+ *                  seed.
  */
 export function spawn(
   entityType: EntityType,
@@ -666,6 +666,7 @@ export function spawn(
 ): Entity {
   const room = game.GetRoom();
 
+  // We do an explicit check to prevent run-time errors in Lua environments.
   // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
   if (positionOrGridIndex === undefined) {
     const entityID = getEntityIDFromConstituents(entityType, variant, subType);
@@ -679,14 +680,7 @@ export function spawn(
     : room.GetGridPosition(positionOrGridIndex);
 
   if (seedOrRNG === undefined) {
-    return Isaac.Spawn(
-      entityType,
-      variant,
-      subType,
-      position,
-      velocity,
-      spawner,
-    );
+    seedOrRNG = newRNG();
   }
 
   const seed = isRNG(seedOrRNG) ? seedOrRNG.Next() : seedOrRNG;

package/src/functions/gridEntities.ts

@@ -1219,6 +1219,18 @@ export function spawnGridEntityWithVariant(
 ): GridEntity | undefined {
   const room = game.GetRoom();
 
+  // We do an explicit check to prevent run-time errors in Lua environments.
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+  if (gridIndexOrPosition === undefined) {
+    const gridEntityID = getGridEntityIDFromConstituents(
+      gridEntityType,
+      variant,
+    );
+    error(
+      `Failed to spawn grid entity ${gridEntityID} since an undefined position was passed to the "spawnGridEntityWithVariant" function.`,
+    );
+  }
+
   const existingGridEntity = isVector(gridIndexOrPosition)
     ? room.GetGridEntityFromPos(gridIndexOrPosition)
     : room.GetGridEntity(gridIndexOrPosition);

package/src/functions/players.ts

@@ -73,6 +73,8 @@ export function canPlayerCrushRocks(player: EntityPlayer): boolean {
  *
  * Under the hood, this clones the `QueuedItemData`, since directly setting the `Item` field to
  * `undefined` does not work for some reason.
+ *
+ * This method was discovered by im_tem.
  */
 export function dequeueItem(player: EntityPlayer): boolean {
   if (player.QueuedItem.Item === undefined) {

package/src/functions/string.ts

@@ -140,7 +140,7 @@ export function getPartialMatch(
  * Helper function to parse a Semantic Versioning string into its individual constituents. Returns
  * undefined if the submitted string was not a proper Semantic Version string.
  *
- * https://semver.org/
+ * @see https://semver.org/
  */
 export function parseSemanticVersion(versionString: string):
   | {

package/src/functions/utils.ts

@@ -181,6 +181,35 @@ export function isRepentance(): boolean {
   return isFunction(getAnimation);
 }
 
+/**
+ * Helper function to check if the player is using REPENTOGON, an exe-hack which expands the modding
+ * API.
+ *
+ * Although REPENTOGON has a `REPENTOGON` global to check if it's present, it is not safe to use as
+ * it can be overwritten by other mods.
+ *
+ * Specifically, this function checks for the `Sprite.Continue` method:
+ * https://repentogon.com/Sprite.html#continue
+ */
+export function isRepentogon(): boolean {
+  const metatable = getmetatable(Sprite) as LuaMap<string, unknown> | undefined;
+  assertDefined(
+    metatable,
+    "Failed to get the metatable of the Sprite global table.",
+  );
+
+  const classTable = metatable.get("__class") as
+    | LuaMap<string, unknown>
+    | undefined;
+  assertDefined(
+    classTable,
+    'Failed to get the "__class" key of the Sprite metatable.',
+  );
+
+  const getAnimation = classTable.get("Continue");
+  return isFunction(getAnimation);
+}
+
 /**
  * Helper function to repeat code N times. This is faster to type and cleaner than using a for loop.
  *

package/src/interfaces/private/AddCallbackParametersCustom.ts

@@ -975,12 +975,17 @@ export interface AddCallbackParametersCustom {
   ];
 
   [ModCallbackCustom.PRE_ITEM_PICKUP]:
-    | [callback: (player: EntityPlayer, pickingUpItem: PickingUpItem) => void]
+    | [
+        callback: (
+          player: EntityPlayer,
+          pickingUpItem: PickingUpItem,
+        ) => boolean | undefined,
+      ]
     | [
         callback: (
           player: EntityPlayer,
           pickingUpItem: PickingUpItemCollectible,
-        ) => void,
+        ) => boolean | undefined,
         itemType: ItemType.PASSIVE | ItemType.ACTIVE | ItemType.FAMILIAR,
         collectibleType?: CollectibleType,
       ]
@@ -988,7 +993,7 @@ export interface AddCallbackParametersCustom {
         callback: (
           player: EntityPlayer,
           pickingUpItem: PickingUpItemTrinket,
-        ) => void,
+        ) => boolean | undefined,
         itemType: ItemType.TRINKET,
         trinketType?: TrinketType,
       ];