isaacscript-common 9.0.0 → 9.1.1

package/src/functions/debug.ts

@@ -1,4 +1,36 @@
+import { ModUpgraded } from "../classes/ModUpgraded";
+import { enableExtraConsoleCommands } from "../features/extraConsoleCommands/exports";
+import { removeFadeIn } from "../features/fadeInRemover";
+import { enableFastReset } from "../features/fastReset";
+import { saveDataManagerSetGlobal } from "../features/saveDataManager/exports";
+import * as logExports from "./log";
 import { log } from "./log";
+import * as logEntitiesExports from "./logEntities";
+
+/**
+ * Helper function to enable some IsaacScript features that are useful when developing a mod. They
+ * should not be enabled when your mod goes to production (i.e. when it is uploaded to the Steam
+ * Workshop).
+ *
+ * The list of development features that are enabled are as follows:
+ *
+ * - `saveDataManagerSetGlobal` - Sets your local variables registered with the save data manager as
+ *   global variables so you can access them from the in-game console.
+ * - `setLogFunctionsGlobal` - Sets the various log functions global so that you can access them
+ *   from the in-game console.
+ * - `enableExtraConsoleCommands` - Enables many extra in-game console commands that make warping
+ *   around easier (like e.g. `angel` to warp to the Angel Room).
+ * - `enableFastReset` - Makes it so that the r key resets the game instantaneously.
+ * - `removeFadeIn` - Removes the slow fade in that occurs at the beginning of the run, so that you
+ *   can immediately start playing or testing.
+ */
+export function enableDevFeatures(mod: ModUpgraded): void {
+  saveDataManagerSetGlobal();
+  setLogFunctionsGlobal();
+  enableExtraConsoleCommands(mod);
+  enableFastReset();
+  removeFadeIn();
+}
 
 /**
  * Helper function to get a stack trace.
@@ -37,6 +69,23 @@ export function isLuaDebugEnabled(): boolean {
   return _G.package !== undefined;
 }
 
+/**
+ * Converts every `isaacscript-common` function that begins with "log" to a global function.
+ *
+ * This is useful when printing out variables from the in-game debug console.
+ */
+export function setLogFunctionsGlobal(): void {
+  const globals = _G as Record<string, unknown>;
+
+  for (const [logFuncName, logFunc] of Object.entries(logExports)) {
+    globals[logFuncName] = logFunc;
+  }
+
+  for (const [logFuncName, logFunc] of Object.entries(logEntitiesExports)) {
+    globals[logFuncName] = logFunc;
+  }
+}
+
 /**
  * Helper function to print a stack trace to the "log.txt" file, similar to JavaScript's
  * `console.trace` function.

package/src/functions/familiars.ts

@@ -82,6 +82,7 @@ export function checkFamiliarFromCollectibles(
   familiarVariant: FamiliarVariant,
   familiarSubType?: int,
 ): void {
+  // We need to include non-real collectibles, like Lilith's Incubus.
   const numCollectibles = player.GetCollectibleNum(collectibleType);
   const effects = player.GetEffects();
 

package/src/functions/itemPool.ts

@@ -128,13 +128,12 @@ function removeItemsAndTrinketsThatAffectItemPools(): [
   for (const player of getPlayers()) {
     const removedItems: CollectibleType[] = [];
     for (const itemToRemove of COLLECTIBLES_THAT_AFFECT_ITEM_POOLS) {
-      if (player.HasCollectible(itemToRemove)) {
-        const numCollectibles = player.GetCollectibleNum(itemToRemove);
-        repeat(numCollectibles, () => {
-          player.RemoveCollectible(itemToRemove);
-          removedItems.push(itemToRemove);
-        });
-      }
+      // We need to include non-real collectibles, like Lilith's Incubus.
+      const numCollectibles = player.GetCollectibleNum(itemToRemove);
+      repeat(numCollectibles, () => {
+        player.RemoveCollectible(itemToRemove);
+        removedItems.push(itemToRemove);
+      });
     }
 
     mapSetPlayer(removedItemsMap, player, removedItems);

package/src/functions/log.ts

@@ -1,4 +1,5 @@
 import {
+  CollectibleType,
   DamageFlag,
   EntityFlag,
   GameStateFlag,
@@ -73,6 +74,20 @@ export function logArray<T>(this: void, array: T[] | readonly T[]): void {
   log(`Array: ${arrayString}`);
 }
 
+export function logCollectibleTypes(
+  this: void,
+  collectibleTypes: CollectibleType[],
+): void {
+  log("Collectibles:");
+
+  let i = 1;
+  for (const collectibleType of collectibleTypes) {
+    const collectibleName = getCollectibleName(collectibleType);
+    log(`${i}) ${collectibleName} (${collectibleType})`);
+    i++;
+  }
+}
+
 export function logColor(this: void, color: Color): void {
   log(
     `Color: R${color.R}, G${color.G}, B${color.B}, A${color.A}, RO${color.RO}, BO${color.BO}, GO${color.GO}`,
@@ -482,38 +497,3 @@ export function logVector(this: void, vector: Vector, round = false): void {
   const vectorString = vectorToString(vector, round);
   log(`Vector: ${vectorString}`);
 }
-
-/**
- * Converts every `isaacscript-common` function that begins with "log" to a global function.
- *
- * This is useful when printing out variables from the in-game debug console.
- */
-export function setLogFunctionsGlobal(): void {
-  const globals = _G as Record<string, unknown>;
-
-  globals["log"] = log;
-  globals["logArray"] = logArray;
-  globals["logColor"] = logColor;
-  globals["logDamageFlags"] = logDamageFlags;
-  globals["logEntityID"] = logEntityID;
-  globals["logEntityFlags"] = logEntityFlags;
-  globals["logError"] = logError;
-  globals["logFlags"] = logFlags;
-  globals["logGameStateFlags"] = logGameStateFlags;
-  globals["logKColor"] = logKColor;
-  globals["logLevelStateFlags"] = logLevelStateFlags;
-  globals["logMap"] = logMap;
-  globals["logPlayerEffects"] = logPlayerEffects;
-  globals["logPlayerHealth"] = logPlayerHealth;
-  globals["logProjectileFlags"] = logProjectileFlags;
-  globals["logRoom"] = logRoom;
-  globals["logSeedEffects"] = logSeedEffects;
-  globals["logSet"] = logSet;
-  globals["logSounds"] = logSounds;
-  globals["logTable"] = logTable;
-  globals["logTableDifferences"] = logTableDifferences;
-  globals["logTearFlags"] = logTearFlags;
-  globals["logUseFlags"] = logUseFlags;
-  globals["logUserdata"] = logUserdata;
-  globals["logVector"] = logVector;
-}

package/src/functions/players.ts

@@ -223,6 +223,8 @@ export function getPlayerCloserThan(
  * collectible type(s) provided.
  *
  * This function is variadic, meaning that you can specify N collectible types.
+ *
+ * Note that this will filter out non-real collectibles like Lilith's Incubus.
  */
 export function getPlayerCollectibleCount(
   player: EntityPlayer,
@@ -230,6 +232,8 @@ export function getPlayerCollectibleCount(
 ): int {
   let numCollectibles = 0;
   for (const collectibleType of collectibleTypes) {
+    // We need to specify "true" as the second argument here to filter out things like Lilith's
+    // Incubus.
     numCollectibles += player.GetCollectibleNum(collectibleType, true);
   }
 
@@ -239,6 +243,8 @@ export function getPlayerCollectibleCount(
 /**
  * Iterates over every item in the game and returns a map containing the number of each item that
  * the player has.
+ *
+ * Note that this will filter out non-real collectibles like Lilith's Incubus.
  */
 export function getPlayerCollectibleMap(
   player: EntityPlayer,
@@ -247,6 +253,8 @@ export function getPlayerCollectibleMap(
 
   const collectibleMap = new Map<CollectibleType, int>();
   for (const collectibleType of collectibleArray) {
+    // We need to specify "true" as the second argument here to filter out things like Lilith's
+    // Incubus.
     const collectibleNum = player.GetCollectibleNum(collectibleType, true);
     if (collectibleNum > 0) {
       collectibleMap.set(collectibleType, collectibleNum);
@@ -374,14 +382,19 @@ export function getPlayersWithTrinket(
 /**
  * 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.
+ *
+ * Note that this will filter out non-real collectibles like Lilith's Incubus.
  */
 export function getTotalPlayerCollectibles(
   collectibleType: CollectibleType,
 ): int {
   const players = getPlayers();
   const numCollectiblesArray = players.map((player) =>
-    player.GetCollectibleNum(collectibleType),
+    // We need to specify "true" as the second argument here to filter out things like Lilith's
+    // Incubus.
+    player.GetCollectibleNum(collectibleType, true),
   );
+
   return sumArray(numCollectiblesArray);
 }
 

package/src/index.ts

@@ -67,7 +67,6 @@ export * from "./functions/curses";
 export * from "./functions/debug";
 export * from "./functions/deepCopy";
 export * from "./functions/deepCopyTests";
-export * from "./functions/dev";
 export * from "./functions/dimensions";
 export * from "./functions/direction";
 export * from "./functions/doors";

package/dist/functions/dev.d.ts

@@ -1,20 +0,0 @@
-import { ModUpgraded } from "../classes/ModUpgraded";
-/**
- * Helper function to enable some IsaacScript features that are useful when developing a mod. They
- * should not be enabled when your mod goes to production (i.e. when it is uploaded to the Steam
- * Workshop).
- *
- * The list of development features that are enabled are as follows:
- *
- * - `saveDataManagerSetGlobal` - Sets your local variables registered with the save data manager as
- *   global variables so you can access them from the in-game console.
- * - `setLogFunctionsGlobal` - Sets the various log functions global so that you can access them
- *   from the in-game console.
- * - `enableExtraConsoleCommands` - Enables many extra in-game console commands that make warping
- *   around easier (like e.g. `angel` to warp to the Angel Room).
- * - `enableFastReset` - Makes it so that the r key resets the game instantaneously.
- * - `removeFadeIn` - Removes the slow fade in that occurs at the beginning of the run, so that you
- *   can immediately start playing or testing.
- */
-export declare function enableDevFeatures(mod: ModUpgraded): void;
-//# sourceMappingURL=dev.d.ts.map

package/dist/functions/dev.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"dev.d.ts","sourceRoot":"","sources":["../../src/functions/dev.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAOrD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI,CAMxD"}

package/dist/functions/dev.lua

@@ -1,34 +0,0 @@
-local ____exports = {}
-local ____exports = require("features.extraConsoleCommands.exports")
-local enableExtraConsoleCommands = ____exports.enableExtraConsoleCommands
-local ____fadeInRemover = require("features.fadeInRemover")
-local removeFadeIn = ____fadeInRemover.removeFadeIn
-local ____fastReset = require("features.fastReset")
-local enableFastReset = ____fastReset.enableFastReset
-local ____exports = require("features.saveDataManager.exports")
-local saveDataManagerSetGlobal = ____exports.saveDataManagerSetGlobal
-local ____log = require("functions.log")
-local setLogFunctionsGlobal = ____log.setLogFunctionsGlobal
---- Helper function to enable some IsaacScript features that are useful when developing a mod. They
--- should not be enabled when your mod goes to production (i.e. when it is uploaded to the Steam
--- Workshop).
--- 
--- The list of development features that are enabled are as follows:
--- 
--- - `saveDataManagerSetGlobal` - Sets your local variables registered with the save data manager as
---   global variables so you can access them from the in-game console.
--- - `setLogFunctionsGlobal` - Sets the various log functions global so that you can access them
---   from the in-game console.
--- - `enableExtraConsoleCommands` - Enables many extra in-game console commands that make warping
---   around easier (like e.g. `angel` to warp to the Angel Room).
--- - `enableFastReset` - Makes it so that the r key resets the game instantaneously.
--- - `removeFadeIn` - Removes the slow fade in that occurs at the beginning of the run, so that you
---   can immediately start playing or testing.
-function ____exports.enableDevFeatures(self, mod)
-    saveDataManagerSetGlobal(nil)
-    setLogFunctionsGlobal(nil)
-    enableExtraConsoleCommands(nil, mod)
-    enableFastReset(nil)
-    removeFadeIn(nil)
-end
-return ____exports

package/src/functions/dev.ts

@@ -1,31 +0,0 @@
-import { ModUpgraded } from "../classes/ModUpgraded";
-import { enableExtraConsoleCommands } from "../features/extraConsoleCommands/exports";
-import { removeFadeIn } from "../features/fadeInRemover";
-import { enableFastReset } from "../features/fastReset";
-import { saveDataManagerSetGlobal } from "../features/saveDataManager/exports";
-import { setLogFunctionsGlobal } from "./log";
-
-/**
- * Helper function to enable some IsaacScript features that are useful when developing a mod. They
- * should not be enabled when your mod goes to production (i.e. when it is uploaded to the Steam
- * Workshop).
- *
- * The list of development features that are enabled are as follows:
- *
- * - `saveDataManagerSetGlobal` - Sets your local variables registered with the save data manager as
- *   global variables so you can access them from the in-game console.
- * - `setLogFunctionsGlobal` - Sets the various log functions global so that you can access them
- *   from the in-game console.
- * - `enableExtraConsoleCommands` - Enables many extra in-game console commands that make warping
- *   around easier (like e.g. `angel` to warp to the Angel Room).
- * - `enableFastReset` - Makes it so that the r key resets the game instantaneously.
- * - `removeFadeIn` - Removes the slow fade in that occurs at the beginning of the run, so that you
- *   can immediately start playing or testing.
- */
-export function enableDevFeatures(mod: ModUpgraded): void {
-  saveDataManagerSetGlobal();
-  setLogFunctionsGlobal();
-  enableExtraConsoleCommands(mod);
-  enableFastReset();
-  removeFadeIn();
-}