isaacscript-common 9.19.0 → 9.19.3

package/dist/index.d.ts

@@ -170,6 +170,7 @@ declare interface AddCallbackParameterCustom {
     [ModCallbackCustom.POST_TRINKET_BREAK]: PostTrinketBreakRegisterParameters;
     [ModCallbackCustom.PRE_BERSERK_DEATH]: PreBerserkDeathRegisterParameters;
     [ModCallbackCustom.PRE_CUSTOM_REVIVE]: PreCustomReviveRegisterParameters;
+    [ModCallbackCustom.PRE_GET_PEDESTAL]: PreGetPedestalRegisterParameters;
     [ModCallbackCustom.PRE_ITEM_PICKUP]: PreItemPickupRegisterParameters;
     [ModCallbackCustom.PRE_NEW_LEVEL]: PreNewLevelRegisterParameters;
 }
@@ -2261,6 +2262,13 @@ export declare function forceNewLevelCallback(): void;
  */
 export declare function forceNewRoomCallback(): void;
 
+/**
+ * Helper function for non-TypeScript users to iterate over an array.
+ *
+ * Internally, this just calls `array.forEach`.
+ */
+export declare function forEach<T>(array: T[], func: (value: T, index: number, array: T[]) => void): void;
+
 /**
  * When used on The Forgotten, switches to The Soul. When used on The Soul, switches to The
  * Forgotten. This takes 1 game frame to take effect.
@@ -3402,6 +3410,13 @@ export declare function getHUDOffsetVector(): Vector;
  */
 export declare function getIsaacAPIClassName(object: unknown): string | undefined;
 
+/**
+ * Helper function to get the current version of the `isaacscript-common` library, according to the
+ * "package.json" file at the time of compilation. (The version is in the Semantic Versioning
+ * format, e.g. "1.0.0".)
+ */
+export declare function getIsaacScriptCommonVersion(): string;
+
 export declare function getItemConfigCardType(cardType: CardType): ItemConfigCardType;
 
 /**
@@ -6094,6 +6109,10 @@ export declare function isLRoom(roomShape: RoomShape): boolean;
  *
  * This function uses the `package` global variable as a proxy to determine if the "--luadebug" flag
  * is enabled or not.
+ *
+ * Note that this function will return false if the Racing+ sandbox is enabled, even if the
+ * "--luadebug" flag is really turned on. If checking for this case is needed, check for the
+ * presence of the `sandboxGetTraceback` function.
  */
 export declare function isLuaDebugEnabled(): boolean;
 
@@ -8320,6 +8339,25 @@ export declare enum ModCallbackCustom {
      * ```
      */
     PRE_CUSTOM_REVIVE = 90,
+    /**
+     * Fires from the `PRE_PICKUP_COLLISION` callback when a player touches a collectible pedestal and
+     * meets all of the conditions to pick it up.
+     *
+     * The return values of this callback are the same as the `PRE_PICKUP_COLLISION` callback. For
+     * example, you can prevent a player from picking up the collectible by returning false. (However,
+     * note that this callback will continue to fire for every frame that the player touches the
+     * pedestal, so you would need to continue returning false.)
+     *
+     * - When registering the callback, takes an optional second argument that will make the callback
+     *   only fire if the player matches the `PlayerVariant` provided.
+     * - When registering the callback, takes an optional third argument that will make the callback
+     *   only fire if the player matches the `PlayerType` provided.
+     *
+     * ```ts
+     * function preGetPedestal(player: EntityPlayer, collectible: EntityPickupCollectible): void {}
+     * ```
+     */
+    PRE_GET_PEDESTAL = 91,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` callback when an item becomes queued (i.e. when the player
      * begins to hold the item above their head).
@@ -8338,7 +8376,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    PRE_ITEM_PICKUP = 91,
+    PRE_ITEM_PICKUP = 92,
     /**
      * Fires on the `POST_RENDER` frame before the player is taken to a new floor. Only fires when a
      * player jumps into a trapdoor or enters a heaven door (beam of light). Does not fire on the
@@ -8352,7 +8390,7 @@ export declare enum ModCallbackCustom {
      * function preNewLevel(player: EntityPlayer): void {}
      * ```
      */
-    PRE_NEW_LEVEL = 92
+    PRE_NEW_LEVEL = 93
 }
 
 /**
@@ -9192,6 +9230,12 @@ playerVariant?: PlayerVariant,
 character?: PlayerType
 ];
 
+declare type PreGetPedestalRegisterParameters = [
+callback: (player: EntityPlayer, collectible: EntityPickupCollectible) => boolean | undefined,
+playerVariant?: PlayerVariant,
+character?: PlayerType
+];
+
 declare type PreItemPickupRegisterParameters = [callback: (player: EntityPlayer, pickingUpItem: PickingUpItem) => void] | [
 callback: (player: EntityPlayer, pickingUpItem: PickingUpItemCollectible) => void,
 itemType: ItemType.PASSIVE | ItemType.ACTIVE | ItemType.FAMILIAR,
@@ -11013,6 +11057,14 @@ export declare function smeltTrinket(player: EntityPlayer, trinketType: TrinketT
  */
 export declare function smeltTrinkets(player: EntityPlayer, ...trinketTypes: TrinketType[]): void;
 
+/**
+ * Helper function for non-TypeScript users to check if one or more elements in the array is equal
+ * to a condition.
+ *
+ * Internally, this just calls `array.some`.
+ */
+export declare function some<T>(array: T[], func: (value: T, index: number, array: T[]) => boolean): boolean;
+
 export declare type SoulHeartType = HeartSubType.SOUL | HeartSubType.BLACK | HeartSubType.BONE;
 
 /**
@@ -11889,7 +11941,7 @@ export declare type TSTLClass = LuaMap<AnyNotNil, unknown> & {
  * From:
  * https://stackoverflow.com/questions/16096872/how-to-sort-2-dimensional-array-by-column-value
  */
-export declare function twoDimensionalSort<T>(a: T[], b: T[]): -1 | 0 | 1;
+export declare function twoDimensionalSort<T>(array1: T[], array2: T[]): -1 | 0 | 1;
 
 /**
  * This is the number of draw coordinates that each heart spans on the UI in the upper left hand