isaacscript-common 2.0.32 → 2.1.0

package/{dist/functions → functions}/chargeBar.d.ts

@@ -1,12 +1,5 @@
 /// <reference types="isaac-typescript-definitions" />
-/** A collection of the four sprites necessary in order to render a charge bar. */
-export interface ChargeBarSprites {
-    back: Sprite;
-    meter: Sprite;
-    meterBattery: Sprite;
-    lines: Sprite;
-    maxCharges: int;
-}
+import { ChargeBarSprites } from "../types/ChargeBarSprites";
 /**
  * Constructor for a `ChargeBarSprites` object. For more information, see the `renderChargeBar`
  * helper function.

package/{dist/functions → functions}/color.d.ts

@@ -2,13 +2,16 @@
 /// <reference types="typescript-to-lua/language-extensions" />
 import { SerializationType } from "../enums/SerializationType";
 declare type SerializedColor = LuaTable<string, unknown> & {
-    __serializedColorBrand: unknown;
+    __serializedColorBrand: void;
 };
 interface CopyColorReturn {
     [SerializationType.NONE]: Color;
     [SerializationType.SERIALIZE]: SerializedColor;
     [SerializationType.DESERIALIZE]: Color;
 }
+/**
+ * @category color
+ */
 export declare function colorEquals(color1: Color, color2: Color): boolean;
 /**
  * Helper function to copy a `Color` object.
@@ -16,16 +19,27 @@ export declare function colorEquals(color1: Color, color2: Color): boolean;
  * @param color The Color object to copy. In the case of deserialization, this will actually be a
  *              Lua table instead of an instantiated Color class.
  * @param serializationType Default is `SerializationType.NONE`.
+ * @category color
  */
 export declare function copyColor<C extends Color | SerializedColor, S extends SerializationType>(color: C, serializationType: S): CopyColorReturn[S];
 export declare function copyColor<C extends Color | SerializedColor>(color: C): CopyColorReturn[SerializationType.NONE];
-/** Returns `Color(1, 1, 1)`. */
+/**
+ * Returns `Color(1, 1, 1)`.
+ *
+ * @category color
+ */
 export declare function getDefaultColor(): Color;
-/** Helper function to check if something is an instantiated Color object. */
+/**
+ * Helper function to check if something is an instantiated Color object.
+ *
+ * @category color
+ */
 export declare function isColor(object: unknown): object is Color;
 /**
  * Used to determine is the given table is a serialized `Color` object created by the save data
  * manager and/or the `deepCopy` function.
+ *
+ * @category color
  */
 export declare function isSerializedColor(object: unknown): object is SerializedColor;
 export {};

package/{dist/functions → functions}/entitySpecific.d.ts

@@ -1,4 +1,4 @@
-import { BombVariant, EffectVariant, EntityType, FamiliarVariant, KnifeVariant, LaserVariant, PickupVariant, ProjectileVariant, SlotVariant, TearVariant } from "isaac-typescript-definitions";
+import { BombVariant, EffectVariant, EntityType, FamiliarVariant, KnifeVariant, LaserVariant, PickupVariant, ProjectilesMode, ProjectileVariant, SlotVariant, TearVariant } from "isaac-typescript-definitions";
 /**
  * Helper function to get all of the `EntityType.BOMB` in the room.
  *
@@ -118,6 +118,20 @@ export declare function getSlots(slotVariant?: SlotVariant, subType?: number): E
  * ```
  */
 export declare function getTears(tearVariant?: TearVariant, subType?: number): EntityTear[];
+/**
+ * The base game `EntityNPC.FireProjectiles` method does not return anything, which is a problem in
+ * situations where you need to work with the fired projectiles. This function invokes that method,
+ * and then returns the projectiles that were spawned.
+ *
+ * @param npc The EntityNPC firing projectiles.
+ * @param position The starting position of the projectiles.
+ * @param velocity The starting velocity of the projectiles.
+ * @param projectilesMode A ProjectilesMode enum value defining how to fire the projectiles.
+ * @param projectileParams A ProjectileParams object containing various parameters for the
+ *                         projectiles.
+ * @returns An array of EntityProjectiles containing all fired projectiles.
+ */
+export declare function npcFireProjectiles(npc: EntityNPC, position: Vector, velocity: Vector, projectilesMode: ProjectilesMode, projectileParams: ProjectileParams): EntityProjectile[];
 /**
  * Helper function to remove all of the `EntityType.BOMB` in the room.
  *

package/{dist/functions → functions}/entitySpecific.lua

@@ -5,6 +5,7 @@ local ____constants = require("constants")
 local VectorZero = ____constants.VectorZero
 local ____entity = require("functions.entity")
 local getEntities = ____entity.getEntities
+local getFilteredNewEntities = ____entity.getFilteredNewEntities
 local removeEntities = ____entity.removeEntities
 local spawn = ____entity.spawn
 function ____exports.getBombs(self, bombVariant, subType)
@@ -173,6 +174,13 @@ function ____exports.getTears(self, tearVariant, subType)
     end
     return tears
 end
+function ____exports.npcFireProjectiles(self, npc, position, velocity, projectilesMode, projectileParams)
+    local oldEntities = ____exports.getProjectiles(nil)
+    npc:FireProjectiles(position, velocity, projectilesMode, projectileParams)
+    local newEntities = ____exports.getProjectiles(nil)
+    local filteredNewEntities = getFilteredNewEntities(nil, oldEntities, newEntities)
+    return filteredNewEntities
+end
 function ____exports.removeAllBombs(self, bombVariant, subType, cap)
     local bombs = ____exports.getBombs(nil, bombVariant, subType)
     return removeEntities(nil, bombs, cap)

package/{dist/functions → functions}/gridEntity.d.ts

@@ -138,7 +138,7 @@ export declare function spawnGiantPoop(topLeftGridIndex: int): void;
  * - removes existing grid entities on the same tile, if any
  * - allows you to specify either the grid index or the position
  */
-export declare function spawnGrid(gridEntityType: GridEntityType, gridIndexOrPosition: int): GridEntity | undefined;
+export declare function spawnGrid(gridEntityType: GridEntityType, gridIndexOrPosition: int | Vector): GridEntity | undefined;
 /**
  * Helper function to spawn a grid entity with a specific variant.
  *
@@ -147,7 +147,7 @@ export declare function spawnGrid(gridEntityType: GridEntityType, gridIndexOrPos
  * - removes existing grid entities on the same tile, if any
  * - allows you to specify the grid index or the position
  */
-export declare function spawnGridWithVariant(gridEntityType: GridEntityType, variant: int, gridIndexOrPosition: int): GridEntity | undefined;
+export declare function spawnGridWithVariant(gridEntityType: GridEntityType, variant: int, gridIndexOrPosition: int | Vector): GridEntity | undefined;
 /**
  * Helper function to spawn a Void Portal. This is more complicated than simply spawning a trapdoor
  * with the appropriate variant, as the game does not give it the correct sprite automatically.

package/{dist/functions → functions}/kColor.d.ts

@@ -2,7 +2,7 @@
 /// <reference types="typescript-to-lua/language-extensions" />
 import { SerializationType } from "../enums/SerializationType";
 declare type SerializedKColor = LuaTable<string, unknown> & {
-    __serializedKColorBrand: unknown;
+    __serializedKColorBrand: void;
 };
 interface CopyKColorReturn {
     [SerializationType.NONE]: KColor;

package/{dist/functions → functions}/rng.d.ts

@@ -2,7 +2,7 @@
 /// <reference types="typescript-to-lua/language-extensions" />
 import { SerializationType } from "../enums/SerializationType";
 declare type SerializedRNG = LuaTable<string, unknown> & {
-    __serializedRNGBrand: unknown;
+    __serializedRNGBrand: void;
 };
 interface CopyRNGReturn {
     [SerializationType.NONE]: RNG;

package/{dist/functions → functions}/trinkets.d.ts

@@ -65,9 +65,9 @@ export declare function isGoldenTrinket(trinketType: TrinketType): boolean;
  *
  * @param trinket The trinket whose sprite you want to modify.
  * @param pngPath Equal to either the spritesheet path to load (e.g.
- *                "gfx/items/collectibles/collectibles_001_thesadonion.png") or undefined. If
- *                undefined, the sprite will be removed, making it appear like the collectible has
- *                already been taken by the player.
+ *                "gfx/items/trinkets/trinket_001_swallowedpenny.png") or undefined. If undefined,
+ *                the sprite will be removed, making it appear like the collectible has already been
+ *                taken by the player.
  */
 export declare function setTrinketSprite(trinket: EntityPickup, pngPath: string | undefined): void;
 export declare function trinketHasCacheFlag(trinketType: TrinketType, cacheFlag: CacheFlag): boolean;

package/{dist/functions → functions}/vector.d.ts

@@ -2,7 +2,7 @@
 import { Direction } from "isaac-typescript-definitions";
 import { SerializationType } from "../enums/SerializationType";
 declare type SerializedVector = LuaTable<string, unknown> & {
-    __serializedVectorBrand: unknown;
+    __serializedVectorBrand: void;
 };
 interface CopyVectorReturn {
     [SerializationType.NONE]: Vector;

package/{dist/index.d.ts → index.d.ts}

@@ -11,7 +11,7 @@ export * from "./enums/PocketItemType";
 export * from "./enums/SerializationType";
 export { registerCharacterHealthConversion } from "./features/characterHealthConversion";
 export { registerCharacterStats } from "./features/characterStats";
-export { setBombDisplay, setEffectDisplay, setFamiliarDisplay, setKnifeDisplay, setLaserDisplay, setNPCDisplay, setPickupDisplay, setPlayerDisplay, setProjectileDisplay, setSlotDisplay, setTearDisplay, } from "./features/debugDisplay";
+export * from "./features/debugDisplay/exports";
 export { deployJSONRoom, deployRandomJSONRoom, emptyRoom, } from "./features/deployJSONRoom";
 export { disableAllInputs, disableAllInputsExceptFor, disableMovementInputs, disableShootingInputs, enableAllInputs, enableAllInputsExceptFor, } from "./features/disableInputs";
 export { disableAllSound, enableAllSound } from "./features/disableSound";

package/{dist/index.lua → index.lua}

@@ -96,29 +96,12 @@ do
     ____exports.registerCharacterStats = registerCharacterStats
 end
 do
-    local ____debugDisplay = require("features.debugDisplay")
-    local setBombDisplay = ____debugDisplay.setBombDisplay
-    local setEffectDisplay = ____debugDisplay.setEffectDisplay
-    local setFamiliarDisplay = ____debugDisplay.setFamiliarDisplay
-    local setKnifeDisplay = ____debugDisplay.setKnifeDisplay
-    local setLaserDisplay = ____debugDisplay.setLaserDisplay
-    local setNPCDisplay = ____debugDisplay.setNPCDisplay
-    local setPickupDisplay = ____debugDisplay.setPickupDisplay
-    local setPlayerDisplay = ____debugDisplay.setPlayerDisplay
-    local setProjectileDisplay = ____debugDisplay.setProjectileDisplay
-    local setSlotDisplay = ____debugDisplay.setSlotDisplay
-    local setTearDisplay = ____debugDisplay.setTearDisplay
-    ____exports.setBombDisplay = setBombDisplay
-    ____exports.setEffectDisplay = setEffectDisplay
-    ____exports.setFamiliarDisplay = setFamiliarDisplay
-    ____exports.setKnifeDisplay = setKnifeDisplay
-    ____exports.setLaserDisplay = setLaserDisplay
-    ____exports.setNPCDisplay = setNPCDisplay
-    ____exports.setPickupDisplay = setPickupDisplay
-    ____exports.setPlayerDisplay = setPlayerDisplay
-    ____exports.setProjectileDisplay = setProjectileDisplay
-    ____exports.setSlotDisplay = setSlotDisplay
-    ____exports.setTearDisplay = setTearDisplay
+    local ____export = require("features.debugDisplay.exports")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
 end
 do
     local ____deployJSONRoom = require("features.deployJSONRoom")