isaacscript-common 25.4.0 → 25.5.0

package/dist/index.rollup.d.ts

@@ -8052,6 +8052,13 @@ export declare function isRedKeyRoom(roomGridIndex?: int): boolean;
  */
 export declare function isReflectionRender(): boolean;
 
+/**
+ * Helper function to check if the player is using Afterbirth+ or Repentance.
+ *
+ * This function should always be used over the `REPENTANCE` constant, since it is not safe.
+ */
+export declare function isRepentance(): boolean;
+
 /**
  * Helper function to check if the provided door leads to the "secret exit" off-grid room that takes
  * you to the Repentance floor.

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 25.4.0
+isaacscript-common 25.5.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -16252,6 +16252,8 @@ local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescri
 local RenderMode = ____isaac_2Dtypescript_2Ddefinitions.RenderMode
 local ____cachedClasses = require("src.core.cachedClasses")
 local game = ____cachedClasses.game
+local ____types = require("src.functions.types")
+local isFunction = ____types.isFunction
 function ____exports.eRange(self, start, ____end, increment)
     if increment == nil then
         increment = 1
@@ -16294,6 +16296,18 @@ function ____exports.isReflectionRender(self)
     local renderMode = room:GetRenderMode()
     return renderMode == RenderMode.WATER_REFLECT
 end
+function ____exports.isRepentance(self)
+    local metatable = getmetatable(Sprite)
+    if metatable == nil then
+        error("Failed to get the metatable of the Sprite global table.")
+    end
+    local classTable = metatable.__class
+    if classTable == nil then
+        error("Failed to get the \"__class\" key of the Sprite metatable.")
+    end
+    local getAnimation = classTable.GetAnimation
+    return isFunction(nil, getAnimation)
+end
 ____exports["repeat"] = function(self, n, func)
     do
         local i = 0

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

@@ -51,6 +51,12 @@ export declare function inRange(num: int, start: int, end: int): boolean;
  * This function is typically used to early return from a render function if it returns true.
  */
 export declare function isReflectionRender(): boolean;
+/**
+ * Helper function to check if the player is using Afterbirth+ or Repentance.
+ *
+ * This function should always be used over the `REPENTANCE` constant, since it is not safe.
+ */
+export declare function isRepentance(): boolean;
 /**
  * Helper function to repeat code N times. This is faster to type and cleaner than using a for loop.
  *

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

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/functions/utils.ts"],"names":[],"mappings":";AAGA;;;;;;;;;;;GAWG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,EAAE,SAAS,SAAI,GAAG,GAAG,EAAE,CAWlE;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CACrC,GAAG,EAAE,OAAO,EACZ,oBAAoB,EAAE,MAAM,GAC3B,MAAM,CAQR;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,EAAE,SAAS,SAAI,GAAG,GAAG,EAAE,CAOlE;AAED;;;;;;;;;GASG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO,CAE/D;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,IAAI,OAAO,CAI5C;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAI3D;AAED;;;;;;;;;;;;GAYG;AAEH,wBAAgB,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAG"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/functions/utils.ts"],"names":[],"mappings":";AAIA;;;;;;;;;;;GAWG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,EAAE,SAAS,SAAI,GAAG,GAAG,EAAE,CAWlE;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CACrC,GAAG,EAAE,OAAO,EACZ,oBAAoB,EAAE,MAAM,GAC3B,MAAM,CAQR;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,EAAE,SAAS,SAAI,GAAG,GAAG,EAAE,CAOlE;AAED;;;;;;;;;GASG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO,CAE/D;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,IAAI,OAAO,CAI5C;AAED;;;;GAIG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAetC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAI3D;AAED;;;;;;;;;;;;GAYG;AAEH,wBAAgB,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAG"}

package/dist/src/functions/utils.lua

@@ -3,6 +3,8 @@ local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitio
 local RenderMode = ____isaac_2Dtypescript_2Ddefinitions.RenderMode
 local ____cachedClasses = require("src.core.cachedClasses")
 local game = ____cachedClasses.game
+local ____types = require("src.functions.types")
+local isFunction = ____types.isFunction
 --- Helper function to return an array of integers with the specified range, inclusive on the lower
 -- end and exclusive on the high end. (The "e" stands for exclusive.)
 -- 
@@ -82,6 +84,21 @@ function ____exports.isReflectionRender(self)
     local renderMode = room:GetRenderMode()
     return renderMode == RenderMode.WATER_REFLECT
 end
+--- Helper function to check if the player is using Afterbirth+ or Repentance.
+-- 
+-- This function should always be used over the `REPENTANCE` constant, since it is not safe.
+function ____exports.isRepentance(self)
+    local metatable = getmetatable(Sprite)
+    if metatable == nil then
+        error("Failed to get the metatable of the Sprite global table.")
+    end
+    local classTable = metatable.__class
+    if classTable == nil then
+        error("Failed to get the \"__class\" key of the Sprite metatable.")
+    end
+    local getAnimation = classTable.GetAnimation
+    return isFunction(nil, getAnimation)
+end
 --- Helper function to repeat code N times. This is faster to type and cleaner than using a for loop.
 -- 
 -- For example:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "25.4.0",
+  "version": "25.5.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "dist/src/index",
   "types": "dist/index.rollup.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^11.1.5"
+    "isaac-typescript-definitions": "^11.1.6"
   }
 }

package/src/functions/utils.ts

@@ -1,5 +1,6 @@
 import { RenderMode } from "isaac-typescript-definitions";
 import { game } from "../core/cachedClasses";
+import { isFunction } from "./types";
 
 /**
  * Helper function to return an array of integers with the specified range, inclusive on the lower
@@ -93,6 +94,28 @@ export function isReflectionRender(): boolean {
   return renderMode === RenderMode.WATER_REFLECT;
 }
 
+/**
+ * Helper function to check if the player is using Afterbirth+ or Repentance.
+ *
+ * This function should always be used over the `REPENTANCE` constant, since it is not safe.
+ */
+export function isRepentance(): boolean {
+  const metatable = getmetatable(Sprite) as LuaMap<string, unknown> | undefined;
+  if (metatable === undefined) {
+    error("Failed to get the metatable of the Sprite global table.");
+  }
+
+  const classTable = metatable.get("__class") as
+    | LuaMap<string, unknown>
+    | undefined;
+  if (classTable === undefined) {
+    error('Failed to get the "__class" key of the Sprite metatable.');
+  }
+
+  const getAnimation = classTable.get("GetAnimation");
+  return isFunction(getAnimation);
+}
+
 /**
  * Helper function to repeat code N times. This is faster to type and cleaner than using a for loop.
  *