isaacscript-common 3.13.0 → 3.14.0

package/constants.d.ts

@@ -1,7 +1,7 @@
 /**
  * @module Constants
  */
-import { ItemPoolType, LevelStage, RoomType } from "isaac-typescript-definitions";
+import { CollectibleType, ItemPoolType, LevelStage, RoomType } from "isaac-typescript-definitions";
 /**
  * The distance of the laser when Azazel does not have any range up items yet. For more info, see
  * the documentation for the `getAzazelBrimstoneDistance` function.
@@ -34,7 +34,7 @@ export declare const EMPTY_PNG_PATH = "gfx/none.png";
  * encountered by the player. The first TMTRAINER item takes the final possible 32 bit number. The
  * second TMTRAINER item subtracts one from that, and so on.
  */
-export declare const FIRST_GLITCHED_COLLECTIBLE_TYPE: number;
+export declare const FIRST_GLITCHED_COLLECTIBLE_TYPE: CollectibleType;
 export declare const GAME_FRAMES_PER_SECOND = 30;
 export declare const GRID_INDEX_CENTER_OF_1X1_ROOM = 67;
 export declare const ISAAC_FRAMES_PER_SECOND = 60;

package/functions/collectibles.d.ts

@@ -191,6 +191,11 @@ export declare function setCollectibleBlind(collectible: EntityPickup): void;
  * For more information, see the documentation for the "clearSprite" helper function.
  */
 export declare function setCollectibleEmpty(collectible: EntityPickup): void;
+/**
+ * Helper function to change a collectible into a "glitched" item (like the ones that appear when
+ * the player has TMTRAINER).
+ */
+export declare function setCollectibleGlitched(collectible: EntityPickup): void;
 /**
  * Helper function to change the sprite of a collectible pedestal entity.
  *

package/functions/collectibles.lua

@@ -13,6 +13,7 @@ local game = ____cachedClasses.game
 local itemConfig = ____cachedClasses.itemConfig
 local ____constants = require("constants")
 local BLIND_ITEM_PNG_PATH = ____constants.BLIND_ITEM_PNG_PATH
+local DEFAULT_ITEM_POOL_TYPE = ____constants.DEFAULT_ITEM_POOL_TYPE
 local ____constantsFirstLast = require("constantsFirstLast")
 local FIRST_COLLECTIBLE_TYPE = ____constantsFirstLast.FIRST_COLLECTIBLE_TYPE
 local FIRST_MODDED_COLLECTIBLE_TYPE = ____constantsFirstLast.FIRST_MODDED_COLLECTIBLE_TYPE
@@ -44,6 +45,22 @@ function initQuestionMarkSprite(self)
     sprite:LoadGraphics()
     return sprite
 end
+function ____exports.clearCollectibleSprite(self, collectible)
+    ____exports.setCollectibleSprite(nil, collectible, nil)
+end
+--- Helper function to remove the collectible from a collectible pedestal and make it appear as if a
+-- player has already taken the item. This is accomplished by changing the sub-type to
+-- `CollectibleType.NULL` and then setting the sprite to an empty/missing PNG file.
+-- 
+-- For more information, see the documentation for the "clearSprite" helper function.
+function ____exports.setCollectibleEmpty(self, collectible)
+    if not isCollectible(nil, collectible) then
+        local entityID = getEntityID(nil, collectible)
+        error("The \"setCollectibleEmpty\" function was given a non-collectible: " .. entityID)
+    end
+    collectible.SubType = CollectibleType.NULL
+    ____exports.clearCollectibleSprite(nil, collectible)
+end
 --- Helper function to change the sprite of a collectible pedestal entity.
 -- 
 -- For more information about removing the collectible sprite, see the documentation for the
@@ -67,13 +84,30 @@ function ____exports.setCollectibleSprite(self, collectible, pngPath)
         sprite:LoadGraphics()
     end
 end
+--- Helper function to change the collectible on a pedestal. Simply updating the `SubType` property
+-- is not sufficient because the sprite will not change.
+function ____exports.setCollectibleSubType(self, collectible, newCollectibleType)
+    if not isCollectible(nil, collectible) then
+        local entityID = getEntityID(nil, collectible)
+        error("The \"setCollectibleSubType\" function was given a non-collectible: " .. entityID)
+    end
+    if newCollectibleType == CollectibleType.NULL then
+        ____exports.setCollectibleEmpty(nil, collectible)
+        return
+    end
+    collectible:Morph(
+        EntityType.PICKUP,
+        PickupVariant.COLLECTIBLE,
+        newCollectibleType,
+        true,
+        true,
+        true
+    )
+end
 COLLECTIBLE_SPRITE_LAYER = 1
 COLLECTIBLE_SHADOW_LAYER = 4
 local GLITCHED_ITEM_THRESHOLD = 4000000000
 local questionMarkSprite = initQuestionMarkSprite(nil)
-function ____exports.clearCollectibleSprite(self, collectible)
-    ____exports.setCollectibleSprite(nil, collectible, nil)
-end
 --- Helper function to check if two collectible sprites have the same sprite sheet loaded.
 function ____exports.collectibleSpriteEquals(self, sprite1, sprite2)
     local xStart = -1
@@ -384,38 +418,24 @@ function ____exports.setCollectibleBlind(self, collectible)
     end
     ____exports.setCollectibleSprite(nil, collectible, BLIND_ITEM_PNG_PATH)
 end
---- Helper function to remove the collectible from a collectible pedestal and make it appear as if a
--- player has already taken the item. This is accomplished by changing the sub-type to
--- `CollectibleType.NULL` and then setting the sprite to an empty/missing PNG file.
--- 
--- For more information, see the documentation for the "clearSprite" helper function.
-function ____exports.setCollectibleEmpty(self, collectible)
+--- Helper function to change a collectible into a "glitched" item (like the ones that appear when
+-- the player has TMTRAINER).
+function ____exports.setCollectibleGlitched(self, collectible)
     if not isCollectible(nil, collectible) then
         local entityID = getEntityID(nil, collectible)
-        error("The \"setCollectibleEmpty\" function was given a non-collectible: " .. entityID)
+        error("The \"setCollectibleGlitched\" function was given a non-collectible: " .. entityID)
     end
-    collectible.SubType = CollectibleType.NULL
-    ____exports.clearCollectibleSprite(nil, collectible)
-end
---- Helper function to change the collectible on a pedestal. Simply updating the `SubType` property
--- is not sufficient because the sprite will not change.
-function ____exports.setCollectibleSubType(self, collectible, newCollectibleType)
-    if not isCollectible(nil, collectible) then
-        local entityID = getEntityID(nil, collectible)
-        error("The \"setCollectibleSubType\" function was given a non-collectible: " .. entityID)
+    local player = Isaac.GetPlayer()
+    local hasTMTRAINER = player:HasCollectible(CollectibleType.TMTRAINER)
+    if not hasTMTRAINER then
+        player:AddCollectible(CollectibleType.TMTRAINER, 0, false)
     end
-    if newCollectibleType == CollectibleType.NULL then
-        ____exports.setCollectibleEmpty(nil, collectible)
-        return
+    local itemPool = game:GetItemPool()
+    local collectibleType = itemPool:GetCollectible(DEFAULT_ITEM_POOL_TYPE)
+    ____exports.setCollectibleSubType(nil, collectible, collectibleType)
+    if not hasTMTRAINER then
+        player:RemoveCollectible(CollectibleType.TMTRAINER)
     end
-    collectible:Morph(
-        EntityType.PICKUP,
-        PickupVariant.COLLECTIBLE,
-        newCollectibleType,
-        true,
-        true,
-        true
-    )
 end
 --- Helper function to put a message in the log.txt file to let the Rebirth Item Tracker know that
 -- the build has been rerolled.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "3.13.0",
+  "version": "3.14.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",