isaacscript-common 48.0.0 → 49.0.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.
  */