isaacscript-common 20.3.2 → 20.4.1

package/dist/index.d.ts

@@ -7204,49 +7204,50 @@ export declare enum ISCFeature {
     ITEM_PICKUP_DETECTION = 7,
     PLAYER_COLLECTIBLE_DETECTION = 8,
     PLAYER_REORDERED_CALLBACKS = 9,
-    SLOT_RENDER_DETECTION = 10,
-    SLOT_UPDATE_DETECTION = 11,
-    CHARACTER_HEALTH_CONVERSION = 12,
-    CHARACTER_STATS = 13,
-    COLLECTIBLE_ITEM_POOL_TYPE = 14,
-    CUSTOM_GRID_ENTITIES = 15,
-    CUSTOM_ITEM_POOLS = 16,
-    CUSTOM_HOTKEYS = 17,
-    CUSTOM_PICKUPS = 18,
-    CUSTOM_STAGES = 19,
-    CUSTOM_TRAPDOORS = 20,
-    DEBUG_DISPLAY = 21,
-    DEPLOY_JSON_ROOM = 22,
-    DISABLE_ALL_SOUND = 23,
-    DISABLE_INPUTS = 24,
-    FADE_IN_REMOVER = 25,
-    FAST_RESET = 26,
-    FLYING_DETECTION = 27,
-    FORGOTTEN_SWITCH = 28,
-    EXTRA_CONSOLE_COMMANDS = 29,
-    ITEM_POOL_DETECTION = 30,
-    MODDED_ELEMENT_DETECTION = 31,
-    MODDED_ELEMENT_SETS = 32,
-    NO_SIREN_STEAL = 33,
-    PAUSE = 34,
-    PERSISTENT_ENTITIES = 35,
-    PICKUP_INDEX_CREATION = 36,
-    PLAYER_INVENTORY = 37,
-    PONY_DETECTION = 38,
-    PRESS_INPUT = 39,
-    PREVENT_CHILD_ENTITIES = 40,
-    PREVENT_COLLECTIBLE_ROTATION = 41,
-    PREVENT_GRID_ENTITY_RESPAWN = 42,
-    ROOM_CLEAR_FRAME = 43,
-    ROOM_HISTORY = 44,
-    RUN_IN_N_FRAMES = 45,
-    RUN_NEXT_ROOM = 46,
-    SAVE_DATA_MANAGER = 47,
-    SPAWN_ALT_ROCK_REWARDS = 48,
-    SPAWN_COLLECTIBLE = 49,
-    STAGE_HISTORY = 50,
-    START_AMBUSH = 51,
-    TAINTED_LAZARUS_PLAYERS = 52
+    SLOT_DESTROYED_DETECTION = 10,
+    SLOT_RENDER_DETECTION = 11,
+    SLOT_UPDATE_DETECTION = 12,
+    CHARACTER_HEALTH_CONVERSION = 13,
+    CHARACTER_STATS = 14,
+    COLLECTIBLE_ITEM_POOL_TYPE = 15,
+    CUSTOM_GRID_ENTITIES = 16,
+    CUSTOM_ITEM_POOLS = 17,
+    CUSTOM_HOTKEYS = 18,
+    CUSTOM_PICKUPS = 19,
+    CUSTOM_STAGES = 20,
+    CUSTOM_TRAPDOORS = 21,
+    DEBUG_DISPLAY = 22,
+    DEPLOY_JSON_ROOM = 23,
+    DISABLE_ALL_SOUND = 24,
+    DISABLE_INPUTS = 25,
+    FADE_IN_REMOVER = 26,
+    FAST_RESET = 27,
+    FLYING_DETECTION = 28,
+    FORGOTTEN_SWITCH = 29,
+    EXTRA_CONSOLE_COMMANDS = 30,
+    ITEM_POOL_DETECTION = 31,
+    MODDED_ELEMENT_DETECTION = 32,
+    MODDED_ELEMENT_SETS = 33,
+    NO_SIREN_STEAL = 34,
+    PAUSE = 35,
+    PERSISTENT_ENTITIES = 36,
+    PICKUP_INDEX_CREATION = 37,
+    PLAYER_INVENTORY = 38,
+    PONY_DETECTION = 39,
+    PRESS_INPUT = 40,
+    PREVENT_CHILD_ENTITIES = 41,
+    PREVENT_COLLECTIBLE_ROTATION = 42,
+    PREVENT_GRID_ENTITY_RESPAWN = 43,
+    ROOM_CLEAR_FRAME = 44,
+    ROOM_HISTORY = 45,
+    RUN_IN_N_FRAMES = 46,
+    RUN_NEXT_ROOM = 47,
+    SAVE_DATA_MANAGER = 48,
+    SPAWN_ALT_ROCK_REWARDS = 49,
+    SPAWN_COLLECTIBLE = 50,
+    STAGE_HISTORY = 51,
+    START_AMBUSH = 52,
+    TAINTED_LAZARUS_PLAYERS = 53
 }
 
 /**
@@ -7266,6 +7267,7 @@ declare interface ISCFeatureToClass {
     [ISCFeature.ITEM_PICKUP_DETECTION]: ItemPickupDetection;
     [ISCFeature.PLAYER_COLLECTIBLE_DETECTION]: PlayerCollectibleDetection;
     [ISCFeature.PLAYER_REORDERED_CALLBACKS]: PlayerReorderedCallbacks;
+    [ISCFeature.SLOT_DESTROYED_DETECTION]: SlotDestroyedDetection;
     [ISCFeature.SLOT_RENDER_DETECTION]: SlotRenderDetection;
     [ISCFeature.SLOT_UPDATE_DETECTION]: SlotUpdateDetection;
     [ISCFeature.CHARACTER_HEALTH_CONVERSION]: CharacterHealthConversion;
@@ -7883,6 +7885,9 @@ export declare function isSingleUseCollectible(collectibleType: CollectibleType)
 /** For `EntityType.SLOT` (6). */
 export declare function isSlot(entity: Entity): entity is EntitySlot;
 
+/** Returns true for the specific variants of `EntityType.SLOT` that are machines. */
+export declare function isSlotMachine(entity: Entity): boolean;
+
 /** Returns true for cards that have `CardType.SPECIAL`. */
 export declare function isSpecialCard(cardType: CardType): boolean;
 
@@ -8374,6 +8379,12 @@ export declare function logAllEntities(includeBackgroundEffects: boolean, entity
  */
 export declare function logAllGridEntities(includeWalls?: boolean, gridEntityTypeFilter?: GridEntityType): void;
 
+/**
+ * Helper function to log a message to the "log.txt" file and to print it to the screen at the same
+ * time.
+ */
+export declare function logAndPrint(msg: string): void;
+
 /** Helper function to enumerate all of the values in an array. */
 export declare function logArray<T>(array: T[] | readonly T[]): void;
 
@@ -10194,8 +10205,34 @@ export declare enum ModCallbackCustom {
      */
     POST_SLOT_COLLISION = 87,
     /**
-     * Fires from the `POST_RENDER` callback when a slot plays the animation that indicates that it
-     * has broken.
+     * Fires from the `POST_SLOT_UPDATE` or the `POST_ENTITY_REMOVE` callback when a slot machine is
+     * destroyed or a beggar is removed.
+     *
+     * This callback will fire in four different kinds of situations:
+     *
+     * 1. When slot machine entities (e.g. `SlotVariant.SLOT_MACHINE` and
+     *    `SlotVariant.BLOOD_DONATION_MACHINE`) are destroyed with an explosion. When this happens,
+     *    they typically stay in the room and can be pushed around. This state is detected via a
+     *    change in the `GridCollisionClass`.
+     * 2. When slot machine entities pay out with a collectible item. When this happens, they
+     *    immediately despawn without playing any special animation.
+     * 3. When beggars are destroyed with an explosion. When this happens, they immediately despawn
+     *    without playing any special animation.
+     * 4. When beggars pay out with a collectible item. When this happens, they despawn after playing
+     *    the "Teleport" animation. (This is not technically a "destruction" event, but the callback
+     *    will fire for this to remain consistent with the other types of slot entities.)
+     *
+     * Depending on the specific types of slot removal that you need to detect, you can filter using:
+     *
+     * 1. The `isSlotMachine` helper function to differentiate between slot machines and beggars.
+     * 2. The passed callback argument of `SlotDestructionType` to differentiate between bombed slots
+     *    and slots that paid out with a collectible item.
+     *
+     * Note that when a Crane Game explodes after paying out three collectibles, the
+     * `SlotDestructionType` will be equal to `SlotDestructionType.NORMAL` instead of
+     * `SlotDestructionType.COLLECTIBLE_PAYOUT` like you might expect. (This is because it only
+     * explodes after a short delay, and when doing so, it produces rewards in the same way that would
+     * happen if you bombed it.)
      *
      * 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
@@ -12257,6 +12294,11 @@ declare class PostSlotAnimationChanged extends CustomCallback<ModCallbackCustom.
     protected shouldFire: typeof shouldFireSlot;
 }
 
+declare class PostSlotDestroyed extends CustomCallback<ModCallbackCustom.POST_SLOT_DESTROYED> {
+    constructor();
+    protected shouldFire: typeof shouldFireSlot;
+}
+
 declare class PostSlotInit extends CustomCallback<ModCallbackCustom.POST_SLOT_INIT> {
     constructor();
     protected shouldFire: typeof shouldFireSlot;
@@ -12364,13 +12406,6 @@ declare class PreventGridEntityRespawn extends Feature {
     preventGridEntityRespawn(): void;
 }
 
-/**
- * Helper function to print something to the in-game console. Use this instead of invoking the
- * `Isaac.ConsoleOutput` method directly because it will automatically insert a newline at the end
- * of the message (which `Isaac.ConsoleOutput` does not do by default).
- */
-export declare function printConsole(msg: string): void;
-
 /** Helper function to print whether something was enabled or disabled to the in-game console. */
 export declare function printEnabled(enabled: boolean, description: string): void;
 
@@ -13073,6 +13108,7 @@ declare class RoomClearFrame extends Feature {
 
 /** This is used by the room history feature of the standard library. */
 export declare interface RoomDescription {
+    startSeedString: string;
     stage: LevelStage;
     stageType: StageType;
     stageID: StageID;
@@ -14101,9 +14137,44 @@ export declare function shuffleArrayInPlace<T>(array: T[], seedOrRNG?: Seed | RN
  */
 export declare function sign(n: number): int;
 
+declare class SlotDestroyedDetection extends Feature {
+    v: {
+        room: {
+            destroyedSlotSet: Set<PtrHash>;
+        };
+    };
+    private postSlotDestroyed;
+    private roomHistory;
+    constructor(postSlotDestroyed: PostSlotDestroyed, roomHistory: RoomHistory);
+    private postEntityRemoveSlot;
+    private postEntityRemoveSlotMachine;
+    private postEntityRemoveBeggar;
+    private postSlotUpdate;
+    /**
+     * Slots normally have an entity collision class of `EntityCollisionClass.ALL` (4) and a grid
+     * collision class of `EntityGridCollisionClass.NONE` (0). When they are destroyed with a bomb,
+     * the entity collision class stays the same, but the grid collision class switches to
+     * `EntityGridCollisionClass.GROUND` (5).
+     */
+    private checkDestroyedFromCollisionClass;
+}
+
 /** This is used in the `POST_SLOT_DESTROYED` custom callback. */
 export declare enum SlotDestructionType {
+    /**
+     * When a machine or a beggar is blown up by a bomb or is otherwise removed without spawning a
+     * collectible.
+     *
+     * Note that the destruction type for a Crane Game will be `SlotDestructionType.NORMAL`, even if
+     * it destroyed via spawning three separate collectibles.
+     */
     NORMAL = 0,
+    /**
+     * When a machine or a beggar is removed while spawning a collectible reward.
+     *
+     * Note that the destruction type for a Crane Game will be `SlotDestructionType.NORMAL`, even if
+     * it destroyed via spawning three separate collectibles.
+     */
     COLLECTIBLE_PAYOUT = 1
 }