isaacscript-common 47.5.4 → 48.1.0

package/dist/index.rollup.d.ts

@@ -5427,13 +5427,14 @@ export declare function getEntityPositions(entities?: Entity[]): Map<PtrHash, Ve
 export declare function getEntityVelocities(entities?: Entity[]): Map<PtrHash, Vector>;
 
 /**
- * TypeScriptToLua will transpile TypeScript enums to Lua tables that have a double mapping. Thus,
- * when you iterate over them, you will get both the names of the enums and the values of the enums,
- * in a random order. Use this helper function to get the entries of the enum with the reverse
- * mappings filtered out.
+ * TypeScriptToLua will transpile TypeScript number enums to Lua tables that have a double mapping.
+ * Thus, when you iterate over them, you will get both the names of the enums and the values of the
+ * enums, in a random order. Use this helper function to get the entries of the enum with the
+ * reverse mappings filtered out.
  *
  * This function will return the enum values in a sorted order, which may not necessarily be the
- * same order as which they were declared in.
+ * same order as which they were declared in. (It is impossible to get the declaration order at
+ * run-time.)
  *
  * This function will work properly for both number enums and string enums. (Reverse mappings are
  * not created for string enums.)
@@ -5446,12 +5447,13 @@ export declare function getEntityVelocities(entities?: Entity[]): Map<PtrHash, V
 export declare function getEnumEntries<T>(transpiledEnum: T): Array<[key: string, value: T[keyof T]]>;
 
 /**
- * TypeScriptToLua will transpile TypeScript enums to Lua tables that have a double mapping. Thus,
- * when you iterate over them, you will get both the names of the enums and the values of the enums,
- * in a random order. If all you need are the keys of an enum, use this helper function.
+ * TypeScriptToLua will transpile TypeScript number enums to Lua tables that have a double mapping.
+ * Thus, when you iterate over them, you will get both the names of the enums and the values of the
+ * enums, in a random order. If all you need are the keys of an enum, use this helper function.
  *
  * This function will return the enum keys in a sorted order, which may not necessarily be the same
- * order as which they were declared in.
+ * order as which they were declared in. (It is impossible to get the declaration order at
+ * run-time.)
  *
  * This function will work properly for both number enums and string enums. (Reverse mappings are
  * not created for string enums.)
@@ -5467,12 +5469,32 @@ export declare function getEnumKeys(transpiledEnum: Record<string | number, stri
 export declare function getEnumLength(transpiledEnum: Record<string | number, string | number>): int;
 
 /**
- * TypeScriptToLua will transpile TypeScript enums to Lua tables that have a double mapping. Thus,
- * when you iterate over them, you will get both the names of the enums and the values of the enums,
- * in a random order. If all you need are the values of an enum, use this helper function.
+ * TypeScriptToLua will transpile TypeScript number enums to Lua tables that have a double mapping.
+ * Thus, when you iterate over them, you will get both the names of the enums and the values of the
+ * enums, in a random order. If all you need are the names of an enum from the reverse mapping, use
+ * this helper function.
+ *
+ * This function will return the enum names in a sorted order, which may not necessarily be the same
+ * order as which they were declared in. (It is impossible to get the declaration order at
+ * run-time.)
+ *
+ * This function will work properly for both number enums and string enums. (Reverse mappings are
+ * not created for string enums, so their names would be equivalent to what would be returned by the
+ * `getEnumKeys` function.)
+ *
+ * For a more in depth explanation, see:
+ * https://isaacscript.github.io/main/gotchas#iterating-over-enums
+ */
+export declare function getEnumNames(transpiledEnum: Record<string | number, string | number>): string[];
+
+/**
+ * TypeScriptToLua will transpile TypeScript number enums to Lua tables that have a double mapping.
+ * Thus, when you iterate over them, you will get both the names of the enums and the values of the
+ * enums, in a random order. If all you need are the values of an enum, use this helper function.
  *
  * This function will return the enum values in a sorted order, which may not necessarily be the
- * same order as which they were declared in.
+ * same order as which they were declared in. (It is impossible to get the declaration order at
+ * run-time.)
  *
  * This function will work properly for both number enums and string enums. (Reverse mappings are
  * not created for string enums.)
@@ -17804,7 +17826,7 @@ export declare function useCardTemp(player: EntityPlayer, cardType: CardType): v
 export declare function validateCustomEnum(transpiledEnumName: string, transpiledEnum: unknown): void;
 
 /**
- * Helper function to validate if every value in an enum is contiguous, starting at 0.
+ * Helper function to validate if every value in a number enum is contiguous, starting at 0.
  *
  * This is useful to automate checking large enums for typos.
  */

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 47.5.4
+isaacscript-common 48.1.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -9595,8 +9595,8 @@ ____exports.BossID.CHUB = 3
 ____exports.BossID[____exports.BossID.CHUB] = "CHUB"
 ____exports.BossID.GURDY = 4
 ____exports.BossID[____exports.BossID.GURDY] = "GURDY"
-____exports.BossID.MONSTRO_II = 5
-____exports.BossID[____exports.BossID.MONSTRO_II] = "MONSTRO_II"
+____exports.BossID.MONSTRO_2 = 5
+____exports.BossID[____exports.BossID.MONSTRO_2] = "MONSTRO_2"
 ____exports.BossID.MOM = 6
 ____exports.BossID[____exports.BossID.MOM] = "MOM"
 ____exports.BossID.SCOLEX = 7
@@ -17307,6 +17307,16 @@ function ____exports.getEnumLength(self, transpiledEnum)
     local enumEntries = ____exports.getEnumEntries(nil, transpiledEnum)
     return #enumEntries
 end
+function ____exports.getEnumNames(self, transpiledEnum)
+    local enumNames = {}
+    for key, _value in pairs(transpiledEnum) do
+        if isString(nil, key) then
+            enumNames[#enumNames + 1] = key
+        end
+    end
+    __TS__ArraySort(enumNames)
+    return enumNames
+end
 function ____exports.getEnumValues(self, transpiledEnum)
     local enumEntries = ____exports.getEnumEntries(nil, transpiledEnum)
     return __TS__ArrayMap(
@@ -44571,7 +44581,7 @@ ____exports.BOSS_NAME_PNG_FILE_NAMES = {
     [BossID.LARRY_JR] = "bossname_19.0_larryjr.png",
     [BossID.CHUB] = "bossname_28.0_chub.png",
     [BossID.GURDY] = "bossname_36.0_gurdy.png",
-    [BossID.MONSTRO_II] = "bossname_43.0_monstro2.png",
+    [BossID.MONSTRO_2] = "bossname_43.0_monstro2.png",
     [BossID.MOM] = "bossname_45.0_mom.png",
     [BossID.SCOLEX] = "bossname_62.1_scolex.png",
     [BossID.MOMS_HEART] = "bossname_78.0_momsheart.png",
@@ -44680,7 +44690,7 @@ ____exports.BOSS_PORTRAIT_PNG_FILE_NAMES = {
     [BossID.LARRY_JR] = "portrait_19.0_larryjr.png",
     [BossID.CHUB] = "portrait_28.0_chub.png",
     [BossID.GURDY] = "portrait_36.0_gurdy.png",
-    [BossID.MONSTRO_II] = "portrait_43.0_monstro2.png",
+    [BossID.MONSTRO_2] = "portrait_43.0_monstro2.png",
     [BossID.MOM] = "portrait_45.0_mom.png",
     [BossID.SCOLEX] = "portrait_62.1_scolex.png",
     [BossID.MOMS_HEART] = "portrait_78.0_momsheart.png",

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

@@ -2,13 +2,14 @@
 /// <reference types="isaac-typescript-definitions" />
 /// <reference types="isaac-typescript-definitions" />
 /**
- * TypeScriptToLua will transpile TypeScript enums to Lua tables that have a double mapping. Thus,
- * when you iterate over them, you will get both the names of the enums and the values of the enums,
- * in a random order. Use this helper function to get the entries of the enum with the reverse
- * mappings filtered out.
+ * TypeScriptToLua will transpile TypeScript number enums to Lua tables that have a double mapping.
+ * Thus, when you iterate over them, you will get both the names of the enums and the values of the
+ * enums, in a random order. Use this helper function to get the entries of the enum with the
+ * reverse mappings filtered out.
  *
  * This function will return the enum values in a sorted order, which may not necessarily be the
- * same order as which they were declared in.
+ * same order as which they were declared in. (It is impossible to get the declaration order at
+ * run-time.)
  *
  * This function will work properly for both number enums and string enums. (Reverse mappings are
  * not created for string enums.)
@@ -20,12 +21,13 @@
  */
 export declare function getEnumEntries<T>(transpiledEnum: T): Array<[key: string, value: T[keyof T]]>;
 /**
- * TypeScriptToLua will transpile TypeScript enums to Lua tables that have a double mapping. Thus,
- * when you iterate over them, you will get both the names of the enums and the values of the enums,
- * in a random order. If all you need are the keys of an enum, use this helper function.
+ * TypeScriptToLua will transpile TypeScript number enums to Lua tables that have a double mapping.
+ * Thus, when you iterate over them, you will get both the names of the enums and the values of the
+ * enums, in a random order. If all you need are the keys of an enum, use this helper function.
  *
  * This function will return the enum keys in a sorted order, which may not necessarily be the same
- * order as which they were declared in.
+ * order as which they were declared in. (It is impossible to get the declaration order at
+ * run-time.)
  *
  * This function will work properly for both number enums and string enums. (Reverse mappings are
  * not created for string enums.)
@@ -39,12 +41,31 @@ export declare function getEnumKeys(transpiledEnum: Record<string | number, stri
 /** Helper function to get the amount of entries inside of an enum. */
 export declare function getEnumLength(transpiledEnum: Record<string | number, string | number>): int;
 /**
- * TypeScriptToLua will transpile TypeScript enums to Lua tables that have a double mapping. Thus,
- * when you iterate over them, you will get both the names of the enums and the values of the enums,
- * in a random order. If all you need are the values of an enum, use this helper function.
+ * TypeScriptToLua will transpile TypeScript number enums to Lua tables that have a double mapping.
+ * Thus, when you iterate over them, you will get both the names of the enums and the values of the
+ * enums, in a random order. If all you need are the names of an enum from the reverse mapping, use
+ * this helper function.
+ *
+ * This function will return the enum names in a sorted order, which may not necessarily be the same
+ * order as which they were declared in. (It is impossible to get the declaration order at
+ * run-time.)
+ *
+ * This function will work properly for both number enums and string enums. (Reverse mappings are
+ * not created for string enums, so their names would be equivalent to what would be returned by the
+ * `getEnumKeys` function.)
+ *
+ * For a more in depth explanation, see:
+ * https://isaacscript.github.io/main/gotchas#iterating-over-enums
+ */
+export declare function getEnumNames(transpiledEnum: Record<string | number, string | number>): string[];
+/**
+ * TypeScriptToLua will transpile TypeScript number enums to Lua tables that have a double mapping.
+ * Thus, when you iterate over them, you will get both the names of the enums and the values of the
+ * enums, in a random order. If all you need are the values of an enum, use this helper function.
  *
  * This function will return the enum values in a sorted order, which may not necessarily be the
- * same order as which they were declared in.
+ * same order as which they were declared in. (It is impossible to get the declaration order at
+ * run-time.)
  *
  * This function will work properly for both number enums and string enums. (Reverse mappings are
  * not created for string enums.)
@@ -101,7 +122,7 @@ export declare function isEnumValue<T extends Record<string, number | string>>(v
  */
 export declare function validateCustomEnum(transpiledEnumName: string, transpiledEnum: unknown): void;
 /**
- * Helper function to validate if every value in an enum is contiguous, starting at 0.
+ * Helper function to validate if every value in a number enum is contiguous, starting at 0.
  *
  * This is useful to automate checking large enums for typos.
  */

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

@@ -1 +1 @@
-{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../../src/functions/enums.ts"],"names":[],"mappings":";;;AAMA;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAC9B,cAAc,EAAE,CAAC,GAChB,KAAK,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAmBzC;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,WAAW,CACzB,cAAc,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GACvD,MAAM,EAAE,CAGV;AAED,sEAAsE;AACtE,wBAAgB,aAAa,CAC3B,cAAc,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GACvD,GAAG,CAGL;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAGrE;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAUpE;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAUnE;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,cAAc,EAAE,CAAC,EACjB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAM,GAC7D,CAAC,CAAC,MAAM,CAAC,CAAC,CAGZ;AAED,oFAAoF;AACpF,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,EACnE,KAAK,EAAE,MAAM,GAAG,MAAM,EACtB,cAAc,EAAE,CAAC,GAChB,KAAK,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAGrB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CAChC,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,OAAO,GACtB,IAAI,CAQN;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,EACtC,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,CAAC,GAChB,IAAI,CAsBN;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,4BAA4B,CAE1C,CAAC,SAAS,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,EAC/B,IAAI,SAAS,MAAM,GAAG,MAAM,KACzB,IAAI,CAAG"}
+{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../../src/functions/enums.ts"],"names":[],"mappings":";;;AAMA;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAC9B,cAAc,EAAE,CAAC,GAChB,KAAK,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAmBzC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,WAAW,CACzB,cAAc,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GACvD,MAAM,EAAE,CAGV;AAED,sEAAsE;AACtE,wBAAgB,aAAa,CAC3B,cAAc,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GACvD,GAAG,CAGL;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,YAAY,CAC1B,cAAc,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GACvD,MAAM,EAAE,CAaV;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAGrE;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAUpE;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAUnE;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,cAAc,EAAE,CAAC,EACjB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAM,GAC7D,CAAC,CAAC,MAAM,CAAC,CAAC,CAGZ;AAED,oFAAoF;AACpF,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,EACnE,KAAK,EAAE,MAAM,GAAG,MAAM,EACtB,cAAc,EAAE,CAAC,GAChB,KAAK,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAGrB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CAChC,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,OAAO,GACtB,IAAI,CAQN;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,EACtC,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,CAAC,GAChB,IAAI,CAsBN;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,4BAA4B,CAE1C,CAAC,SAAS,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,EAC/B,IAAI,SAAS,MAAM,GAAG,MAAM,KACzB,IAAI,CAAG"}

package/dist/src/functions/enums.lua

@@ -17,13 +17,14 @@ local isString = ____types.isString
 local ____utils = require("src.functions.utils")
 local assertDefined = ____utils.assertDefined
 local iRange = ____utils.iRange
---- TypeScriptToLua will transpile TypeScript enums to Lua tables that have a double mapping. Thus,
--- when you iterate over them, you will get both the names of the enums and the values of the enums,
--- in a random order. Use this helper function to get the entries of the enum with the reverse
--- mappings filtered out.
+--- TypeScriptToLua will transpile TypeScript number enums to Lua tables that have a double mapping.
+-- Thus, when you iterate over them, you will get both the names of the enums and the values of the
+-- enums, in a random order. Use this helper function to get the entries of the enum with the
+-- reverse mappings filtered out.
 -- 
 -- This function will return the enum values in a sorted order, which may not necessarily be the
--- same order as which they were declared in.
+-- same order as which they were declared in. (It is impossible to get the declaration order at
+-- run-time.)
 -- 
 -- This function will work properly for both number enums and string enums. (Reverse mappings are
 -- not created for string enums.)
@@ -53,12 +54,13 @@ function ____exports.getEnumEntries(self, transpiledEnum)
     )
     return enumEntries
 end
---- TypeScriptToLua will transpile TypeScript enums to Lua tables that have a double mapping. Thus,
--- when you iterate over them, you will get both the names of the enums and the values of the enums,
--- in a random order. If all you need are the keys of an enum, use this helper function.
+--- TypeScriptToLua will transpile TypeScript number enums to Lua tables that have a double mapping.
+-- Thus, when you iterate over them, you will get both the names of the enums and the values of the
+-- enums, in a random order. If all you need are the keys of an enum, use this helper function.
 -- 
 -- This function will return the enum keys in a sorted order, which may not necessarily be the same
--- order as which they were declared in.
+-- order as which they were declared in. (It is impossible to get the declaration order at
+-- run-time.)
 -- 
 -- This function will work properly for both number enums and string enums. (Reverse mappings are
 -- not created for string enums.)
@@ -84,12 +86,38 @@ function ____exports.getEnumLength(self, transpiledEnum)
     local enumEntries = ____exports.getEnumEntries(nil, transpiledEnum)
     return #enumEntries
 end
---- TypeScriptToLua will transpile TypeScript enums to Lua tables that have a double mapping. Thus,
--- when you iterate over them, you will get both the names of the enums and the values of the enums,
--- in a random order. If all you need are the values of an enum, use this helper function.
+--- TypeScriptToLua will transpile TypeScript number enums to Lua tables that have a double mapping.
+-- Thus, when you iterate over them, you will get both the names of the enums and the values of the
+-- enums, in a random order. If all you need are the names of an enum from the reverse mapping, use
+-- this helper function.
+-- 
+-- This function will return the enum names in a sorted order, which may not necessarily be the same
+-- order as which they were declared in. (It is impossible to get the declaration order at
+-- run-time.)
+-- 
+-- This function will work properly for both number enums and string enums. (Reverse mappings are
+-- not created for string enums, so their names would be equivalent to what would be returned by the
+-- `getEnumKeys` function.)
+-- 
+-- For a more in depth explanation, see:
+-- https://isaacscript.github.io/main/gotchas#iterating-over-enums
+function ____exports.getEnumNames(self, transpiledEnum)
+    local enumNames = {}
+    for key, _value in pairs(transpiledEnum) do
+        if isString(nil, key) then
+            enumNames[#enumNames + 1] = key
+        end
+    end
+    __TS__ArraySort(enumNames)
+    return enumNames
+end
+--- TypeScriptToLua will transpile TypeScript number enums to Lua tables that have a double mapping.
+-- Thus, when you iterate over them, you will get both the names of the enums and the values of the
+-- enums, in a random order. If all you need are the values of an enum, use this helper function.
 -- 
 -- This function will return the enum values in a sorted order, which may not necessarily be the
--- same order as which they were declared in.
+-- same order as which they were declared in. (It is impossible to get the declaration order at
+-- run-time.)
 -- 
 -- This function will work properly for both number enums and string enums. (Reverse mappings are
 -- not created for string enums.)
@@ -177,7 +205,7 @@ function ____exports.validateCustomEnum(self, transpiledEnumName, transpiledEnum
         end
     end
 end
---- Helper function to validate if every value in an enum is contiguous, starting at 0.
+--- Helper function to validate if every value in a number enum is contiguous, starting at 0.
 -- 
 -- This is useful to automate checking large enums for typos.
 function ____exports.validateEnumContiguous(self, transpiledEnumName, transpiledEnum)

package/dist/src/objects/bossNamePNGFileNames.lua

@@ -7,7 +7,7 @@ ____exports.BOSS_NAME_PNG_FILE_NAMES = {
     [BossID.LARRY_JR] = "bossname_19.0_larryjr.png",
     [BossID.CHUB] = "bossname_28.0_chub.png",
     [BossID.GURDY] = "bossname_36.0_gurdy.png",
-    [BossID.MONSTRO_II] = "bossname_43.0_monstro2.png",
+    [BossID.MONSTRO_2] = "bossname_43.0_monstro2.png",
     [BossID.MOM] = "bossname_45.0_mom.png",
     [BossID.SCOLEX] = "bossname_62.1_scolex.png",
     [BossID.MOMS_HEART] = "bossname_78.0_momsheart.png",

package/dist/src/objects/bossPortraitPNGFileNames.lua

@@ -7,7 +7,7 @@ ____exports.BOSS_PORTRAIT_PNG_FILE_NAMES = {
     [BossID.LARRY_JR] = "portrait_19.0_larryjr.png",
     [BossID.CHUB] = "portrait_28.0_chub.png",
     [BossID.GURDY] = "portrait_36.0_gurdy.png",
-    [BossID.MONSTRO_II] = "portrait_43.0_monstro2.png",
+    [BossID.MONSTRO_2] = "portrait_43.0_monstro2.png",
     [BossID.MOM] = "portrait_45.0_mom.png",
     [BossID.SCOLEX] = "portrait_62.1_scolex.png",
     [BossID.MOMS_HEART] = "portrait_78.0_momsheart.png",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "47.5.4",
+  "version": "48.1.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -25,6 +25,6 @@
   "main": "dist/src/index",
   "types": "dist/index.rollup.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^17.0.5"
+    "isaac-typescript-definitions": "^18.0.0"
   }
 }

package/src/functions/enums.ts

@@ -5,13 +5,14 @@ import { isNumber, isString } from "./types";
 import { assertDefined, iRange } from "./utils";
 
 /**
- * TypeScriptToLua will transpile TypeScript enums to Lua tables that have a double mapping. Thus,
- * when you iterate over them, you will get both the names of the enums and the values of the enums,
- * in a random order. Use this helper function to get the entries of the enum with the reverse
- * mappings filtered out.
+ * TypeScriptToLua will transpile TypeScript number enums to Lua tables that have a double mapping.
+ * Thus, when you iterate over them, you will get both the names of the enums and the values of the
+ * enums, in a random order. Use this helper function to get the entries of the enum with the
+ * reverse mappings filtered out.
  *
  * This function will return the enum values in a sorted order, which may not necessarily be the
- * same order as which they were declared in.
+ * same order as which they were declared in. (It is impossible to get the declaration order at
+ * run-time.)
  *
  * This function will work properly for both number enums and string enums. (Reverse mappings are
  * not created for string enums.)
@@ -45,12 +46,13 @@ export function getEnumEntries<T>(
 }
 
 /**
- * TypeScriptToLua will transpile TypeScript enums to Lua tables that have a double mapping. Thus,
- * when you iterate over them, you will get both the names of the enums and the values of the enums,
- * in a random order. If all you need are the keys of an enum, use this helper function.
+ * TypeScriptToLua will transpile TypeScript number enums to Lua tables that have a double mapping.
+ * Thus, when you iterate over them, you will get both the names of the enums and the values of the
+ * enums, in a random order. If all you need are the keys of an enum, use this helper function.
  *
  * This function will return the enum keys in a sorted order, which may not necessarily be the same
- * order as which they were declared in.
+ * order as which they were declared in. (It is impossible to get the declaration order at
+ * run-time.)
  *
  * This function will work properly for both number enums and string enums. (Reverse mappings are
  * not created for string enums.)
@@ -76,12 +78,47 @@ export function getEnumLength(
 }
 
 /**
- * TypeScriptToLua will transpile TypeScript enums to Lua tables that have a double mapping. Thus,
- * when you iterate over them, you will get both the names of the enums and the values of the enums,
- * in a random order. If all you need are the values of an enum, use this helper function.
+ * TypeScriptToLua will transpile TypeScript number enums to Lua tables that have a double mapping.
+ * Thus, when you iterate over them, you will get both the names of the enums and the values of the
+ * enums, in a random order. If all you need are the names of an enum from the reverse mapping, use
+ * this helper function.
+ *
+ * This function will return the enum names in a sorted order, which may not necessarily be the same
+ * order as which they were declared in. (It is impossible to get the declaration order at
+ * run-time.)
+ *
+ * This function will work properly for both number enums and string enums. (Reverse mappings are
+ * not created for string enums, so their names would be equivalent to what would be returned by the
+ * `getEnumKeys` function.)
+ *
+ * For a more in depth explanation, see:
+ * https://isaacscript.github.io/main/gotchas#iterating-over-enums
+ */
+export function getEnumNames(
+  transpiledEnum: Record<string | number, string | number>,
+): string[] {
+  const enumNames: string[] = [];
+
+  for (const [key, _value] of pairs(transpiledEnum)) {
+    if (isString(key)) {
+      enumNames.push(key);
+    }
+  }
+
+  // The enum names will be in a random order (because of "pairs"), so sort them.
+  enumNames.sort();
+
+  return enumNames;
+}
+
+/**
+ * TypeScriptToLua will transpile TypeScript number enums to Lua tables that have a double mapping.
+ * Thus, when you iterate over them, you will get both the names of the enums and the values of the
+ * enums, in a random order. If all you need are the values of an enum, use this helper function.
  *
  * This function will return the enum values in a sorted order, which may not necessarily be the
- * same order as which they were declared in.
+ * same order as which they were declared in. (It is impossible to get the declaration order at
+ * run-time.)
  *
  * This function will work properly for both number enums and string enums. (Reverse mappings are
  * not created for string enums.)
@@ -191,7 +228,7 @@ export function validateCustomEnum(
 }
 
 /**
- * Helper function to validate if every value in an enum is contiguous, starting at 0.
+ * Helper function to validate if every value in a number enum is contiguous, starting at 0.
  *
  * This is useful to automate checking large enums for typos.
  */

package/src/objects/bossNamePNGFileNames.ts

@@ -8,7 +8,7 @@ export const BOSS_NAME_PNG_FILE_NAMES = {
   [BossID.LARRY_JR]: "bossname_19.0_larryjr.png", // 2
   [BossID.CHUB]: "bossname_28.0_chub.png", // 3
   [BossID.GURDY]: "bossname_36.0_gurdy.png", // 4
-  [BossID.MONSTRO_II]: "bossname_43.0_monstro2.png", // 5
+  [BossID.MONSTRO_2]: "bossname_43.0_monstro2.png", // 5
   [BossID.MOM]: "bossname_45.0_mom.png", // 6
   [BossID.SCOLEX]: "bossname_62.1_scolex.png", // 7
   [BossID.MOMS_HEART]: "bossname_78.0_momsheart.png", // 8

package/src/objects/bossPortraitPNGFileNames.ts

@@ -8,7 +8,7 @@ export const BOSS_PORTRAIT_PNG_FILE_NAMES = {
   [BossID.LARRY_JR]: "portrait_19.0_larryjr.png", // 2
   [BossID.CHUB]: "portrait_28.0_chub.png", // 3
   [BossID.GURDY]: "portrait_36.0_gurdy.png", // 4
-  [BossID.MONSTRO_II]: "portrait_43.0_monstro2.png", // 5
+  [BossID.MONSTRO_2]: "portrait_43.0_monstro2.png", // 5
   [BossID.MOM]: "portrait_45.0_mom.png", // 6
   [BossID.SCOLEX]: "portrait_62.1_scolex.png", // 7
   [BossID.MOMS_HEART]: "portrait_78.0_momsheart.png", // 8