isaacscript-common 87.3.0 → 87.5.0

package/dist/index.lua

@@ -1103,6 +1103,110 @@ do
         end
     end
 end
+do
+    local ____export = require("interfaces.ChargeBarSprites")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("interfaces.Corner")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("interfaces.CustomStageTSConfig")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("interfaces.GridEntityCustomData")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("interfaces.JSONRoomsFile")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("interfaces.PlayerHealth")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("interfaces.PlayerStats")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("interfaces.PocketItemDescription")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("interfaces.RoomDescription")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("interfaces.SaveData")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("interfaces.StageHistoryEntry")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("interfaces.TSTLClassMetatable")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("interfaces.TrinketSituation")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("maps.cardNameToTypeMap")
     for ____exportKey, ____exportValue in pairs(____export) do
@@ -1175,6 +1279,182 @@ do
         end
     end
 end
+do
+    local ____export = require("types.AddSubtract")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.AllButFirst")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.AllButLast")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.AnyClass")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.AnyEntity")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.AnyFunction")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.AnyGridEntity")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.CompositionTypeSatisfiesEnum")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.ConversionHeartSubType")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.Decrement")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.ERange")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.EntityID")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.FunctionTuple")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.GridEntityID")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.HasFunction")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.IRange")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.Immutable")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.Increment")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.LowercaseKeys")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.NaturalNumbersLessThan")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.NaturalNumbersLessThanOrEqualTo")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.ObjectValues")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("types.PickingUpItem")
     for ____exportKey, ____exportValue in pairs(____export) do
@@ -1183,6 +1463,38 @@ do
         end
     end
 end
+do
+    local ____export = require("types.PickupIndex")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.PlayerIndex")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.PossibleStatType")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.PublicInterface")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("types.ReadonlyMap")
     for ____exportKey, ____exportValue in pairs(____export) do
@@ -1191,6 +1503,14 @@ do
         end
     end
 end
+do
+    local ____export = require("types.ReadonlyRecord")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("types.ReadonlySet")
     for ____exportKey, ____exportValue in pairs(____export) do
@@ -1199,4 +1519,116 @@ do
         end
     end
 end
+do
+    local ____export = require("types.StartsWithLowercase")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.StartsWithUppercase")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.TSTLClass")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.Tuple")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.TupleKeys")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.TupleToIntersection")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.TupleToUnion")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.TupleWithLengthBetween")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.TupleWithMaxLength")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.UnionToIntersection")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.UppercaseKeys")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.WeightedArray")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.WidenLiteral")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
+do
+    local ____export = require("types.Writable")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 return ____exports

package/dist/index.rollup.d.ts

@@ -725,12 +725,14 @@ declare interface AddCallbackParametersCustom {
     playerVariant?: PlayerVariant,
     character?: PlayerType
     ];
-    [ModCallbackCustom.PRE_ITEM_PICKUP]: [callback: (player: EntityPlayer, pickingUpItem: PickingUpItem) => void] | [
-    callback: (player: EntityPlayer, pickingUpItem: PickingUpItemCollectible) => void,
+    [ModCallbackCustom.PRE_ITEM_PICKUP]: [
+    callback: (player: EntityPlayer, pickingUpItem: PickingUpItem) => boolean | undefined
+    ] | [
+    callback: (player: EntityPlayer, pickingUpItem: PickingUpItemCollectible) => boolean | undefined,
     itemType: ItemType.PASSIVE | ItemType.ACTIVE | ItemType.FAMILIAR,
     collectibleType?: CollectibleType
     ] | [
-    callback: (player: EntityPlayer, pickingUpItem: PickingUpItemTrinket) => void,
+    callback: (player: EntityPlayer, pickingUpItem: PickingUpItemTrinket) => boolean | undefined,
     itemType: ItemType.TRINKET,
     trinketType?: TrinketType
     ];
@@ -947,7 +949,11 @@ export declare function addTrinketCostume(player: EntityPlayer, trinketType: Tri
  * - `DisplayFlag.SHADOW` (1 << 1)
  * - `DisplayFlag.SHOW_ICON` (1 << 2)
  */
-export declare const ALL_DISPLAY_FLAGS: BitFlags<DisplayFlag>;
+export declare const ALL_DISPLAY_FLAGS: BitFlags<number & {
+    readonly __bitFlagBrand: symbol;
+} & {
+    readonly __displayFlagBrand: symbol;
+}>;
 
 /** Helper type to create a new tuple containing all but the first element of another tuple. */
 export declare type AllButFirst<T extends unknown[]> = T extends [
@@ -3698,6 +3704,8 @@ declare class DeployJSONRoom extends Feature {
  *
  * 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 declare function dequeueItem(player: EntityPlayer): boolean;
 
@@ -10054,6 +10062,18 @@ export declare function isRepentanceDoor(door: GridEntityDoor): boolean;
  */
 export declare function isRepentanceStage(stageType: StageType): boolean;
 
+/**
+ * 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 declare function isRepentogon(): boolean;
+
 /** Returns true for card types that have `ItemConfigCardType.TAROT_REVERSE`. */
 export declare function isReverseTarotCard(cardType: CardType): boolean;
 
@@ -12814,8 +12834,8 @@ export declare enum ModCallbackCustom {
      */
     POST_PLAYER_COLLECTIBLE_REMOVED = 88,
     /**
-     * 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.
@@ -13572,7 +13592,8 @@ export declare enum ModCallbackCustom {
     PRE_GET_PEDESTAL = 132,
     /**
      * 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.
      *
@@ -13586,7 +13607,7 @@ export declare enum ModCallbackCustom {
      * function preItemPickup(
      *   player: EntityPlayer,
      *   pickingUpItem: PickingUpItem,
-     * ): void {}
+     * ): boolean | undefined {}
      * ```
      */
     PRE_ITEM_PICKUP = 133,
@@ -15363,7 +15384,7 @@ export declare function parseIntSafe(string: string): int | undefined;
  * 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 declare function parseSemanticVersion(versionString: string): {
     majorVersion: int;
@@ -18286,8 +18307,8 @@ export declare function sortTwoDimensionalArray<T>(a: readonly T[], b: readonly
 export declare type SoulHeartType = HeartSubType.SOUL | HeartSubType.BLACK | HeartSubType.BONE;
 
 /**
- * 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.
  *
@@ -18299,7 +18320,7 @@ export declare type SoulHeartType = HeartSubType.SOUL | HeartSubType.BLACK | Hea
  * @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 declare function spawn(entityType: EntityType, variant: int, subType: int, positionOrGridIndex: Vector | int, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): Entity;