isaacscript-common 15.6.1 → 16.0.0

package/dist/index.d.ts

@@ -1363,7 +1363,7 @@ export declare function combineSets<T>(...sets: Array<Set<T> | ReadonlySet<T>>):
  * Helper function to get the enum name for the specified `Controller` value. Note that this will
  * trim off the "BUTTON_" prefix.
  */
-export declare function controllerToString(controller: Controller): string | undefined;
+export declare function controllerToString(controller: Controller): string;
 
 /**
  * This is the type that is fed to `registerCharacterHealthConversion` helper function to signify
@@ -1501,8 +1501,8 @@ declare abstract class CustomCallback<T extends ModCallbackCustom> extends Featu
 
 declare class CustomGridEntities extends Feature {
     private runInNFrames;
-    private postNewRoom;
     private preUseItemWeNeedToGoDeeper;
+    private postNewRoomReordered;
     /**
      * Helper function to spawn a custom grid entity. Custom grid entities are persistent in that they
      * will reappear if the player leaves and re-enters the room. (It will be manually respawned in
@@ -1804,7 +1804,7 @@ declare class CustomRevive extends Feature {
     private postRender;
     private postPEffectUpdate;
     private checkWaitingForItemAnimation;
-    private postNewRoom;
+    private postNewRoomReordered;
     private postPlayerFatalDamage;
     private preBerserkDeath;
     /**
@@ -4865,7 +4865,7 @@ export declare function getHearts(heartSubType?: HeartSubType): EntityPickupHear
 /**
  * Helper function to get the width of the first player's hearts on the UI. This is useful for
  * drawing UI elements to the right of where the player's hearts are. Make sure to use this in
- * combination with the the `getHUDOffsetVector` helper function.
+ * combination with the `getHUDOffsetVector` helper function.
  */
 export declare function getHeartsUIWidth(): int;
 
@@ -5268,9 +5268,9 @@ export declare function getPillEffectName(pillEffect: PillEffect): string;
 
 /**
  * Helper function to get a pill effect type from a PillEffect enum value. In this context, the type
- * is equal to positive, negative, or neutral. This is derived from the suffix of the the "class"
- * tag in the "pocketitems.xml" file. Use the `getPillEffectClass` helper function to determine the
- * "power" of the pill.
+ * is equal to positive, negative, or neutral. This is derived from the suffix of the "class" tag in
+ * the "pocketitems.xml" file. Use the `getPillEffectClass` helper function to determine the "power"
+ * of the pill.
  *
  * Due to limitations in the API, this function will not work properly for modded pill effects, and
  * will always return `DEFAULT_PILL_EFFECT_TYPE` in those cases.
@@ -6613,7 +6613,7 @@ declare class GridEntityUpdateDetection extends Feature {
     private checkGridEntityStateChanged;
     private checkNewGridEntity;
     private updateTupleInMap;
-    private postNewRoom;
+    private postNewRoomReordered;
 }
 
 /**
@@ -10974,6 +10974,11 @@ export declare class ModUpgradedBase implements Mod {
      * don't have access to it..
      */
     private initOptionalFeature;
+    /**
+     * This is mostly the same as the `AddCustomCallback` method, but we initialize the custom
+     * callback without actually registering a subscription.
+     */
+    private initCustomCallbackEarly;
 }
 
 export declare const MOVEMENT_ACTIONS_SET: ReadonlySet<ButtonAction>;
@@ -11322,7 +11327,8 @@ export declare type PickupIndex = int & {
 declare class PickupIndexCreation extends Feature {
     private roomHistory;
     private postPickupInit;
-    private trySetPickupIndex;
+    private setPickupIndex;
+    private getPickupIndexFromPreviousData;
     private postEntityRemovePickup;
     private checkDespawningFromPlayerLeavingRoom;
     /**
@@ -11330,7 +11336,6 @@ declare class PickupIndexCreation extends Feature {
      * Keep track of the metadata for later.
      */
     private trackDespawningPickupMetadata;
-    private postNewRoomReordered;
     private getPostAscentPickupIndex;
     /**
      * Mods often have to track variables relating to a pickups. Finding an index for these kinds of
@@ -12561,8 +12566,8 @@ declare class RoomHistory extends Feature {
     /**
      * Helper function to detect if the game is in the state where the room index has changed to a new
      * room, but the entities from the previous room are currently in the process of despawning. (At
-     * this point, the `POST_NEW_ROOM` callback will not have fired yet, and there will not be an
-     * entry in the room history array for the current room.)
+     * this point, the `POST_NEW_ROOM` callback and the `POST_NEW_ROOM_EARLY` callback will not have
+     * fired yet, and there will not be an entry in the room history array for the current room.)
      *
      * This function is intended to be used in the `POST_ENTITY_REMOVE` callback to detect when an
      * entity is despawning.
@@ -14434,6 +14439,14 @@ export declare type UnionToIntersection<U> = (U extends U ? (u: U) => 0 : never)
  * @param modVanilla The mod object returned by the `RegisterMod` function.
  * @param features Optional. An array containing the optional standard library features that you
  *                 want to enable, if any. Default is an empty array.
+ * @param customCallbacksUsed Optional. An array containing the custom callbacks that you will be
+ *                            subscribing to after you upgrade your mod. Specifying this will
+ *                            immediately initialize the callbacks (as opposed to lazy-initializing
+ *                            them when you first subscribe to the callback). This is only necessary
+ *                            if you the order of callback firing is important for your mod. (For
+ *                            example, you may want the `POST_NEW_ROOM` part of the
+ *                            `POST_GRID_ENTITY_INIT` callback to fire before your own
+ *                            `POST_NEW_ROOM` callbacks.)
  * @param debug Optional. Whether to log additional output when a callback is fired. Default is
  *              false.
  * @param timeThreshold Optional. If provided, will only log callbacks that take longer than the
@@ -14441,7 +14454,7 @@ export declare type UnionToIntersection<U> = (U extends U ? (u: U) => 0 : never)
  *                      or milliseconds (if the "--luadebug" launch flag is turned off).
  * @returns The upgraded mod object.
  */
-export declare function upgradeMod<T extends readonly ISCFeature[] = never[]>(modVanilla: Mod, features?: ISCFeatureTuple<T>, debug?: boolean, timeThreshold?: float): ModUpgraded<T>;
+export declare function upgradeMod<T extends readonly ISCFeature[] = never[]>(modVanilla: Mod, features?: ISCFeatureTuple<T>, customCallbacksUsed?: ModCallbackCustom[] | readonly ModCallbackCustom[], debug?: boolean, timeThreshold?: float): ModUpgraded<T>;
 
 /** Helper type to match all of the uppercase keys of an object. */
 export declare type UppercaseKeys<T> = StartsWithUppercase<keyof T>;
@@ -14505,6 +14518,12 @@ export declare function validateEnumContiguous<T>(transpiledEnumName: string, tr
  */
 export declare function validateInterfaceMatchesEnum<T extends Record<Enum, unknown>, Enum extends string | number>(): void;
 
+/**
+ * Helper function to compare two vectors for equality.
+ *
+ * This function is useful because vectors are not directly comparable. In other words, `Vector(1.2)
+ * === Vector(1.2)` will be equal to false.
+ */
 export declare function vectorEquals(vector1: Vector, vector2: Vector): boolean;
 
 /**