isaacscript-common 1.2.291 → 2.0.1

package/dist/functions/entitySpecific.d.ts

@@ -1,7 +1,7 @@
-/// <reference types="isaac-typescript-definitions" />
+import { BombVariant, EffectVariant, EntityType, FamiliarVariant, KnifeVariant, LaserVariant, PickupVariant, ProjectileVariant, SlotVariant, TearVariant } from "isaac-typescript-definitions";
 import { EntityTypeNonNPC } from "../types/EntityTypeNonNPC";
 /**
- * Helper function to get all of the `EntityType.ENTITY_BOMB` in the room.
+ * Helper function to get all of the `EntityType.BOMB` in the room.
  *
  * Example:
  * ```ts
@@ -13,7 +13,7 @@ import { EntityTypeNonNPC } from "../types/EntityTypeNonNPC";
  */
 export declare function getBombs(bombVariant?: BombVariant | int, subType?: number): EntityBomb[];
 /**
- * Helper function to get all of the `EntityType.ENTITY_EFFECT` in the room.
+ * Helper function to get all of the `EntityType.EFFECT` in the room.
  *
  * Example:
  * ```ts
@@ -37,7 +37,7 @@ export declare function getEffects(effectVariant?: EffectVariant | int, subType?
  */
 export declare function getFamiliars(familiarVariant?: FamiliarVariant | int, subType?: number): EntityFamiliar[];
 /**
- * Helper function to get all of the `EntityType.ENTITY_KNIFE` in the room.
+ * Helper function to get all of the `EntityType.KNIFE` in the room.
  *
  * Example:
  * ```ts
@@ -49,7 +49,7 @@ export declare function getFamiliars(familiarVariant?: FamiliarVariant | int, su
  */
 export declare function getKnives(knifeVariant?: KnifeVariant | int, subType?: number): EntityKnife[];
 /**
- * Helper function to get all of the `EntityType.ENTITY_LASER` in the room.
+ * Helper function to get all of the `EntityType.LASER` in the room.
  *
  * Example:
  * ```ts
@@ -75,7 +75,7 @@ export declare function getNPCs(entityType?: EntityType | int, variant?: int, su
  */
 export declare function getPickups(pickupVariant?: PickupVariant | int, subType?: number): EntityPickup[];
 /**
- * Helper function to get all of the `EntityType.ENTITY_PROJECTILE` in the room.
+ * Helper function to get all of the `EntityType.PROJECTILE` in the room.
  *
  * Example:
  * ```ts
@@ -87,7 +87,7 @@ export declare function getPickups(pickupVariant?: PickupVariant | int, subType?
  */
 export declare function getProjectiles(projectileVariant?: ProjectileVariant | int, subType?: number): EntityProjectile[];
 /**
- * Helper function to get all of the `EntityType.ENTITY_SLOT` in the room.
+ * Helper function to get all of the `EntityType.SLOT` in the room.
  *
  * Example:
  * ```ts
@@ -99,7 +99,7 @@ export declare function getProjectiles(projectileVariant?: ProjectileVariant | i
  */
 export declare function getSlots(slotVariant?: SlotVariant | int, subType?: number): Entity[];
 /**
- * Helper function to get all of the `EntityType.ENTITY_TEAR` in the room.
+ * Helper function to get all of the `EntityType.TEAR` in the room.
  *
  * Example:
  * ```ts
@@ -111,7 +111,7 @@ export declare function getSlots(slotVariant?: SlotVariant | int, subType?: numb
  */
 export declare function getTears(tearVariant?: TearVariant | int, subType?: number): EntityTear[];
 /**
- * Helper function to remove all of the `EntityType.ENTITY_BOMB` in the room.
+ * Helper function to remove all of the `EntityType.BOMB` in the room.
  *
  * @param bombVariant Optional. If specified, will only remove bombs that match this variant.
  * @param subType Optional. If specified, will only remove bombs that match this sub-type.
@@ -131,14 +131,15 @@ export declare function removeAllEffects(effectVariant?: EffectVariant | int, su
 /**
  * Helper function to remove all of the familiars in the room.
  *
- * @param familiarVariant Optional. If specified, will only remove familiars that match this variant.
+ * @param familiarVariant Optional. If specified, will only remove familiars that match this
+ * variant.
  * @param subType Optional. If specified, will only remove familiars that match this sub-type.
  * @param cap Optional. If specified, will only remove the given amount of familiars.
  * @returns True if one or more familiars were removed, false otherwise.
  */
 export declare function removeAllFamiliars(familiarVariant?: FamiliarVariant | int, subType?: int, cap?: int): boolean;
 /**
- * Helper function to remove all of the `EntityType.ENTITY_KNIFE` in the room.
+ * Helper function to remove all of the `EntityType.KNIFE` in the room.
  *
  * @param knifeVariant Optional. If specified, will only remove knives that match this variant.
  * @param subType Optional. If specified, will only remove knives that match this sub-type.
@@ -147,7 +148,7 @@ export declare function removeAllFamiliars(familiarVariant?: FamiliarVariant | i
  */
 export declare function removeAllKnives(knifeVariant?: KnifeVariant | int, subType?: int, cap?: int): boolean;
 /**
- * Helper function to remove all of the `EntityType.ENTITY_LASER` in the room.
+ * Helper function to remove all of the `EntityType.LASER` in the room.
  *
  * @param laserVariant Optional. If specified, will only remove lasers that match this variant.
  * @param subType Optional. If specified, will only remove lasers that match this sub-type.
@@ -172,16 +173,17 @@ export declare function removeAllNPCs(cap?: int): boolean;
  */
 export declare function removeAllPickups(pickupVariant?: PickupVariant | int, subType?: int, cap?: int): boolean;
 /**
- * Helper function to remove all of the `EntityType.ENTITY_PROJECTILE` in the room.
+ * Helper function to remove all of the `EntityType.PROJECTILE` in the room.
  *
- * @param projectileVariant Optional. If specified, will only remove projectiles that match this variant.
+ * @param projectileVariant Optional. If specified, will only remove projectiles that match this
+ * variant.
  * @param subType Optional. If specified, will only remove projectiles that match this sub-type.
  * @param cap Optional. If specified, will only remove the given amount of projectiles.
  * @returns True if one or more projectiles were removed, false otherwise.
  */
 export declare function removeAllProjectiles(projectileVariant?: ProjectileVariant | int, subType?: int, cap?: int): boolean;
 /**
- * Helper function to remove all of the `EntityType.ENTITY_SLOT` in the room.
+ * Helper function to remove all of the `EntityType.SLOT` in the room.
  *
  * @param slotVariant Optional. If specified, will only remove slots that match this variant.
  * @param subType Optional. If specified, will only remove slots that match this sub-type.
@@ -190,7 +192,7 @@ export declare function removeAllProjectiles(projectileVariant?: ProjectileVaria
  */
 export declare function removeAllSlots(slotVariant?: SlotVariant | int, subType?: int, cap?: int): boolean;
 /**
- * Helper function to remove all of the `EntityType.ENTITY_TEAR` in the room.
+ * Helper function to remove all of the `EntityType.TEAR` in the room.
  *
  * @param tearVariant Optional. If specified, will only remove tears that match this variant.
  * @param subType Optional. If specified, will only remove tears that match this sub-type.
@@ -198,43 +200,43 @@ export declare function removeAllSlots(slotVariant?: SlotVariant | int, subType?
  * @returns True if one or more tears were removed, false otherwise.
  */
 export declare function removeAllTears(tearVariant?: TearVariant | int, subType?: int, cap?: int): boolean;
-/** Helper function to spawn a `EntityType.ENTITY_BOMB` (4). */
+/** Helper function to spawn a `EntityType.BOMB` (4). */
 export declare function spawnBomb(bombVariant: BombVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityBomb;
-/** Helper function to spawn a `EntityType.ENTITY_BOMB` (4) with a specific seed. */
+/** Helper function to spawn a `EntityType.BOMB` (4) with a specific seed. */
 export declare function spawnBombWithSeed(bombVariant: BombVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityBomb;
-/** Helper function to spawn a `EntityType.ENTITY_EFFECT` (1000). */
+/** Helper function to spawn a `EntityType.EFFECT` (1000). */
 export declare function spawnEffect(effectVariant: EffectVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityEffect;
-/** Helper function to spawn a `EntityType.ENTITY_EFFECT` (1000) with a specific seed. */
+/** Helper function to spawn a `EntityType.EFFECT` (1000) with a specific seed. */
 export declare function spawnEffectWithSeed(effectVariant: EffectVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityEffect;
-/** Helper function to spawn a `EntityType.ENTITY_FAMILIAR` (3). */
+/** Helper function to spawn a `EntityType.FAMILIAR` (3). */
 export declare function spawnFamiliar(familiarVariant: FamiliarVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityFamiliar;
-/** Helper function to spawn a `EntityType.ENTITY_FAMILIAR` (3) with a specific seed. */
+/** Helper function to spawn a `EntityType.FAMILIAR` (3) with a specific seed. */
 export declare function spawnFamiliarWithSeed(familiarVariant: FamiliarVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityFamiliar;
-/** Helper function to spawn a `EntityType.ENTITY_KNIFE` (8). */
+/** Helper function to spawn a `EntityType.KNIFE` (8). */
 export declare function spawnKnife(knifeVariant: KnifeVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityKnife;
-/** Helper function to spawn a `EntityType.ENTITY_KNIFE` (8) with a specific seed. */
+/** Helper function to spawn a `EntityType.KNIFE` (8) with a specific seed. */
 export declare function spawnKnifeWithSeed(knifeVariant: KnifeVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityKnife;
-/** Helper function to spawn a `EntityType.ENTITY_LASER` (7). */
+/** Helper function to spawn a `EntityType.LASER` (7). */
 export declare function spawnLaser(laserVariant: LaserVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityLaser;
-/** Helper function to spawn a `EntityType.ENTITY_LASER` (7) with a specific seed. */
+/** Helper function to spawn a `EntityType.LASER` (7) with a specific seed. */
 export declare function spawnLaserWithSeed(laserVariant: LaserVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityLaser;
 /** Helper function to spawn an NPC. */
 export declare function spawnNPC<T extends number>(entityType: T extends EntityTypeNonNPC ? never : T, variant: int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityNPC;
 /** Helper function to spawn an NPC with a specific seed. */
 export declare function spawnNPCWithSeed(entityType: EntityType | int, variant: int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityNPC;
-/** Helper function to spawn a `EntityType.ENTITY_PICKUP` (5). */
+/** Helper function to spawn a `EntityType.PICKUP` (5). */
 export declare function spawnPickup(pickupVariant: PickupVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
-/** Helper function to spawn a `EntityType.ENTITY_PICKUP` (5) with a specific seed. */
+/** Helper function to spawn a `EntityType.PICKUP` (5) with a specific seed. */
 export declare function spawnPickupWithSeed(pickupVariant: PickupVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
-/** Helper function to spawn a `EntityType.ENTITY_PROJECTILE` (9). */
+/** Helper function to spawn a `EntityType.PROJECTILE` (9). */
 export declare function spawnProjectile(projectileVariant: ProjectileVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityProjectile;
-/** Helper function to spawn a `EntityType.ENTITY_PROJECTILE` (9) with a specific seed. */
+/** Helper function to spawn a `EntityType.PROJECTILE` (9) with a specific seed. */
 export declare function spawnProjectileWithSeed(projectileVariant: ProjectileVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityProjectile;
-/** Helper function to spawn a `EntityType.ENTITY_SLOT` (6). */
+/** Helper function to spawn a `EntityType.SLOT` (6). */
 export declare function spawnSlot(slotVariant: SlotVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): Entity;
-/** Helper function to spawn a `EntityType.ENTITY_SLOT` (6) with a specific seed. */
+/** Helper function to spawn a `EntityType.SLOT` (6) with a specific seed. */
 export declare function spawnSlotWithSeed(slotVariant: int | SlotVariant, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): Entity;
-/** Helper function to spawn a `EntityType.ENTITY_TEAR` (2). */
+/** Helper function to spawn a `EntityType.TEAR` (2). */
 export declare function spawnTear(tearVariant: TearVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityTear;
 /** Helper function to spawn a `EntityType.EntityType` (2) with a specific seed. */
 export declare function spawnTearWithSeed(tearVariant: TearVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityTear;

package/dist/functions/entitySpecific.lua

@@ -1,5 +1,6 @@
---[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
 local ____constants = require("constants")
 local VectorZero = ____constants.VectorZero
 local ____entity = require("functions.entity")
@@ -13,7 +14,7 @@ function ____exports.getBombs(self, bombVariant, subType)
     if subType == nil then
         subType = -1
     end
-    local entities = getEntities(nil, EntityType.ENTITY_BOMB, bombVariant, subType)
+    local entities = getEntities(nil, EntityType.BOMB, bombVariant, subType)
     local bombs = {}
     for ____, entity in ipairs(entities) do
         local bomb = entity:ToBomb()
@@ -30,7 +31,7 @@ function ____exports.getEffects(self, effectVariant, subType)
     if subType == nil then
         subType = -1
     end
-    local entities = getEntities(nil, EntityType.ENTITY_EFFECT, effectVariant, subType)
+    local entities = getEntities(nil, EntityType.EFFECT, effectVariant, subType)
     local effects = {}
     for ____, entity in ipairs(entities) do
         local effect = entity:ToEffect()
@@ -47,7 +48,7 @@ function ____exports.getFamiliars(self, familiarVariant, subType)
     if subType == nil then
         subType = -1
     end
-    local entities = getEntities(nil, EntityType.ENTITY_FAMILIAR, familiarVariant, subType)
+    local entities = getEntities(nil, EntityType.FAMILIAR, familiarVariant, subType)
     local familiars = {}
     for ____, entity in ipairs(entities) do
         local familiar = entity:ToFamiliar()
@@ -64,7 +65,7 @@ function ____exports.getKnives(self, knifeVariant, subType)
     if subType == nil then
         subType = -1
     end
-    local entities = getEntities(nil, EntityType.ENTITY_KNIFE, knifeVariant, subType)
+    local entities = getEntities(nil, EntityType.KNIFE, knifeVariant, subType)
     local knives = {}
     for ____, entity in ipairs(entities) do
         local knife = entity:ToKnife()
@@ -81,7 +82,7 @@ function ____exports.getLasers(self, laserVariant, subType)
     if subType == nil then
         subType = -1
     end
-    local entities = getEntities(nil, EntityType.ENTITY_LASER, laserVariant, subType)
+    local entities = getEntities(nil, EntityType.LASER, laserVariant, subType)
     local lasers = {}
     for ____, entity in ipairs(entities) do
         local laser = entity:ToLaser()
@@ -118,7 +119,7 @@ function ____exports.getPickups(self, pickupVariant, subType)
     if subType == nil then
         subType = -1
     end
-    local entities = getEntities(nil, EntityType.ENTITY_PICKUP, pickupVariant, subType)
+    local entities = getEntities(nil, EntityType.PICKUP, pickupVariant, subType)
     local pickups = {}
     for ____, entity in ipairs(entities) do
         local pickup = entity:ToPickup()
@@ -135,7 +136,7 @@ function ____exports.getProjectiles(self, projectileVariant, subType)
     if subType == nil then
         subType = -1
     end
-    local entities = getEntities(nil, EntityType.ENTITY_PROJECTILE, projectileVariant, subType)
+    local entities = getEntities(nil, EntityType.PROJECTILE, projectileVariant, subType)
     local projectiles = {}
     for ____, entity in ipairs(entities) do
         local projectile = entity:ToProjectile()
@@ -152,7 +153,7 @@ function ____exports.getSlots(self, slotVariant, subType)
     if subType == nil then
         subType = -1
     end
-    local slots = getEntities(nil, EntityType.ENTITY_SLOT, slotVariant, subType)
+    local slots = getEntities(nil, EntityType.SLOT, slotVariant, subType)
     return slots
 end
 function ____exports.getTears(self, tearVariant, subType)
@@ -162,7 +163,7 @@ function ____exports.getTears(self, tearVariant, subType)
     if subType == nil then
         subType = -1
     end
-    local entities = getEntities(nil, EntityType.ENTITY_TEAR, tearVariant, subType)
+    local entities = getEntities(nil, EntityType.TEAR, tearVariant, subType)
     local tears = {}
     for ____, entity in ipairs(entities) do
         local tear = entity:ToTear()
@@ -224,7 +225,7 @@ function ____exports.spawnBomb(self, bombVariant, subType, position, velocity, s
     end
     local entity = spawn(
         nil,
-        EntityType.ENTITY_BOMB,
+        EntityType.BOMB,
         bombVariant,
         subType,
         position,
@@ -267,7 +268,7 @@ function ____exports.spawnEffect(self, effectVariant, subType, position, velocit
     end
     local entity = spawn(
         nil,
-        EntityType.ENTITY_EFFECT,
+        EntityType.EFFECT,
         effectVariant,
         subType,
         position,
@@ -310,7 +311,7 @@ function ____exports.spawnFamiliar(self, familiarVariant, subType, position, vel
     end
     local entity = spawn(
         nil,
-        EntityType.ENTITY_FAMILIAR,
+        EntityType.FAMILIAR,
         familiarVariant,
         subType,
         position,
@@ -353,7 +354,7 @@ function ____exports.spawnKnife(self, knifeVariant, subType, position, velocity,
     end
     local entity = spawn(
         nil,
-        EntityType.ENTITY_KNIFE,
+        EntityType.KNIFE,
         knifeVariant,
         subType,
         position,
@@ -396,7 +397,7 @@ function ____exports.spawnLaser(self, laserVariant, subType, position, velocity,
     end
     local entity = spawn(
         nil,
-        EntityType.ENTITY_LASER,
+        EntityType.LASER,
         laserVariant,
         subType,
         position,
@@ -483,7 +484,7 @@ function ____exports.spawnPickup(self, pickupVariant, subType, position, velocit
     end
     local entity = spawn(
         nil,
-        EntityType.ENTITY_PICKUP,
+        EntityType.PICKUP,
         pickupVariant,
         subType,
         position,
@@ -526,7 +527,7 @@ function ____exports.spawnProjectile(self, projectileVariant, subType, position,
     end
     local entity = spawn(
         nil,
-        EntityType.ENTITY_PROJECTILE,
+        EntityType.PROJECTILE,
         projectileVariant,
         subType,
         position,
@@ -569,7 +570,7 @@ function ____exports.spawnSlot(self, slotVariant, subType, position, velocity, s
     end
     return spawn(
         nil,
-        EntityType.ENTITY_SLOT,
+        EntityType.SLOT,
         slotVariant,
         subType,
         position,
@@ -607,7 +608,7 @@ function ____exports.spawnTear(self, tearVariant, subType, position, velocity, s
     end
     local entity = spawn(
         nil,
-        EntityType.ENTITY_TEAR,
+        EntityType.TEAR,
         tearVariant,
         subType,
         position,

package/dist/functions/enums.d.ts

@@ -0,0 +1,70 @@
+/// <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.
+ *
+ * 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.
+ *
+ * This function will work properly for both number enums and string enums. (Reverse mappings are
+ * not created for string enums.)
+ *
+ * Also see the `getEnumKeys` and `getEnumValues` helper functions.
+ *
+ * For a more in depth explanation, see:
+ * https://isaacscript.github.io/docs/gotchas#iterating-over-enums
+ */
+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.
+ *
+ * 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.
+ *
+ * This function will work properly for both number enums and string enums. (Reverse mappings are
+ * not created for string enums.)
+ *
+ * Also see the `getEnumEntries` and `getEnumValues` helper functions.
+ *
+ * For a more in depth explanation, see:
+ * https://isaacscript.github.io/docs/gotchas#iterating-over-enums
+ */
+export declare function getEnumKeys<T>(transpiledEnum: T): string[];
+/** Helper function to get the amount of entries inside of an enum. */
+export declare function getEnumLength<T>(transpiledEnum: T): 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.
+ *
+ * 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.
+ *
+ * This function will work properly for both number enums and string enums. (Reverse mappings are
+ * not created for string enums.)
+ *
+ * Also see the `getEnumEntries` and `getEnumKeys` helper functions.
+ *
+ * For a more in depth explanation, see:
+ * https://isaacscript.github.io/docs/gotchas#iterating-over-enums
+ */
+export declare function getEnumValues<T>(transpiledEnum: T): Array<T[keyof T]>;
+export declare function getLastEnumValue<T>(transpiledEnum: T): T[keyof T];
+/**
+ * Helper function to check every value of a custom enum for -1. This is helpful as a run-time check
+ * because many methods of the Isaac class return -1 if they fail.
+ *
+ * Example:
+ * ```ts
+ * enum EntityTypeCustom {
+ *   FOO = Isaac.GetEntityTypeByName("Foo"),
+ * }
+ *
+ * validateCustomEnum("EntityTypeCustom", EntityTypeCustom);
+ * ```
+ */
+export declare function validateCustomEnum(transpiledEnumName: string, transpiledEnum: unknown): void;

package/dist/functions/enums.lua

@@ -0,0 +1,71 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArraySort = ____lualib.__TS__ArraySort
+local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local ____exports = {}
+function ____exports.getEnumEntries(self, transpiledEnum)
+    local enumEntries = {}
+    for key, value in pairs(transpiledEnum) do
+        if type(key) == "string" then
+            enumEntries[#enumEntries + 1] = {key, value}
+        end
+    end
+    __TS__ArraySort(
+        enumEntries,
+        function(____, ____bindingPattern0, ____bindingPattern1)
+            local value1
+            local _key1 = ____bindingPattern0[1]
+            value1 = ____bindingPattern0[2]
+            local value2
+            local _key2 = ____bindingPattern1[1]
+            value2 = ____bindingPattern1[2]
+            return value1 < value2 and -1 or (value1 > value2 and 1 or 0)
+        end
+    )
+    return enumEntries
+end
+function ____exports.getEnumKeys(self, transpiledEnum)
+    local enumEntries = ____exports.getEnumEntries(nil, transpiledEnum)
+    return __TS__ArrayMap(
+        enumEntries,
+        function(____, ____bindingPattern0)
+            local key
+            key = ____bindingPattern0[1]
+            local _value = ____bindingPattern0[2]
+            return key
+        end
+    )
+end
+function ____exports.getEnumLength(self, transpiledEnum)
+    local enumEntries = ____exports.getEnumEntries(nil, transpiledEnum)
+    return #enumEntries
+end
+function ____exports.getEnumValues(self, transpiledEnum)
+    local enumEntries = ____exports.getEnumEntries(nil, transpiledEnum)
+    return __TS__ArrayMap(
+        enumEntries,
+        function(____, ____bindingPattern0)
+            local value
+            local _key = ____bindingPattern0[1]
+            value = ____bindingPattern0[2]
+            return value
+        end
+    )
+end
+function ____exports.getLastEnumValue(self, transpiledEnum)
+    local enumValues = ____exports.getEnumValues(nil, transpiledEnum)
+    local lastElement = enumValues[#enumValues]
+    if lastElement == nil then
+        error("Failed to get the last value from an enum since the enum was empty.")
+    end
+    return lastElement
+end
+function ____exports.validateCustomEnum(self, transpiledEnumName, transpiledEnum)
+    for ____, ____value in ipairs(____exports.getEnumEntries(nil, transpiledEnum)) do
+        local key = ____value[1]
+        local value = ____value[2]
+        if value == -1 then
+            error((("Failed to find custom enum value: " .. transpiledEnumName) .. ".") .. key)
+        end
+    end
+end
+return ____exports

package/dist/functions/familiars.d.ts

@@ -8,7 +8,7 @@
  * RNG object; see the documentation of the method for more details.)
  *
  * This function is meant to be called in the EvaluateCache callback (when the cache flag is equal
- * to `CacheFlag.CACHE_FAMILIARS`).
+ * to `CacheFlag.FAMILIARS`).
  *
  * Note that this function is only meant to be used in special circumstances where the familiar
  * count is completely custom and does not correspond to the amount of collectibles. For the general
@@ -37,7 +37,7 @@ export declare function checkFamiliar(player: EntityPlayer, collectibleType: int
  * that the target count is handled automatically.
  *
  * This function is meant to be called in the EvaluateCache callback (when the cache flag is equal
- * to `CacheFlag.CACHE_FAMILIARS`).
+ * to `CacheFlag.FAMILIARS`).
  *
  * Use this function when the amount of familiars should be equal to the amount of associated
  * collectibles that the player has (plus any extras from having used Box of Friends or Monster

package/dist/functions/familiars.lua

@@ -1,4 +1,3 @@
---[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
 local ____cachedClasses = require("cachedClasses")
 local itemConfig = ____cachedClasses.itemConfig

package/dist/functions/flag.d.ts

@@ -1,6 +1,7 @@
-/// <reference types="isaac-typescript-definitions" />
+import { DamageFlag } from "isaac-typescript-definitions";
 /**
  * Helper function to add a bit flag to an existing set of bit flags.
+ *
  * This is a variadic function, so pass as many flags as you want to add.
  *
  * Example 1:
@@ -18,14 +19,37 @@
  * ```
  *
  * @param flags The existing set of bit flags.
- * @param flag One or more bit flags to add, each as a separate argument.
+ * @param flagsToAdd One or more bit flags to add, each as a separate argument.
  * @returns The combined bit flags.
  */
-export declare function addFlag(flags: int, ...flag: int[]): int;
+export declare function addFlag<T extends BitFlag | BitFlag128>(flags: T | BitFlags<T>, ...flagsToAdd: T[]): BitFlags<T>;
+/**
+ * Helper function for casting a flag enum value to a `BitFlags` object.
+ *
+ * This is useful because the compiler will prevent you from assigning a specific flag to a
+ * `BitFlags` property. (It does this to ensure type safety, since `BitFlags` can represent a zero
+ * value or a composition of N flags.)
+ *
+ * For example:
+ *
+ * ```ts
+ * player.TearFlags = bitFlags(TearFlag.SPECTRAL);
+ * ```
+ */
+export declare function bitFlags<T extends BitFlag | BitFlag128>(flag: T): BitFlags<T>;
+/**
+ * Helper function to get the key associated with a particular flag.
+ *
+ * (Since bit flags are represented by custom objects instead of normal TypeScript enums, you cannot
+ * use the reverse mapping to find the associated key of a given enum value. Use this helper
+ * function instead of indexing the enum directly.)
+ */
+export declare function getFlagName<T extends BitFlag | BitFlag128>(flag: BitFlag, flagEnum: Record<string, T>): string | undefined;
 /**
  * Helper function to determine if a particular bit flag is set to true.
- * This is a variadic function, so pass as many flags as you want to check for.
- * If passed multiple flags, it will only return true if all of the flags are set.
+ *
+ * This is a variadic function, so pass as many flags as you want to check for. If passed multiple
+ * flags, it will only return true if all of the flags are set.
  *
  * Example:
  * ```ts
@@ -36,17 +60,25 @@ export declare function addFlag(flags: int, ...flag: int[]): int;
  * ```
  *
  * @param flags The existing set of bit flags.
- * @param flag One or more bit flags to check for, each as a separate argument.
+ * @param flagsToCheck One or more bit flags to check for, each as a separate argument.
  */
-export declare function hasFlag(flags: int, ...flag: int[]): boolean;
+export declare function hasFlag<T extends BitFlag | BitFlag128>(flags: T | BitFlags<T>, ...flagsToCheck: T[]): boolean;
+/**
+ * Helper function to check if every bit in the flag is turned off.
+ *
+ * (This is equivalent to checking if the flag is equal to 0, but this is not possible without
+ * casting the flag to a number.)
+ */
+export declare function isEmptyFlag<T extends BitFlag | BitFlag128>(flag: T): boolean;
 /**
  * Helper function to determine whether damage to a player in the EntityTakeDmg callback was
  * self-inflicted. For example, damage from a Curse Room door, a Razor, or a Blood Donation Machine
  * would count as self-inflicted damage.
  */
-export declare function isSelfDamage(damageFlags: int): boolean;
+export declare function isSelfDamage(damageFlags: DamageFlag | BitFlags<DamageFlag>): boolean;
 /**
  * Helper function to remove a bit flag from an existing set of bit flags.
+ *
  * This is a variadic function, so pass as many flags as you want to remove.
  *
  * Example:
@@ -57,7 +89,7 @@ export declare function isSelfDamage(damageFlags: int): boolean;
  * ```
  *
  * @param flags The existing set of bit flags.
- * @param flag One or more bit flags to remove, each as a separate argument.
+ * @param flagsToRemove One or more bit flags to remove, each as a separate argument.
  * @returns The combined bit flags.
  */
-export declare function removeFlag(flags: int, ...flag: int[]): int;
+export declare function removeFlag<T extends BitFlag | BitFlag128>(flags: T | BitFlags<T>, ...flagsToRemove: T[]): BitFlags<T>;