isaacscript-common 20.2.0 → 20.3.1

package/dist/index.d.ts

@@ -579,6 +579,12 @@ declare interface AddCallbackParametersCustom {
     variant?: int,
     subType?: int
     ];
+    [ModCallbackCustom.PRE_ROOM_ENTITY_SPAWN_FILTER]: [
+    callback: (entityTypeOrGridEntityXMLType: EntityType | GridEntityXMLType, variant: int, subType: int, gridIndex: int, seed: Seed) => [EntityType | GridEntityXMLType, int, int] | undefined,
+    entityTypeOrGridEntityXMLType?: EntityType | GridEntityXMLType,
+    variant?: int,
+    subType?: int
+    ];
 }
 
 /**
@@ -1102,7 +1108,7 @@ export declare const CARD_NAME_TO_TYPE_MAP: ReadonlyMap<string, CardType>;
 export declare function changeRoom(roomGridIndex: int): void;
 
 /** Maps character names to the values of the `PlayerType` enum. */
-export declare const CHARACTER_NAME_TO_TYPE_MAP: Map<string, PlayerType>;
+export declare const CHARACTER_NAME_TO_TYPE_MAP: ReadonlyMap<string, PlayerType>;
 
 /**
  * Helper function to determine if the given character can have red heart containers. Returns true
@@ -1477,7 +1483,7 @@ export declare function copyRNG(rng: RNG): RNG;
 export declare function copySet<T>(oldSet: Set<T> | ReadonlySet<T>): Set<T>;
 
 /** Helper function to copy specific values from a userdata object (e.g. `Vector`) to a table. */
-export declare function copyUserdataValuesToTable(object: unknown, keys: string[], luaMap: LuaMap<string, unknown>): void;
+export declare function copyUserdataValuesToTable(object: unknown, keys: string[] | readonly string[], luaMap: LuaMap<string, unknown>): void;
 
 /** Helper function to copy a `Vector` Isaac API class. */
 export declare function copyVector(vector: Vector): Vector;
@@ -3565,8 +3571,8 @@ export declare type EntityID = string & {
  * - For example, `eRange(1, 3)` will return `[1, 2]`.
  * - For example, `eRange(2)` will return `[0, 1]`.
  *
- * @param start The number to start at.
- * @param end Optional. The number to end at. If not specified, then the start will be 0 and the
+ * @param start The integer to start at.
+ * @param end Optional. The integer to end at. If not specified, then the start will be 0 and the
  *            first argument will be the end.
  * @param increment Optional. The increment to use. Default is 1.
  */
@@ -5120,10 +5126,10 @@ export declare function getLastFrameOfAnimation(sprite: Sprite, animation?: stri
  * ]);
  * const searchText = "f";
  * const match = getMapPartialMatch(map, searchText); // match is now equal to ["foo", 123]
+ * ```
  *
  * @returns If a match was found, returns a tuple of the map key and value. If a match was not
- * found, returns undefined.
- * ```
+ *          found, returns undefined.
  */
 export declare function getMapPartialMatch<T>(searchText: string, map: ReadonlyMap<string, T>): [string, T] | undefined;
 
@@ -6813,15 +6819,17 @@ export declare enum HealthType {
  * Converts a hex string like "#33aa33" to a KColor object.
  *
  * @param hexString A hex string like "#ffffff" or "ffffff". (The "#" character is optional.)
+ * @param alpha Optional. Range is from 0 to 1. Default is 1. (The same as the `Color` constructor.)
  */
-export declare function hexToColor(hexString: string, alpha: float): Color;
+export declare function hexToColor(hexString: string, alpha?: number): Color;
 
 /**
  * Converts a hex string like "#33aa33" to a Color object.
  *
  * @param hexString A hex string like "#ffffff" or "ffffff". (The "#" character is optional.)
+ * @param alpha Range is from 0 to 1. Default is 1.
  */
-export declare function hexToKColor(hexString: string, alpha: float): KColor;
+export declare function hexToKColor(hexString: string, alpha?: number): KColor;
 
 /**
  * Helper type to make the given array/map/set/object recursively read-only.
@@ -7002,8 +7010,8 @@ export declare function inStartingRoom(): boolean;
  * - For example, `iRange(1, 3)` will return `[1, 2, 3]`.
  * - For example, `iRange(2)` will return `[0, 1, 2]`.
  *
- * @param start The number to start at.
- * @param end Optional. The number to end at. If not specified, then the start will be 0 and the
+ * @param start The integer to start at.
+ * @param end Optional. The integer to end at. If not specified, then the start will be 0 and the
  *            first argument will be the end.
  * @param increment Optional. The increment to use. Default is 1.
  */
@@ -7013,7 +7021,7 @@ export declare function iRange(start: int, end?: int, increment?: number): int[]
  * Helper function to check if an instantiated Isaac API class is equal to another one of the same
  * type. You must provide the list of keys to check for.
  */
-export declare function isaacAPIClassEquals(object1: unknown, object2: unknown, keys: string[]): boolean;
+export declare function isaacAPIClassEquals(object1: unknown, object2: unknown, keys: string[] | readonly string[]): boolean;
 
 declare interface IsaacAPIClassTypeToSerializedType {
     [CopyableIsaacAPIClassType.BIT_SET_128]: SerializedBitSet128;
@@ -8015,7 +8023,7 @@ export declare function isVanillaWallGridIndex(gridIndex: int): boolean;
 export declare function isVector(object: unknown): object is Vector;
 
 /** The set of all `ItemConfigCardType` values that are not a rune or special object. */
-export declare const ITEM_CONFIG_CARD_TYPES_FOR_CARDS: Set<ItemConfigCardType>;
+export declare const ITEM_CONFIG_CARD_TYPES_FOR_CARDS: ReadonlySet<ItemConfigCardType>;
 
 /**
  * A cached version of the class returned from the `Isaac.GetItemConfig()` constructor.
@@ -10409,12 +10417,14 @@ export declare enum ModCallbackCustom {
      *
      * ```ts
      * function preEntitySpawnFilter(
-     *   entity: Entity,
-     *   amount: float,
-     *   damageFlags: BitFlags<DamageFlag>,
-     *   source: EntityRef,
-     *   countdownFrames: int,
-     * ): boolean | undefined {}
+     *   entityType: EntityType,
+     *   variant: int,
+     *   subType: int,
+     *   position: Vector,
+     *   velocity: Vector,
+     *   spawner: Entity | undefined,
+     *   initSeed: Seed,
+     * ): [EntityType, int, int, int] | undefined {}
      * ```
      */
     PRE_ENTITY_SPAWN_FILTER = 102,
@@ -10509,7 +10519,30 @@ export declare enum ModCallbackCustom {
      * function preNPCUpdateFilter(entity: Entity): boolean | undefined {}
      * ```
      */
-    PRE_NPC_UPDATE_FILTER = 107
+    PRE_NPC_UPDATE_FILTER = 107,
+    /**
+     * The exact same thing as the vanilla `PRE_ROOM_ENTITY_SPAWN` callback, except this callback
+     * allows you to specify extra arguments for additional filtration.
+     *
+     * When registering the callback with the `ModUpgraded.AddCallbackCustom` method:
+     * - You can provide an optional third argument that will make the callback only fire if it
+     *   matches the `EntityType` or `GridEntityXMLType` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the variant provided.
+     * - You can provide an optional fifth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
+     *
+     * ```ts
+     * function preRoomEntitySpawnFilter(
+     *   entityTypeOrGridEntityXMLType: EntityType | GridEntityXMLType,
+     *   variant: int,
+     *   subType: int,
+     *   gridIndex: int,
+     *   seed: Seed,
+     * ): [EntityType | GridEntityXMLType, int, int] | undefined {}
+     * ```
+     */
+    PRE_ROOM_ENTITY_SPAWN_FILTER = 108
 }
 
 /**
@@ -11476,7 +11509,7 @@ export declare class ModUpgradedBase implements Mod {
     /**
      * Returns the names of the exported class methods from the features that were added. This is
      * called from the "upgradeMod" function, but we want to mark it as private so that end-users
-     * don't have access to it..
+     * don't have access to it.
      */
     private initOptionalFeature;
     /**
@@ -15064,7 +15097,7 @@ export declare function validateEnumContiguous<T>(transpiledEnumName: string, tr
  *
  * This function is only meant to be used with interfaces (i.e. types that will not exist at
  * run-time). If you are generating an object that will contain all of the keys of an enum, use the
- * `newObjectWithEnumKeys` helper function instead.
+ * `satisfies` operator with the `HasAllEnumValues` helper type instead.
  */
 export declare function validateInterfaceMatchesEnum<T extends Record<Enum, unknown>, Enum extends string | number>(): void;