isaacscript-common 75.2.1 → 76.0.0

package/dist/index.rollup.d.ts

@@ -3588,7 +3588,6 @@ export declare function deleteSetsFromSet<T>(mainSet: Set<T>, ...setsToRemove: A
 
 declare class DeployJSONRoom extends Feature {
     private readonly preventGridEntityRespawn;
-    private readonly spawnCollectible;
     private spawnAllEntities;
     private spawnNormalEntityForJSONRoom;
     /**
@@ -9000,20 +8999,18 @@ export declare enum ISCFeature {
     PONY_DETECTION = 41,
     PRESS_INPUT = 42,
     PREVENT_CHILD_ENTITIES = 43,
-    PREVENT_COLLECTIBLE_ROTATION = 44,
-    PREVENT_GRID_ENTITY_RESPAWN = 45,
-    ROOM_CLEAR_FRAME = 46,
-    ROOM_HISTORY = 47,
-    RUN_IN_N_FRAMES = 48,
-    RUN_NEXT_ROOM = 49,
-    RUN_NEXT_RUN = 50,
-    SAVE_DATA_MANAGER = 51,
-    SPAWN_ALT_ROCK_REWARDS = 52,
-    SPAWN_COLLECTIBLE = 53,
-    STAGE_HISTORY = 54,
-    START_AMBUSH = 55,
-    TAINTED_LAZARUS_PLAYERS = 56,
-    UNLOCK_ACHIEVEMENTS_DETECTION = 57
+    PREVENT_GRID_ENTITY_RESPAWN = 44,
+    ROOM_CLEAR_FRAME = 45,
+    ROOM_HISTORY = 46,
+    RUN_IN_N_FRAMES = 47,
+    RUN_NEXT_ROOM = 48,
+    RUN_NEXT_RUN = 49,
+    SAVE_DATA_MANAGER = 50,
+    SPAWN_ALT_ROCK_REWARDS = 51,
+    STAGE_HISTORY = 52,
+    START_AMBUSH = 53,
+    TAINTED_LAZARUS_PLAYERS = 54,
+    UNLOCK_ACHIEVEMENTS_DETECTION = 55
 }
 
 /**
@@ -9067,7 +9064,6 @@ declare interface ISCFeatureToClass {
     [ISCFeature.PONY_DETECTION]: PonyDetection;
     [ISCFeature.PRESS_INPUT]: PressInput;
     [ISCFeature.PREVENT_CHILD_ENTITIES]: PreventChildEntities;
-    [ISCFeature.PREVENT_COLLECTIBLE_ROTATION]: PreventCollectibleRotation;
     [ISCFeature.PREVENT_GRID_ENTITY_RESPAWN]: PreventGridEntityRespawn;
     [ISCFeature.ROOM_CLEAR_FRAME]: RoomClearFrame;
     [ISCFeature.ROOM_HISTORY]: RoomHistory;
@@ -9076,7 +9072,6 @@ declare interface ISCFeatureToClass {
     [ISCFeature.RUN_NEXT_RUN]: RunNextRun;
     [ISCFeature.SAVE_DATA_MANAGER]: SaveDataManager;
     [ISCFeature.SPAWN_ALT_ROCK_REWARDS]: SpawnRockAltRewards;
-    [ISCFeature.SPAWN_COLLECTIBLE]: SpawnCollectible;
     [ISCFeature.STAGE_HISTORY]: StageHistory;
     [ISCFeature.START_AMBUSH]: StartAmbush;
     [ISCFeature.TAINTED_LAZARUS_PLAYERS]: TaintedLazarusPlayers;
@@ -15511,31 +15506,14 @@ declare class PreventChildEntities extends Feature {
     preventChildEntities(entity: Entity): void;
 }
 
-declare class PreventCollectibleRotation extends Feature {
-    private readonly pickupIndexCreation;
-    private readonly runInNFrames;
-    private readonly preUseItem;
-    /**
-     * Soul of Isaac causes items to flip. We assume that the player deliberately wants to roll a
-     * quest item, so we delete all tracked items in the current room.
-     */
-    private readonly postUseCardSoulOfIsaac;
-    private readonly postDiceRoomActivated;
-    private readonly postPickupChanged;
-    /**
-     * Helper function to prevent a collectible from being affected by Tainted Isaac's rotation
-     * mechanic. (This mechanic also happens from Glitched Crown and Binge Eater.) This is useful
-     * because quest items that are manually spawned by mods will be automatically be affected by this
-     * mechanic.
-     *
-     * It is required to pass the intended collectible type to this function since it is possible for
-     * collectibles to rotate on the first frame that they are spawned.
-     *
-     * In order to use this function, you must upgrade your mod with
-     * `ISCFeature.PREVENT_COLLECTIBLE_ROTATION`.
-     */
-    preventCollectibleRotation(collectible: EntityPickup, collectibleType: CollectibleType): void;
-}
+/**
+ * Helper function to remove the rotation behavior from a collectible. This will happen by default
+ * when collectibles are spawned when playing as Tainted Isaac or when having Binge Eater.
+ *
+ * Under the hood, this is accomplished by morphing the collectible with the `ignoreModifiers`
+ * argument set to true.
+ */
+export declare function preventCollectibleRotation(collectible: EntityPickup): void;
 
 declare class PreventGridEntityRespawn extends Feature {
     private readonly runInNFrames;
@@ -17771,71 +17749,12 @@ export declare function spawnCoin(coinSubType: CoinSubType, positionOrGridIndex:
  */
 export declare function spawnCoinWithSeed(coinSubType: CoinSubType, positionOrGridIndex: Vector | int, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityPickupCoin;
 
-declare class SpawnCollectible extends Feature {
-    private readonly preventCollectibleRotation;
-    /**
-     * Helper function to spawn a collectible.
-     *
-     * Use this instead of the `Game.Spawn` method because it handles the cases of Tainted Keeper
-     * collectibles costing coins and preventing quest items from being rotated by Tainted Isaac's
-     * rotation mechanic.
-     *
-     * If you do not need to handle quest items being rotated (i.e. the collectible is guaranteed not
-     * to be a quest item), then you can use the `spawnCollectibleUnsafe` helper function instead
-     * (which does not require an upgraded mod).
-     *
-     * If you want to spawn an unseeded collectible, you must explicitly pass `undefined` to the
-     * `seedOrRNG` parameter.
-     *
-     * In order to use this function, you must upgrade your mod with `ISCFeature.SPAWN_COLLECTIBLE`.
-     *
-     * @param collectibleType The collectible type to spawn.
-     * @param positionOrGridIndex The position or grid index to spawn the collectible at.
-     * @param seedOrRNG The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
-     *                  `RNG.Next` method will be called. If `undefined` is provided, it will default
-     *                  to a random seed.
-     * @param options Optional. Set to true to make the collectible a "There's Options" style
-     *                collectible. Default is false.
-     * @param forceFreeItem Optional. Set to true to disable the logic that gives the item a price for
-     *                      Tainted Keeper. Default is false.
-     * @param spawner Optional.
-     */
-    spawnCollectible(collectibleType: CollectibleType, positionOrGridIndex: Vector | int, seedOrRNG: Seed | RNG | undefined, options?: boolean, forceFreeItem?: boolean, spawner?: Entity): EntityPickupCollectible;
-    /**
-     * Helper function to spawn a collectible from a specific item pool.
-     *
-     * Use this instead of the `Game.Spawn` method because it handles the cases of Tainted Keeper
-     * collectibles costing coins and preventing quest items from being rotated by Tainted Isaac's
-     * rotation mechanic.
-     *
-     * If you want to spawn an unseeded collectible, you must explicitly pass `undefined` to the
-     * `seedOrRNG` parameter.
-     *
-     * In order to use this function, you must upgrade your mod with `ISCFeature.SPAWN_COLLECTIBLE`.
-     *
-     * @param itemPoolType The item pool to draw the collectible type from.
-     * @param positionOrGridIndex The position or grid index to spawn the collectible at.
-     * @param seedOrRNG The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
-     *                  `RNG.Next` method will be called. If `undefined` is provided, it will default
-     *                  to a random seed.
-     * @param options Optional. Set to true to make the collectible a "There's Options" style
-     *                collectible. Default is false.
-     * @param forceFreeItem Optional. Set to true to disable the logic that gives the item a price for
-     *                      Tainted Keeper. Default is false.
-     * @param spawner Optional.
-     */
-    spawnCollectibleFromPool(itemPoolType: ItemPoolType, positionOrGridIndex: Vector | int, seedOrRNG: Seed | RNG | undefined, options?: boolean, forceFreeItem?: boolean, spawner?: Entity): EntityPickupCollectible;
-}
-
 /**
  * Helper function to spawn a collectible.
  *
  * Use this instead of the `Game.Spawn` method because it handles the cases of Tainted Keeper
- * collectibles costing coins.
- *
- * This function is unsafe because it will not correctly handle quest items being rotated by Tainted
- * Isaac's rotation mechanic. To handle that, use the `spawnCollectible` helper function instead
- * (which is provided by `ISCFeature.SPAWN_COLLECTIBLE`).
+ * collectibles costing coins and prevents quest items from being rotated by Tainted Isaac's
+ * rotation mechanic.
  *
  * If you want to spawn an unseeded collectible, you must explicitly pass `undefined` to the
  * `seedOrRNG` parameter.
@@ -17851,7 +17770,32 @@ declare class SpawnCollectible extends Feature {
  *                      Tainted Keeper. Default is false.
  * @param spawner Optional.
  */
-export declare function spawnCollectibleUnsafe(collectibleType: CollectibleType, positionOrGridIndex: Vector | int, seedOrRNG: Seed | RNG | undefined, options?: boolean, forceFreeItem?: boolean, spawner?: Entity): EntityPickupCollectible;
+export declare function spawnCollectible(collectibleType: CollectibleType, positionOrGridIndex: Vector | int, seedOrRNG: Seed | RNG | undefined, options?: boolean, forceFreeItem?: boolean, spawner?: Entity): EntityPickupCollectible;
+
+/**
+ * Helper function to spawn a collectible from a specific item pool.
+ *
+ * Use this instead of the `Game.Spawn` method because it handles the cases of Tainted Keeper
+ * collectibles costing coins and prevents quest items from being rotated by Tainted Isaac's
+ * rotation mechanic.
+ *
+ * If you want to spawn an unseeded collectible, you must explicitly pass `undefined` to the
+ * `seedOrRNG` parameter.
+ *
+ * In order to use this function, you must upgrade your mod with `ISCFeature.SPAWN_COLLECTIBLE`.
+ *
+ * @param itemPoolType The item pool to draw the collectible type from.
+ * @param positionOrGridIndex The position or grid index to spawn the collectible at.
+ * @param seedOrRNG The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+ *                  `RNG.Next` method will be called. If `undefined` is provided, it will default to
+ *                  a random seed.
+ * @param options Optional. Set to true to make the collectible a "There's Options" style
+ *                collectible. Default is false.
+ * @param forceFreeItem Optional. Set to true to disable the logic that gives the item a price for
+ *                      Tainted Keeper. Default is false.
+ * @param spawner Optional.
+ */
+export declare function spawnCollectibleFromPool(itemPoolType: ItemPoolType, positionOrGridIndex: Vector | int, seedOrRNG: Seed | RNG | undefined, options?: boolean, forceFreeItem?: boolean, spawner?: Entity): EntityPickupCollectible;
 
 /** Helper function to spawn a `GridEntityType.CRAWL_SPACE` (18). */
 export declare function spawnCrawlSpace(gridIndexOrPosition: int | Vector): GridEntity | undefined;