isaacscript-common 8.7.0 → 8.8.0

package/dist/functions/curses.d.ts

@@ -1,3 +1,12 @@
 import { LevelCurse } from "isaac-typescript-definitions";
+/**
+ * Helper function to get the actual bit flag for modded curses.
+ *
+ * Will throw a runtime error if the provided curse does not exist.
+ *
+ * Use this over the `Isaac.GetCurseIdByName` method because that will return an integer instead of
+ * a bit flag.
+ */
+export declare function getCurseIDByName(name: string): LevelCurse;
 export declare function hasCurse(curse: LevelCurse): boolean;
 //# sourceMappingURL=curses.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"curses.d.ts","sourceRoot":"","sources":["../../src/functions/curses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAI1D,wBAAgB,QAAQ,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAInD"}
+{"version":3,"file":"curses.d.ts","sourceRoot":"","sources":["../../src/functions/curses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAI1D;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAWzD;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAInD"}

package/dist/functions/curses.lua

@@ -3,6 +3,19 @@ local ____cachedClasses = require("core.cachedClasses")
 local game = ____cachedClasses.game
 local ____flag = require("functions.flag")
 local hasFlag = ____flag.hasFlag
+--- Helper function to get the actual bit flag for modded curses.
+-- 
+-- Will throw a runtime error if the provided curse does not exist.
+-- 
+-- Use this over the `Isaac.GetCurseIdByName` method because that will return an integer instead of
+-- a bit flag.
+function ____exports.getCurseIDByName(self, name)
+    local curseID = Isaac.GetCurseIdByName(name)
+    if curseID == -1 then
+        error(("Failed to get the curse ID corresponding to the curse name of \"" .. tostring(curseID)) .. "\". Does this name match what you put in the \"content/curses.xml\" file?")
+    end
+    return 1 << curseID - 1
+end
 function ____exports.hasCurse(self, curse)
     local level = game:GetLevel()
     local curses = level:GetCurses()

package/dist/index.d.ts

@@ -2805,6 +2805,16 @@ export declare function getCombinedBossSet(stage: int): ReadonlySet<string> | un
  */
 export declare function getCrawlSpaces(crawlSpaceVariant?: CrawlSpaceVariant): GridEntity[];
 
+/**
+ * Helper function to get the actual bit flag for modded curses.
+ *
+ * Will throw a runtime error if the provided curse does not exist.
+ *
+ * Use this over the `Isaac.GetCurseIdByName` method because that will return an integer instead of
+ * a bit flag.
+ */
+export declare function getCurseIDByName(name: string): LevelCurse;
+
 /**
  * Helper function to get the custom grid entities in the current room. Returns an array of tuples
  * containing the raw decoration grid entity and the associated entity data.

package/package.json

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

package/src/functions/curses.ts

@@ -2,6 +2,27 @@ import { LevelCurse } from "isaac-typescript-definitions";
 import { game } from "../core/cachedClasses";
 import { hasFlag } from "./flag";
 
+/**
+ * Helper function to get the actual bit flag for modded curses.
+ *
+ * Will throw a runtime error if the provided curse does not exist.
+ *
+ * Use this over the `Isaac.GetCurseIdByName` method because that will return an integer instead of
+ * a bit flag.
+ */
+export function getCurseIDByName(name: string): LevelCurse {
+  const curseID = Isaac.GetCurseIdByName(name);
+  if (curseID === -1) {
+    error(
+      `Failed to get the curse ID corresponding to the curse name of "${curseID}". Does this name match what you put in the "content/curses.xml" file?`,
+    );
+  }
+
+  // For example, the final vanilla curse is "Curse of the Giant", which has an ID of 8. This
+  // corresponds to `LevelCurse.GIANT`, which has a value of `1 << 7`.
+  return (1 << (curseID - 1)) as LevelCurse;
+}
+
 export function hasCurse(curse: LevelCurse): boolean {
   const level = game.GetLevel();
   const curses = level.GetCurses();