isaacscript-common 56.1.0 → 57.0.0

package/dist/index.rollup.d.ts

@@ -15207,13 +15207,40 @@ declare interface ReadonlySetConstructor {
     readonly prototype: ReadonlySet<any>;
 }
 
+/**
+ * Helper function to let the Rebirth Item Tracker know that it should remove a collectible from its
+ * list.
+ *
+ * The "item tracker" in this function does not refer to the in-game item tracker, but rather to the
+ * external Python program.
+ *
+ * This function is variadic, meaning that you can pass as many collectible types as you want to
+ * remove.
+ *
+ * Note that calling this function is not normally necessary when removing collectibles from
+ * players. For example, when you remove a collectible with the `EntityPlayer.RemoveCollectible`
+ * method, a proper message is sent to the log file by the game the item tracker will automatically
+ * remove it. However, in some cases, this function can be useful:
+ *
+ * - We may be giving the player a "fake" collectible (e.g. 1-Up for the purposes of an extra life)
+ *   and do not want the fake collectible to show up on the tracker.
+ * - We may be removing a starting active item. Since active items are never removed from the
+ *   tracker, we want to tell the item tracker that the player never had a particular active item to
+ *   begin with.
+ *
+ * @see https://github.com/Rchardon/RebirthItemTracker
+ */
+export declare function rebirthItemTrackerRemoveCollectible(...collectibleTypes: CollectibleType[]): void;
+
 /**
  * Helper function to let the Rebirth Item Tracker know that it should write the submitted text
  * string to a file. This is useful for capturing text in programs like Open Broadcaster Software
  * (OBS).
  *
  * The "item tracker" in this function does not refer to the in-game item tracker, but rather to the
- * Python program located at: https://github.com/Rchardon/RebirthItemTracker
+ * external Python program.
+ *
+ * @see https://github.com/Rchardon/RebirthItemTracker
  */
 export declare function rebirthItemTrackerWriteToFile(msg: string): void;
 
@@ -15689,23 +15716,6 @@ export declare function removeCollectibleCostume(player: EntityPlayer, collectib
  */
 export declare function removeCollectibleFromAllPlayers(...collectibleTypes: CollectibleType[]): void;
 
-/**
- * Helper function to put a message in the log.txt file to let the Rebirth Item Tracker know that it
- * should remove an item.
- *
- * The "item tracker" in this function does not refer to the in-game item tracker, but rather to the
- * Python program located at: https://github.com/Rchardon/RebirthItemTracker
- *
- * This function is useful when you need to add a "fake" collectible to a player. Note that calling
- * this function is not necessary when removing items from players. For example, when you remove a
- * collectible with the `EntityPlayer.RemoveCollectible` method, a proper message is sent to the log
- * the item tracker will automatically remove it.
- *
- * This function is variadic, meaning that you can pass as many collectible types as you want to
- * remove.
- */
-export declare function removeCollectibleFromItemTracker(...collectibleTypes: CollectibleType[]): void;
-
 /**
  * Helper function to remove one or more collectibles from all item pools.
  *

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 56.1.0
+isaacscript-common 57.0.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -35365,19 +35365,17 @@ return ____exports
  end,
 ["src.functions.external"] = function(...) 
 local ____exports = {}
-local ____collectibles = require("src.functions.collectibles")
-local getCollectibleName = ____collectibles.getCollectibleName
+local REBIRTH_ITEM_TRACKER_REMOVE_COLLECTIBLE_COMMAND = "REBIRTH_ITEM_TRACKER_REMOVE_COLLECTIBLE"
 local REBIRTH_ITEM_TRACKER_WRITE_TO_FILE_COMMAND = "REBIRTH_ITEM_TRACKER_WRITE_TO_FILE"
-function ____exports.rebirthItemTrackerWriteToFile(self, msg)
-    Isaac.DebugString((REBIRTH_ITEM_TRACKER_WRITE_TO_FILE_COMMAND .. " ") .. msg)
-end
-function ____exports.removeCollectibleFromItemTracker(self, ...)
+function ____exports.rebirthItemTrackerRemoveCollectible(self, ...)
     local collectibleTypes = {...}
     for ____, collectibleType in ipairs(collectibleTypes) do
-        local collectibleName = getCollectibleName(nil, collectibleType)
-        Isaac.DebugString(((("Removing collectible " .. tostring(collectibleType)) .. " (") .. collectibleName) .. ") on player 0 (Player)")
+        Isaac.DebugString((REBIRTH_ITEM_TRACKER_REMOVE_COLLECTIBLE_COMMAND .. " ") .. tostring(collectibleType))
     end
 end
+function ____exports.rebirthItemTrackerWriteToFile(self, msg)
+    Isaac.DebugString((REBIRTH_ITEM_TRACKER_WRITE_TO_FILE_COMMAND .. " ") .. msg)
+end
 return ____exports
  end,
 ["src.classes.features.callbackLogic.CustomRevive"] = function(...) 
@@ -35398,7 +35396,7 @@ local ISCFeature = ____ISCFeature.ISCFeature
 local ____ModCallbackCustom = require("src.enums.ModCallbackCustom")
 local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
 local ____external = require("src.functions.external")
-local removeCollectibleFromItemTracker = ____external.removeCollectibleFromItemTracker
+local rebirthItemTrackerRemoveCollectible = ____external.rebirthItemTrackerRemoveCollectible
 local ____log = require("src.functions.log")
 local log = ____log.log
 local logError = ____log.logError
@@ -35500,7 +35498,7 @@ function CustomRevive.prototype.playerIsAboutToDie(self, player)
     v.run.dyingPlayerIndex = getPlayerIndex(nil, player)
     self:logStateChanged()
     player:AddCollectible(CollectibleType.ONE_UP, 0, false)
-    removeCollectibleFromItemTracker(nil, CollectibleType.ONE_UP)
+    rebirthItemTrackerRemoveCollectible(nil, CollectibleType.ONE_UP)
     local playerIndex = getPlayerIndex(nil, player)
     self.runInNFrames:runNextGameFrame(function()
         local futurePlayer = getPlayerFromIndex(nil, playerIndex)

package/dist/src/classes/features/callbackLogic/CustomRevive.lua

@@ -15,7 +15,7 @@ local ISCFeature = ____ISCFeature.ISCFeature
 local ____ModCallbackCustom = require("src.enums.ModCallbackCustom")
 local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
 local ____external = require("src.functions.external")
-local removeCollectibleFromItemTracker = ____external.removeCollectibleFromItemTracker
+local rebirthItemTrackerRemoveCollectible = ____external.rebirthItemTrackerRemoveCollectible
 local ____log = require("src.functions.log")
 local log = ____log.log
 local logError = ____log.logError
@@ -117,7 +117,7 @@ function CustomRevive.prototype.playerIsAboutToDie(self, player)
     v.run.dyingPlayerIndex = getPlayerIndex(nil, player)
     self:logStateChanged()
     player:AddCollectible(CollectibleType.ONE_UP, 0, false)
-    removeCollectibleFromItemTracker(nil, CollectibleType.ONE_UP)
+    rebirthItemTrackerRemoveCollectible(nil, CollectibleType.ONE_UP)
     local playerIndex = getPlayerIndex(nil, player)
     self.runInNFrames:runNextGameFrame(function()
         local futurePlayer = getPlayerFromIndex(nil, playerIndex)

package/dist/src/functions/external.d.ts

@@ -5,28 +5,38 @@
  */
 import type { CollectibleType } from "isaac-typescript-definitions";
 /**
- * Helper function to let the Rebirth Item Tracker know that it should write the submitted text
- * string to a file. This is useful for capturing text in programs like Open Broadcaster Software
- * (OBS).
+ * Helper function to let the Rebirth Item Tracker know that it should remove a collectible from its
+ * list.
  *
  * The "item tracker" in this function does not refer to the in-game item tracker, but rather to the
- * Python program located at: https://github.com/Rchardon/RebirthItemTracker
+ * external Python program.
+ *
+ * This function is variadic, meaning that you can pass as many collectible types as you want to
+ * remove.
+ *
+ * Note that calling this function is not normally necessary when removing collectibles from
+ * players. For example, when you remove a collectible with the `EntityPlayer.RemoveCollectible`
+ * method, a proper message is sent to the log file by the game the item tracker will automatically
+ * remove it. However, in some cases, this function can be useful:
+ *
+ * - We may be giving the player a "fake" collectible (e.g. 1-Up for the purposes of an extra life)
+ *   and do not want the fake collectible to show up on the tracker.
+ * - We may be removing a starting active item. Since active items are never removed from the
+ *   tracker, we want to tell the item tracker that the player never had a particular active item to
+ *   begin with.
+ *
+ * @see https://github.com/Rchardon/RebirthItemTracker
  */
-export declare function rebirthItemTrackerWriteToFile(msg: string): void;
+export declare function rebirthItemTrackerRemoveCollectible(...collectibleTypes: CollectibleType[]): void;
 /**
- * Helper function to put a message in the log.txt file to let the Rebirth Item Tracker know that it
- * should remove an item.
+ * Helper function to let the Rebirth Item Tracker know that it should write the submitted text
+ * string to a file. This is useful for capturing text in programs like Open Broadcaster Software
+ * (OBS).
  *
  * The "item tracker" in this function does not refer to the in-game item tracker, but rather to the
- * Python program located at: https://github.com/Rchardon/RebirthItemTracker
+ * external Python program.
  *
- * This function is useful when you need to add a "fake" collectible to a player. Note that calling
- * this function is not necessary when removing items from players. For example, when you remove a
- * collectible with the `EntityPlayer.RemoveCollectible` method, a proper message is sent to the log
- * the item tracker will automatically remove it.
- *
- * This function is variadic, meaning that you can pass as many collectible types as you want to
- * remove.
+ * @see https://github.com/Rchardon/RebirthItemTracker
  */
-export declare function removeCollectibleFromItemTracker(...collectibleTypes: CollectibleType[]): void;
+export declare function rebirthItemTrackerWriteToFile(msg: string): void;
 //# sourceMappingURL=external.d.ts.map

package/dist/src/functions/external.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"external.d.ts","sourceRoot":"","sources":["../../../src/functions/external.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAMpE;;;;;;;GAOG;AACH,wBAAgB,6BAA6B,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAI/D;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,gCAAgC,CAC9C,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,IAAI,CAUN"}
+{"version":3,"file":"external.d.ts","sourceRoot":"","sources":["../../../src/functions/external.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAQpE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,mCAAmC,CACjD,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,IAAI,CAQN;AAED;;;;;;;;;GASG;AACH,wBAAgB,6BAA6B,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAI/D"}

package/dist/src/functions/external.lua

@@ -1,34 +1,42 @@
 local ____exports = {}
-local ____collectibles = require("src.functions.collectibles")
-local getCollectibleName = ____collectibles.getCollectibleName
+local REBIRTH_ITEM_TRACKER_REMOVE_COLLECTIBLE_COMMAND = "REBIRTH_ITEM_TRACKER_REMOVE_COLLECTIBLE"
 local REBIRTH_ITEM_TRACKER_WRITE_TO_FILE_COMMAND = "REBIRTH_ITEM_TRACKER_WRITE_TO_FILE"
---- Helper function to let the Rebirth Item Tracker know that it should write the submitted text
--- string to a file. This is useful for capturing text in programs like Open Broadcaster Software
--- (OBS).
+--- Helper function to let the Rebirth Item Tracker know that it should remove a collectible from its
+-- list.
 -- 
 -- The "item tracker" in this function does not refer to the in-game item tracker, but rather to the
--- Python program located at: https://github.com/Rchardon/RebirthItemTracker
-function ____exports.rebirthItemTrackerWriteToFile(self, msg)
-    Isaac.DebugString((REBIRTH_ITEM_TRACKER_WRITE_TO_FILE_COMMAND .. " ") .. msg)
-end
---- Helper function to put a message in the log.txt file to let the Rebirth Item Tracker know that it
--- should remove an item.
--- 
--- The "item tracker" in this function does not refer to the in-game item tracker, but rather to the
--- Python program located at: https://github.com/Rchardon/RebirthItemTracker
--- 
--- This function is useful when you need to add a "fake" collectible to a player. Note that calling
--- this function is not necessary when removing items from players. For example, when you remove a
--- collectible with the `EntityPlayer.RemoveCollectible` method, a proper message is sent to the log
--- the item tracker will automatically remove it.
+-- external Python program.
 -- 
 -- This function is variadic, meaning that you can pass as many collectible types as you want to
 -- remove.
-function ____exports.removeCollectibleFromItemTracker(self, ...)
+-- 
+-- Note that calling this function is not normally necessary when removing collectibles from
+-- players. For example, when you remove a collectible with the `EntityPlayer.RemoveCollectible`
+-- method, a proper message is sent to the log file by the game the item tracker will automatically
+-- remove it. However, in some cases, this function can be useful:
+-- 
+-- - We may be giving the player a "fake" collectible (e.g. 1-Up for the purposes of an extra life)
+--   and do not want the fake collectible to show up on the tracker.
+-- - We may be removing a starting active item. Since active items are never removed from the
+--   tracker, we want to tell the item tracker that the player never had a particular active item to
+--   begin with.
+-- 
+-- @see https ://github.com/Rchardon/RebirthItemTracker
+function ____exports.rebirthItemTrackerRemoveCollectible(self, ...)
     local collectibleTypes = {...}
     for ____, collectibleType in ipairs(collectibleTypes) do
-        local collectibleName = getCollectibleName(nil, collectibleType)
-        Isaac.DebugString(((("Removing collectible " .. tostring(collectibleType)) .. " (") .. collectibleName) .. ") on player 0 (Player)")
+        Isaac.DebugString((REBIRTH_ITEM_TRACKER_REMOVE_COLLECTIBLE_COMMAND .. " ") .. tostring(collectibleType))
     end
 end
+--- Helper function to let the Rebirth Item Tracker know that it should write the submitted text
+-- string to a file. This is useful for capturing text in programs like Open Broadcaster Software
+-- (OBS).
+-- 
+-- The "item tracker" in this function does not refer to the in-game item tracker, but rather to the
+-- external Python program.
+-- 
+-- @see https ://github.com/Rchardon/RebirthItemTracker
+function ____exports.rebirthItemTrackerWriteToFile(self, msg)
+    Isaac.DebugString((REBIRTH_ITEM_TRACKER_WRITE_TO_FILE_COMMAND .. " ") .. msg)
+end
 return ____exports

package/package.json

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

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

@@ -8,7 +8,7 @@ import {
 import { sfxManager } from "../../../core/cachedClasses";
 import { ISCFeature } from "../../../enums/ISCFeature";
 import { ModCallbackCustom } from "../../../enums/ModCallbackCustom";
-import { removeCollectibleFromItemTracker } from "../../../functions/external";
+import { rebirthItemTrackerRemoveCollectible } from "../../../functions/external";
 import { log, logError } from "../../../functions/log";
 import {
   getPlayerFromIndex,
@@ -194,7 +194,7 @@ export class CustomRevive extends Feature {
     this.logStateChanged();
 
     player.AddCollectible(CollectibleType.ONE_UP, 0, false);
-    removeCollectibleFromItemTracker(CollectibleType.ONE_UP);
+    rebirthItemTrackerRemoveCollectible(CollectibleType.ONE_UP);
 
     // The player should always be dead one frame from now. If they are not, then something has gone
     // wrong, probably with the `isDamageToPlayerFatal` function. Since end-user code is already

package/src/functions/external.ts

@@ -5,50 +5,60 @@
  */
 
 import type { CollectibleType } from "isaac-typescript-definitions";
-import { getCollectibleName } from "./collectibles";
+
+const REBIRTH_ITEM_TRACKER_REMOVE_COLLECTIBLE_COMMAND =
+  "REBIRTH_ITEM_TRACKER_REMOVE_COLLECTIBLE";
 
 const REBIRTH_ITEM_TRACKER_WRITE_TO_FILE_COMMAND =
   "REBIRTH_ITEM_TRACKER_WRITE_TO_FILE";
 
 /**
- * Helper function to let the Rebirth Item Tracker know that it should write the submitted text
- * string to a file. This is useful for capturing text in programs like Open Broadcaster Software
- * (OBS).
+ * Helper function to let the Rebirth Item Tracker know that it should remove a collectible from its
+ * list.
  *
  * The "item tracker" in this function does not refer to the in-game item tracker, but rather to the
- * Python program located at: https://github.com/Rchardon/RebirthItemTracker
- */
-export function rebirthItemTrackerWriteToFile(msg: string): void {
-  // This cannot use the "log" function since the prefix will prevent the Rebirth Item Tracker from
-  // recognizing the message.
-  Isaac.DebugString(`${REBIRTH_ITEM_TRACKER_WRITE_TO_FILE_COMMAND} ${msg}`);
-}
-
-/**
- * Helper function to put a message in the log.txt file to let the Rebirth Item Tracker know that it
- * should remove an item.
- *
- * The "item tracker" in this function does not refer to the in-game item tracker, but rather to the
- * Python program located at: https://github.com/Rchardon/RebirthItemTracker
- *
- * This function is useful when you need to add a "fake" collectible to a player. Note that calling
- * this function is not necessary when removing items from players. For example, when you remove a
- * collectible with the `EntityPlayer.RemoveCollectible` method, a proper message is sent to the log
- * the item tracker will automatically remove it.
+ * external Python program.
  *
  * This function is variadic, meaning that you can pass as many collectible types as you want to
  * remove.
+ *
+ * Note that calling this function is not normally necessary when removing collectibles from
+ * players. For example, when you remove a collectible with the `EntityPlayer.RemoveCollectible`
+ * method, a proper message is sent to the log file by the game the item tracker will automatically
+ * remove it. However, in some cases, this function can be useful:
+ *
+ * - We may be giving the player a "fake" collectible (e.g. 1-Up for the purposes of an extra life)
+ *   and do not want the fake collectible to show up on the tracker.
+ * - We may be removing a starting active item. Since active items are never removed from the
+ *   tracker, we want to tell the item tracker that the player never had a particular active item to
+ *   begin with.
+ *
+ * @see https://github.com/Rchardon/RebirthItemTracker
  */
-export function removeCollectibleFromItemTracker(
+export function rebirthItemTrackerRemoveCollectible(
   ...collectibleTypes: CollectibleType[]
 ): void {
   for (const collectibleType of collectibleTypes) {
-    const collectibleName = getCollectibleName(collectibleType);
-
     // This cannot use the "log" function since the prefix will prevent the Rebirth Item Tracker
     // from recognizing the message.
     Isaac.DebugString(
-      `Removing collectible ${collectibleType} (${collectibleName}) on player 0 (Player)`,
+      `${REBIRTH_ITEM_TRACKER_REMOVE_COLLECTIBLE_COMMAND} ${collectibleType}`,
     );
   }
 }
+
+/**
+ * Helper function to let the Rebirth Item Tracker know that it should write the submitted text
+ * string to a file. This is useful for capturing text in programs like Open Broadcaster Software
+ * (OBS).
+ *
+ * The "item tracker" in this function does not refer to the in-game item tracker, but rather to the
+ * external Python program.
+ *
+ * @see https://github.com/Rchardon/RebirthItemTracker
+ */
+export function rebirthItemTrackerWriteToFile(msg: string): void {
+  // This cannot use the "log" function since the prefix will prevent the Rebirth Item Tracker from
+  // recognizing the message.
+  Isaac.DebugString(`${REBIRTH_ITEM_TRACKER_WRITE_TO_FILE_COMMAND} ${msg}`);
+}