isaacscript-common 1.0.459 → 1.0.463

package/dist/features/disableInputs.d.ts

@@ -6,7 +6,8 @@ export declare function disableInputsInit(mod: ModUpgraded): void;
 export declare function enableAllInputs(): void;
 /**
  * Helper function to disable all inputs.
- * This is useful because `EntityPlayer.ControlsEnabled` is not very reliable.
+ * This is useful because `EntityPlayer.ControlsEnabled` can be changed by the game under certain
+ * conditions.
  *
  * Call `enableAllInputs()` to set things back to normal.
  *
@@ -16,7 +17,8 @@ export declare function enableAllInputs(): void;
 export declare function disableAllInputs(): void;
 /**
  * Helper function to enable all inputs besides the ones provided.
- * This is useful because `EntityPlayer.ControlsEnabled` is not very reliable.
+ * This is useful because `EntityPlayer.ControlsEnabled` can be changed by the game under certain
+ * conditions.
  *
  * Call `enableAllInputs()` to set things back to normal.
  *
@@ -26,7 +28,8 @@ export declare function disableAllInputs(): void;
 export declare function enableAllInputsExceptFor(blacklist: Set<ButtonAction>): void;
 /**
  * Helper function to disable all inputs besides the ones provided.
- * This is useful because `EntityPlayer.ControlsEnabled` is not very reliable.
+ * This is useful because `EntityPlayer.ControlsEnabled` can be changed by the game under certain
+ * conditions.
  *
  * Call `enableAllInputs()` to set things back to normal.
  *
@@ -37,7 +40,8 @@ export declare function disableAllInputsExceptFor(whitelist: Set<ButtonAction>):
 /**
  * Helper function to disable only the inputs used for moving the character (or moving the cursor in
  * the UI).
- * This is useful because `EntityPlayer.ControlsEnabled` is not very reliable.
+ * This is useful because `EntityPlayer.ControlsEnabled` can be changed by the game under certain
+ * conditions.
  *
  * Call `enableInputs()` to set things back to normal.
  *
@@ -47,7 +51,8 @@ export declare function disableAllInputsExceptFor(whitelist: Set<ButtonAction>):
 export declare function disableMovementInputs(): void;
 /**
  * Helper function to disable only the inputs used for shooting tears.
- * This is useful because `EntityPlayer.ControlsEnabled` is not very reliable.
+ * This is useful because `EntityPlayer.ControlsEnabled` can be changed by the game under certain
+ * conditions.
  *
  * Call `enableInputs()` to set things back to normal.
  *

package/dist/features/forgottenSwitch.lua

@@ -12,7 +12,7 @@ function isActionTriggered(self, _entity, _inputHook, buttonAction)
     end
     return nil
 end
-local FEATURE_NAME = "Forgotten switcher"
+local FEATURE_NAME = "forgotten switcher"
 local initialized = false
 v = {run = {shouldSwitch = false}}
 function ____exports.forgottenSwitchInit(self, mod)

package/dist/features/getCollectibleItemPoolType.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="isaac-typescript-definitions" />
+import { ModUpgraded } from "../types/ModUpgraded";
+/** @hidden */
+export declare function getCollectibleItemPoolTypeInit(mod: ModUpgraded): void;
+/**
+ * Helper function to get the item pool type that a given collectible came from. Since there is no
+ * native method in the API to get this, IsaacScript listens in the PreGetCollectible callback for
+ * item pool types, and then assumes that the next spawned collectible will match.
+ */
+export declare function getCollectibleItemPoolType(collectible: EntityPickup): ItemPoolType;

package/dist/features/getCollectibleItemPoolType.lua

@@ -0,0 +1,64 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+require("lualib_bundle");
+local ____exports = {}
+local postPickupInitCollectible, preGetCollectible, v
+local ____errors = require("errors")
+local getUpgradeErrorMsg = ____errors.getUpgradeErrorMsg
+local ____array = require("functions.array")
+local arrayEmpty = ____array.arrayEmpty
+local ____rooms = require("functions.rooms")
+local getRoomIndex = ____rooms.getRoomIndex
+local getRoomItemPoolType = ____rooms.getRoomItemPoolType
+local getRoomVisitedCount = ____rooms.getRoomVisitedCount
+local ____exports = require("features.saveDataManager.exports")
+local saveDataManager = ____exports.saveDataManager
+function postPickupInitCollectible(self, pickup)
+    local itemPoolType = __TS__ArrayShift(v.run.collectibleQueue)
+    if itemPoolType == nil then
+        return
+    end
+    local ptrHash = GetPtrHash(pickup)
+    v.run.collectibleItemPoolTypeMap:set(ptrHash, itemPoolType)
+end
+function preGetCollectible(self, itemPoolType, _decrease, _seed)
+    local roomIndex = getRoomIndex(nil)
+    local roomVisitedCount = getRoomVisitedCount(nil)
+    if (roomIndex ~= v.run.currentRoomIndex) or (roomVisitedCount ~= v.run.currentRoomVisitedCount) then
+        v.run.currentRoomIndex = roomIndex
+        v.run.currentRoomVisitedCount = roomVisitedCount
+        arrayEmpty(nil, v.run.collectibleQueue)
+        v.run.collectibleItemPoolTypeMap:clear()
+    end
+    __TS__ArrayPush(v.run.collectibleQueue, itemPoolType)
+end
+local FEATURE_NAME = "get collectible item pool type"
+local initialized = false
+v = {
+    run = {
+        collectibleQueue = {},
+        collectibleItemPoolTypeMap = __TS__New(Map),
+        currentRoomIndex = nil,
+        currentRoomVisitedCount = nil
+    }
+}
+function ____exports.getCollectibleItemPoolTypeInit(self, mod)
+    initialized = true
+    saveDataManager(nil, "getCollectibleItemPoolType", v)
+    mod:AddCallback(ModCallbacks.MC_POST_PICKUP_INIT, postPickupInitCollectible, PickupVariant.PICKUP_COLLECTIBLE)
+    mod:AddCallback(ModCallbacks.MC_PRE_GET_COLLECTIBLE, preGetCollectible)
+end
+function ____exports.getCollectibleItemPoolType(self, collectible)
+    if not initialized then
+        local msg = getUpgradeErrorMsg(nil, FEATURE_NAME)
+        error(msg)
+    end
+    if (collectible.Type ~= EntityType.ENTITY_PICKUP) or (collectible.Variant ~= PickupVariant.PICKUP_COLLECTIBLE) then
+        error(
+            (((("The \"getCollectibleItemPoolType()\" function was given a non-collectible: " .. tostring(collectible.Type)) .. ".") .. tostring(collectible.Variant)) .. ".") .. tostring(collectible.SubType)
+        )
+    end
+    local ptrHash = GetPtrHash(collectible)
+    local itemPoolType = v.run.collectibleItemPoolTypeMap:get(ptrHash)
+    return ((itemPoolType == nil) and getRoomItemPoolType(nil)) or itemPoolType
+end
+return ____exports

package/dist/features/saveDataManager/exports.d.ts

@@ -62,7 +62,8 @@ import { SaveData } from "../../types/SaveData";
  *
  * @param key The name of the file or feature that is submitting data to be managed by the save data
  * manager. The save data manager will throw an error if the key is already registered.
- * @param saveData An object that corresponds to the `SaveData` interface.
+ * @param saveData An object that corresponds to the `SaveData` interface. The object is
+ * conventionally called "v" for brevity (which is short for "local variables").
  * @param conditionalFunc An optional function to run upon saving this key to disk. If the function
  * is false, the key will not be written to disk. This allows mod features to avoid cluttering the
  * "save#.dat" file with unnecessary keys.

package/dist/features/saveDataManager/main.d.ts

@@ -1,9 +1,5 @@
 import { ModUpgraded } from "../../types/ModUpgraded";
-/** @hidden */
 export declare const FEATURE_NAME = "save data manager";
-/** @hidden */
 export declare function saveDataManagerInit(incomingMod: ModUpgraded): void;
-/** @hidden */
 export declare function isSaveDataManagerInitialized(): boolean;
-/** @hidden */
 export declare function forceSaveDataManagerSave(): void;

package/dist/functions/collectibles.d.ts

@@ -1,9 +1,4 @@
 /// <reference types="isaac-typescript-definitions" />
-/**
- * Helper function to change the item on an item pedestal. Simply updating the SubType is not
- * sufficient because you also need to update the sprite.
- */
-export declare function changeCollectibleSubType(collectible: EntityPickup, newCollectibleType: CollectibleType | int): void;
 export declare function collectibleHasTag(collectibleType: CollectibleType | int, tag: ItemConfigTag): boolean;
 /**
  * Helper function to get the heart cost that a collectible item would be if it were being offered
@@ -47,5 +42,10 @@ export declare function removeAllCollectibles(): void;
  * Python program located at: https://github.com/Rchardon/RebirthItemTracker
  */
 export declare function removeCollectibleFromItemTracker(collectibleType: CollectibleType | int): void;
-export declare function setCollectibleBlind(pickup: EntityPickup): void;
-export declare function setCollectibleSprite(pickup: EntityPickup, pngPath: string): void;
+export declare function setCollectibleBlind(collectible: EntityPickup): void;
+export declare function setCollectibleSprite(collectible: EntityPickup, pngPath: string): void;
+/**
+ * Helper function to change the collectible on a pedestal. Simply updating the SubType property is
+ * not sufficient because the sprite will not change.
+ */
+export declare function setCollectibleSubType(collectible: EntityPickup, newCollectibleType: CollectibleType | int): void;

package/dist/functions/collectibles.lua

@@ -6,30 +6,19 @@ local ____collectibleNameMap = require("collectibleNameMap")
 local COLLECTIBLE_NAME_MAP = ____collectibleNameMap.COLLECTIBLE_NAME_MAP
 local ____entity = require("functions.entity")
 local removeAllMatchingEntities = ____entity.removeAllMatchingEntities
-function ____exports.setCollectibleSprite(self, pickup, pngPath)
-    if pickup.Variant ~= PickupVariant.PICKUP_COLLECTIBLE then
+function ____exports.setCollectibleSprite(self, collectible, pngPath)
+    if collectible.Variant ~= PickupVariant.PICKUP_COLLECTIBLE then
         error(
-            "You cannot set a collectible sprite for pickups of variant: " .. tostring(pickup.Variant)
+            "You cannot set a collectible sprite for pickups of variant: " .. tostring(collectible.Variant)
         )
     end
-    local sprite = pickup:GetSprite()
+    local sprite = collectible:GetSprite()
     sprite:ReplaceSpritesheet(COLLECTIBLE_SPRITE_LAYER, pngPath)
     sprite:LoadGraphics()
 end
 COLLECTIBLE_SPRITE_LAYER = 1
 local BLIND_ITEM_PNG_PATH = "gfx/items/collectibles/questionmark.png"
 local GLITCHED_ITEM_THRESHOLD = 4000000000
-function ____exports.changeCollectibleSubType(self, collectible, newCollectibleType)
-    collectible.SubType = newCollectibleType
-    local itemConfig = Isaac.GetItemConfig()
-    local itemConfigItem = itemConfig:GetCollectible(newCollectibleType)
-    if itemConfigItem == nil then
-        error(
-            "Failed to get the item config for: " .. tostring(newCollectibleType)
-        )
-    end
-    ____exports.setCollectibleSprite(nil, collectible, itemConfigItem.GfxFileName)
-end
 function ____exports.collectibleHasTag(self, collectibleType, tag)
     local itemConfig = Isaac.GetItemConfig()
     local itemConfigItem = itemConfig:GetCollectible(collectibleType)
@@ -132,7 +121,20 @@ function ____exports.removeCollectibleFromItemTracker(self, collectibleType)
         ((("Removing collectible " .. tostring(collectibleType)) .. " (") .. collectibleName) .. ") on player 0 (Player)"
     )
 end
-function ____exports.setCollectibleBlind(self, pickup)
-    ____exports.setCollectibleSprite(nil, pickup, BLIND_ITEM_PNG_PATH)
+function ____exports.setCollectibleBlind(self, collectible)
+    if collectible.Variant ~= PickupVariant.PICKUP_COLLECTIBLE then
+        error(
+            "You cannot set a collectible to be blind for pickups of variant: " .. tostring(collectible.Variant)
+        )
+    end
+    ____exports.setCollectibleSprite(nil, collectible, BLIND_ITEM_PNG_PATH)
+end
+function ____exports.setCollectibleSubType(self, collectible, newCollectibleType)
+    if collectible.Variant ~= PickupVariant.PICKUP_COLLECTIBLE then
+        error(
+            "You cannot set a collectible sub type for pickups of variant: " .. tostring(collectible.Variant)
+        )
+    end
+    collectible:Morph(EntityType.ENTITY_PICKUP, PickupVariant.PICKUP_COLLECTIBLE, newCollectibleType, true, true, true)
 end
 return ____exports

package/dist/functions/player.d.ts

@@ -14,12 +14,12 @@ import { PocketItemDescription } from "../types/PocketItemDescription";
 export declare type PlayerIndex = int & {
     __playerIndexBrand: unknown;
 };
-export declare function addCollectibleCostume(player: EntityPlayer, collectibleType: CollectibleType): void;
-export declare function addTrinketCostume(player: EntityPlayer, trinketType: TrinketType): void;
+export declare function addCollectibleCostume(player: EntityPlayer, collectibleType: CollectibleType | int): void;
+export declare function addTrinketCostume(player: EntityPlayer, trinketType: TrinketType | int): void;
 /** Iterates over all players and checks if any player is close enough to the specified position. */
 export declare function anyPlayerCloserThan(position: Vector, distance: float): boolean;
-export declare function anyPlayerHasCollectible(collectibleType: CollectibleType): boolean;
-export declare function anyPlayerHasTrinket(trinketType: TrinketType): boolean;
+export declare function anyPlayerHasCollectible(collectibleType: CollectibleType | int): boolean;
+export declare function anyPlayerHasTrinket(trinketType: TrinketType | int): boolean;
 export declare function anyPlayerIs(matchingCharacter: PlayerType): boolean;
 /**
  * Helper function to get how long Azazel's Brimstone laser should be. You can pass either an
@@ -134,7 +134,7 @@ export declare function getTotalCharge(player: EntityPlayer, activeSlot: ActiveS
  * Returns the total number of collectibles amongst all players. For example, if player 1 has 1 Sad
  * Onion and player 2 has 2 Sad Onions, then this function would return 3.
  */
-export declare function getTotalPlayerCollectibles(collectibleType: CollectibleType): int;
+export declare function getTotalPlayerCollectibles(collectibleType: CollectibleType | int): int;
 /** After touching a white fire, a player will turn into The Lost until they clear a room. */
 export declare function hasLostCurse(player: EntityPlayer): boolean;
 /**
@@ -188,7 +188,7 @@ export declare function isKeeper(player: EntityPlayer): boolean;
 export declare function isLost(player: EntityPlayer): boolean;
 /** Helper function for detecting when a player is Tainted Lazarus or Dead Tainted Lazarus. */
 export declare function isTaintedLazarus(player: EntityPlayer): boolean;
-export declare function removeCollectibleCostume(player: EntityPlayer, collectibleType: CollectibleType): void;
+export declare function removeCollectibleCostume(player: EntityPlayer, collectibleType: CollectibleType | int): void;
 /**
  * Helper function to remove the Dead Eye multiplier from a player.
  *
@@ -196,7 +196,7 @@ export declare function removeCollectibleCostume(player: EntityPlayer, collectib
  * chance of working, so this function calls it 100 times to be safe.
  */
 export declare function removeDeadEyeMultiplier(player: EntityPlayer): void;
-export declare function removeTrinketCostume(player: EntityPlayer, trinketType: TrinketType): void;
+export declare function removeTrinketCostume(player: EntityPlayer, trinketType: TrinketType | int): void;
 /**
  * If you want to stop the player from shooting without the blindfold costume, then simply call
  * `player.TryRemoveNullCostume(NullItemID.ID_BLINDFOLD)` after invoking this function.

package/dist/functions/trinketGive.d.ts

@@ -15,7 +15,7 @@ export interface TrinketSituation {
  *
  * @returns Null if the player does not have the trinket, or TrinketSituation if they do.
  */
-export declare function temporarilyRemoveTrinkets(player: EntityPlayer, trinketType: TrinketType): TrinketSituation | undefined;
+export declare function temporarilyRemoveTrinkets(player: EntityPlayer, trinketType: TrinketType | int): TrinketSituation | undefined;
 /**
  * Helper function to restore the player's trinkets back to the way they were before the
  * `temporarilyRemoveTrinket` function was used. It will re-smelt any smelted trinkets that were

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export * from "./collectibleNameMap";
 export * from "./constants";
 export { disableAllInputs, disableAllInputsExceptFor, disableMovementInputs, disableShootingInputs, enableAllInputs, enableAllInputsExceptFor, } from "./features/disableInputs";
 export { forgottenSwitch } from "./features/forgottenSwitch";
+export { getCollectibleItemPoolType } from "./features/getCollectibleItemPoolType";
 export { runInNFrames, runNextFrame } from "./features/runInNFrames";
 export * from "./features/saveDataManager/exports";
 export { hasSirenStolenFamiliar, setFamiliarNoSirenSteal, } from "./features/sirenHelpers";

package/dist/index.lua

@@ -51,6 +51,11 @@ do
     local forgottenSwitch = ____forgottenSwitch.forgottenSwitch
     ____exports.forgottenSwitch = forgottenSwitch
 end
+do
+    local ____getCollectibleItemPoolType = require("features.getCollectibleItemPoolType")
+    local getCollectibleItemPoolType = ____getCollectibleItemPoolType.getCollectibleItemPoolType
+    ____exports.getCollectibleItemPoolType = getCollectibleItemPoolType
+end
 do
     local ____runInNFrames = require("features.runInNFrames")
     local runInNFrames = ____runInNFrames.runInNFrames

package/dist/upgradeMod.d.ts

@@ -5,14 +5,14 @@ import { ModUpgraded } from "./types/ModUpgraded";
  *
  * Example:
  * ```
- * const mod = RegisterMod("My Mod", 1);
- * const modUpgraded = upgradeMod(mod);
+ * const modVanilla = RegisterMod("My Mod", 1);
+ * const mod = upgradeMod(modVanilla);
  *
  * // Subscribe to vanilla callbacks
  * mod.AddCallback(ModCallbacks.MC_POST_UPDATE, postUpdate);
  *
  * // Subscribe to custom callbacks
- * modUpgraded.AddCallbackCustom(ModCallbacksCustom.MC_POST_ITEM_PICKUP, postItemPickup);
+ * mod.AddCallbackCustom(ModCallbacksCustom.MC_POST_ITEM_PICKUP, postItemPickup);
  * ```
  *
  * For a list of all custom callbacks, check out the

package/dist/upgradeMod.lua

@@ -60,6 +60,8 @@ local ____disableInputs = require("features.disableInputs")
 local disableInputsInit = ____disableInputs.disableInputsInit
 local ____forgottenSwitch = require("features.forgottenSwitch")
 local forgottenSwitchInit = ____forgottenSwitch.forgottenSwitchInit
+local ____getCollectibleItemPoolType = require("features.getCollectibleItemPoolType")
+local getCollectibleItemPoolTypeInit = ____getCollectibleItemPoolType.getCollectibleItemPoolTypeInit
 local ____runInNFrames = require("features.runInNFrames")
 local runInNFramesInit = ____runInNFrames.runInNFramesInit
 local ____main = require("features.saveDataManager.main")
@@ -100,6 +102,7 @@ end
 function initFeatures(self, mod)
     disableInputsInit(nil, mod)
     forgottenSwitchInit(nil, mod)
+    getCollectibleItemPoolTypeInit(nil, mod)
     runInNFramesInit(nil, mod)
     sirenHelpersInit(nil, mod)
 end

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.0.459",
+  "version": "1.0.463",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -25,7 +25,7 @@
     "dist/**/*.d.ts"
   ],
   "devDependencies": {
-    "isaac-typescript-definitions": "^1.0.278",
+    "isaac-typescript-definitions": "^1.0.280",
     "isaacscript-lint": "^1.0.67",
     "typedoc": "^0.22.9",
     "typescript": "4.4.4",