isaacscript-common 31.7.3 → 31.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (108) hide show
  1. package/dist/index.rollup.d.ts +227 -151
  2. package/dist/isaacscript-common.lua +144 -14
  3. package/dist/lualib_bundle.lua +99 -3
  4. package/dist/src/classes/ModFeature.d.ts +2 -2
  5. package/dist/src/classes/callbacks/PostPlayerFatalDamage.d.ts +1 -1
  6. package/dist/src/classes/callbacks/PostPlayerFatalDamage.d.ts.map +1 -1
  7. package/dist/src/classes/callbacks/PostUsePillFilter.d.ts +2 -2
  8. package/dist/src/classes/callbacks/PostUsePillFilter.lua +2 -2
  9. package/dist/src/classes/features/callbackLogic/CustomGridEntities.d.ts +1 -1
  10. package/dist/src/classes/features/other/CustomItemPools.d.ts +1 -1
  11. package/dist/src/classes/features/other/CustomTrapdoors.d.ts +2 -2
  12. package/dist/src/classes/features/other/DebugDisplay.d.ts +18 -18
  13. package/dist/src/classes/features/other/ModdedElementSets.d.ts +2 -2
  14. package/dist/src/classes/features/other/RunInNFrames.d.ts +14 -14
  15. package/dist/src/classes/features/other/SaveDataManager.d.ts +2 -2
  16. package/dist/src/classes/features/other/SpawnRockAltRewards.d.ts +1 -1
  17. package/dist/src/classes/features/other/StageHistory.d.ts +2 -2
  18. package/dist/src/classes/features/other/extraConsoleCommands/commands.d.ts +1 -1
  19. package/dist/src/classes/features/other/extraConsoleCommands/commands.d.ts.map +1 -1
  20. package/dist/src/classes/features/other/extraConsoleCommands/commands.lua +1 -1
  21. package/dist/src/functions/array.d.ts +4 -4
  22. package/dist/src/functions/array.lua +4 -4
  23. package/dist/src/functions/cards.d.ts +1 -1
  24. package/dist/src/functions/cards.d.ts.map +1 -1
  25. package/dist/src/functions/cards.lua +1 -1
  26. package/dist/src/functions/charge.d.ts +1 -1
  27. package/dist/src/functions/charge.lua +1 -1
  28. package/dist/src/functions/collectibles.d.ts +3 -3
  29. package/dist/src/functions/collectibles.lua +3 -3
  30. package/dist/src/functions/debugFunctions.d.ts +2 -2
  31. package/dist/src/functions/debugFunctions.lua +2 -2
  32. package/dist/src/functions/deepCopy.d.ts +2 -2
  33. package/dist/src/functions/deepCopy.lua +2 -2
  34. package/dist/src/functions/globals.d.ts +1 -1
  35. package/dist/src/functions/globals.lua +1 -1
  36. package/dist/src/functions/gridEntities.d.ts +6 -6
  37. package/dist/src/functions/gridEntities.lua +6 -6
  38. package/dist/src/functions/gridEntitiesSpecific.d.ts +22 -22
  39. package/dist/src/functions/gridEntitiesSpecific.lua +22 -22
  40. package/dist/src/functions/logEntities.d.ts +1 -1
  41. package/dist/src/functions/logEntities.lua +1 -1
  42. package/dist/src/functions/minimap.d.ts +17 -20
  43. package/dist/src/functions/minimap.d.ts.map +1 -1
  44. package/dist/src/functions/minimap.lua +17 -20
  45. package/dist/src/functions/nextStage.d.ts +2 -2
  46. package/dist/src/functions/nextStage.lua +2 -2
  47. package/dist/src/functions/pills.d.ts +2 -2
  48. package/dist/src/functions/pills.lua +2 -2
  49. package/dist/src/functions/playerHealth.d.ts +4 -4
  50. package/dist/src/functions/playerHealth.lua +4 -4
  51. package/dist/src/functions/playerIndex.d.ts +2 -3
  52. package/dist/src/functions/playerIndex.d.ts.map +1 -1
  53. package/dist/src/functions/playerIndex.lua +2 -3
  54. package/dist/src/functions/players.d.ts +5 -5
  55. package/dist/src/functions/players.lua +5 -5
  56. package/dist/src/functions/pocketItems.d.ts +5 -5
  57. package/dist/src/functions/pocketItems.lua +5 -5
  58. package/dist/src/functions/revive.d.ts +3 -3
  59. package/dist/src/functions/revive.lua +3 -3
  60. package/dist/src/functions/rooms.d.ts +7 -7
  61. package/dist/src/functions/rooms.lua +7 -7
  62. package/dist/src/functions/run.d.ts +1 -1
  63. package/dist/src/functions/run.lua +1 -1
  64. package/dist/src/functions/set.d.ts +1 -1
  65. package/dist/src/functions/set.lua +1 -1
  66. package/dist/src/functions/stage.d.ts +80 -9
  67. package/dist/src/functions/stage.d.ts.map +1 -1
  68. package/dist/src/functions/stage.lua +96 -18
  69. package/dist/src/functions/trinkets.d.ts +1 -1
  70. package/dist/src/functions/trinkets.lua +1 -1
  71. package/package.json +2 -2
  72. package/src/classes/ModFeature.ts +2 -2
  73. package/src/classes/callbacks/PostPlayerFatalDamage.ts +1 -1
  74. package/src/classes/callbacks/PostUsePillFilter.ts +2 -2
  75. package/src/classes/features/callbackLogic/CustomGridEntities.ts +1 -1
  76. package/src/classes/features/other/CustomItemPools.ts +1 -1
  77. package/src/classes/features/other/CustomTrapdoors.ts +2 -2
  78. package/src/classes/features/other/DebugDisplay.ts +18 -18
  79. package/src/classes/features/other/DisableInputs.ts +2 -2
  80. package/src/classes/features/other/ModdedElementSets.ts +2 -2
  81. package/src/classes/features/other/RunInNFrames.ts +15 -15
  82. package/src/classes/features/other/SaveDataManager.ts +2 -2
  83. package/src/classes/features/other/SpawnRockAltRewards.ts +1 -1
  84. package/src/classes/features/other/StageHistory.ts +2 -2
  85. package/src/classes/features/other/extraConsoleCommands/commands.ts +1 -1
  86. package/src/functions/array.ts +4 -4
  87. package/src/functions/cards.ts +1 -1
  88. package/src/functions/charge.ts +1 -1
  89. package/src/functions/collectibles.ts +3 -3
  90. package/src/functions/debugFunctions.ts +2 -2
  91. package/src/functions/deepCopy.ts +3 -3
  92. package/src/functions/globals.ts +1 -1
  93. package/src/functions/gridEntities.ts +6 -6
  94. package/src/functions/gridEntitiesSpecific.ts +22 -22
  95. package/src/functions/logEntities.ts +1 -1
  96. package/src/functions/minimap.ts +17 -20
  97. package/src/functions/nextStage.ts +2 -2
  98. package/src/functions/pills.ts +2 -2
  99. package/src/functions/playerHealth.ts +4 -4
  100. package/src/functions/playerIndex.ts +2 -3
  101. package/src/functions/players.ts +5 -5
  102. package/src/functions/pocketItems.ts +5 -5
  103. package/src/functions/revive.ts +3 -3
  104. package/src/functions/rooms.ts +7 -7
  105. package/src/functions/run.ts +1 -1
  106. package/src/functions/set.ts +1 -1
  107. package/src/functions/stage.ts +155 -35
  108. package/src/functions/trinkets.ts +1 -1
@@ -883,9 +883,9 @@ export declare function addRoomClearChargeToSlot(player: EntityPlayer, activeSlo
883
883
 
884
884
  /**
885
885
  * Helper function to add a `DisplayFlag` to a particular room's minimap display flags (e.g. whether
886
- * or not it is visible and so on).
886
+ * it is visible and so on).
887
887
  *
888
- * This function automatically accounts for whether or not MinimapAPI is being used.
888
+ * This function automatically accounts for if MinimapAPI is being used.
889
889
  *
890
890
  * @param roomGridIndex Set to undefined to use the current room index.
891
891
  * @param displayFlag The `DisplayFlag` to set. (See the `DisplayFlag` enum.)
@@ -1107,7 +1107,7 @@ export declare function arrayRemoveIndex<T>(originalArray: T[] | readonly T[], .
1107
1107
  *
1108
1108
  * This function is variadic, meaning that you can specify N arguments to remove N elements.
1109
1109
  *
1110
- * @returns Whether or not any array elements were removed.
1110
+ * @returns Whether any array elements were removed.
1111
1111
  */
1112
1112
  export declare function arrayRemoveIndexInPlace<T>(array: T[], ...indexesToRemove: int[]): boolean;
1113
1113
 
@@ -1504,7 +1504,7 @@ export declare function clearCollectibleSprite(collectible: EntityPickup): void;
1504
1504
  /**
1505
1505
  * Helper function to set the value of `DisplayFlag` for every room on the floor to 0.
1506
1506
  *
1507
- * This function automatically accounts for whether or not MinimapAPI is being used.
1507
+ * This function automatically accounts for if MinimapAPI is being used.
1508
1508
  *
1509
1509
  * This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
1510
1510
  * the changes will be immediately visible.
@@ -1514,7 +1514,7 @@ export declare function clearFloorDisplayFlags(): void;
1514
1514
  /**
1515
1515
  * Helper function to set the value of `DisplayFlag` for a room 0.
1516
1516
  *
1517
- * This function automatically accounts for whether or not MinimapAPI is being used.
1517
+ * This function automatically accounts for if MinimapAPI is being used.
1518
1518
  *
1519
1519
  * This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
1520
1520
  * the changes will be immediately visible.
@@ -1877,7 +1877,7 @@ declare class CustomGridEntities extends Feature {
1877
1877
  * @param gridIndexOrPositionOrGridEntity You can specify the custom grid entity to remove by
1878
1878
  * providing the grid index, the room position, or the grid entity
1879
1879
  * itself.
1880
- * @param updateRoom Optional. Whether or not to update the room after the grid entity is removed.
1880
+ * @param updateRoom Optional. Whether to update the room after the grid entity is removed.
1881
1881
  * Default is true. This is generally a good idea because if the room is not
1882
1882
  * updated, you will be unable to spawn another grid entity on the same tile
1883
1883
  * until a frame has passed. However, doing this is expensive, since it involves
@@ -2032,7 +2032,7 @@ declare class CustomItemPools extends Feature {
2032
2032
  * In order to use this function, you must upgrade your mod with `ISCFeature.CUSTOM_ITEM_POOLS`.
2033
2033
  *
2034
2034
  * @param itemPoolTypeCustom An integer representing the custom item pool to use.
2035
- * @param decrease Optional. Whether or not to remove the selected collectible from the item pool.
2035
+ * @param decrease Optional. Whether to remove the selected collectible from the item pool.
2036
2036
  * Default is true.
2037
2037
  * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided,
2038
2038
  * the `RNG.Next` method will be called. Default is `getRandomSeed()`.
@@ -2801,8 +2801,8 @@ declare class CustomTrapdoors extends Feature {
2801
2801
  * @param anm2Path Optional. The path to the anm2 file to use. By default, the vanilla trapdoor
2802
2802
  * anm2 of "gfx/grid/door_11_trapdoor.anm2" will be used. The specified anm2 file
2803
2803
  * must have animations called "Opened", "Closed", and "Open Animation".
2804
- * @param spawnOpen Optional. Whether or not to spawn the trapdoor in an open state. By default,
2805
- * behavior will be used that emulates a vanilla trapdoor.
2804
+ * @param spawnOpen Optional. Whether to spawn the trapdoor in an open state. By default, behavior
2805
+ * will be used that emulates a vanilla trapdoor.
2806
2806
  */
2807
2807
  spawnCustomTrapdoor(gridIndexOrPosition: int | Vector, destinationName?: string, destinationStage?: LevelStage, destinationStageType?: StageType, anm2Path?: string, spawnOpen?: boolean): GridEntity;
2808
2808
  }
@@ -3041,7 +3041,7 @@ declare class DebugDisplay extends Feature {
3041
3041
  *
3042
3042
  * @param force Optional. A boolean that represents the value to force the display to. For
3043
3043
  * example, you can specify true to always make the display turn on, regardless of
3044
- * whether or not it is already on.
3044
+ * whether it is already on.
3045
3045
  */
3046
3046
  togglePlayerDisplay(force?: boolean): void;
3047
3047
  /**
@@ -3051,7 +3051,7 @@ declare class DebugDisplay extends Feature {
3051
3051
  *
3052
3052
  * @param force Optional. A boolean that represents the value to force the display to. For
3053
3053
  * example, you can specify true to always make the display turn on, regardless of
3054
- * whether or not it is already on.
3054
+ * whether it is already on.
3055
3055
  */
3056
3056
  toggleTearDisplay(force?: boolean): void;
3057
3057
  /**
@@ -3062,7 +3062,7 @@ declare class DebugDisplay extends Feature {
3062
3062
  *
3063
3063
  * @param force Optional. A boolean that represents the value to force the display to. For
3064
3064
  * example, you can specify true to always make the display turn on, regardless of
3065
- * whether or not it is already on.
3065
+ * whether it is already on.
3066
3066
  */
3067
3067
  toggleFamiliarDisplay(force?: boolean): void;
3068
3068
  /**
@@ -3072,7 +3072,7 @@ declare class DebugDisplay extends Feature {
3072
3072
  *
3073
3073
  * @param force Optional. A boolean that represents the value to force the display to. For
3074
3074
  * example, you can specify true to always make the display turn on, regardless of
3075
- * whether or not it is already on.
3075
+ * whether it is already on.
3076
3076
  */
3077
3077
  toggleBombDisplay(force?: boolean): void;
3078
3078
  /**
@@ -3082,7 +3082,7 @@ declare class DebugDisplay extends Feature {
3082
3082
  *
3083
3083
  * @param force Optional. A boolean that represents the value to force the display to. For
3084
3084
  * example, you can specify true to always make the display turn on, regardless of
3085
- * whether or not it is already on.
3085
+ * whether it is already on.
3086
3086
  */
3087
3087
  togglePickupDisplay(force?: boolean): void;
3088
3088
  /**
@@ -3092,7 +3092,7 @@ declare class DebugDisplay extends Feature {
3092
3092
  *
3093
3093
  * @param force Optional. A boolean that represents the value to force the display to. For
3094
3094
  * example, you can specify true to always make the display turn on, regardless of
3095
- * whether or not it is already on.
3095
+ * whether it is already on.
3096
3096
  */
3097
3097
  toggleSlotDisplay(force?: boolean): void;
3098
3098
  /**
@@ -3102,7 +3102,7 @@ declare class DebugDisplay extends Feature {
3102
3102
  *
3103
3103
  * @param force Optional. A boolean that represents the value to force the display to. For
3104
3104
  * example, you can specify true to always make the display turn on, regardless of
3105
- * whether or not it is already on.
3105
+ * whether it is already on.
3106
3106
  */
3107
3107
  toggleLaserDisplay(force?: boolean): void;
3108
3108
  /**
@@ -3112,7 +3112,7 @@ declare class DebugDisplay extends Feature {
3112
3112
  *
3113
3113
  * @param force Optional. A boolean that represents the value to force the display to. For
3114
3114
  * example, you can specify true to always make the display turn on, regardless of
3115
- * whether or not it is already on.
3115
+ * whether it is already on.
3116
3116
  */
3117
3117
  toggleKnifeDisplay(force?: boolean): void;
3118
3118
  /**
@@ -3123,7 +3123,7 @@ declare class DebugDisplay extends Feature {
3123
3123
  *
3124
3124
  * @param force Optional. A boolean that represents the value to force the display to. For
3125
3125
  * example, you can specify true to always make the display turn on, regardless of
3126
- * whether or not it is already on.
3126
+ * whether it is already on.
3127
3127
  */
3128
3128
  toggleProjectileDisplay(force?: boolean): void;
3129
3129
  /**
@@ -3133,7 +3133,7 @@ declare class DebugDisplay extends Feature {
3133
3133
  *
3134
3134
  * @param force Optional. A boolean that represents the value to force the display to. For
3135
3135
  * example, you can specify true to always make the display turn on, regardless of
3136
- * whether or not it is already on.
3136
+ * whether it is already on.
3137
3137
  */
3138
3138
  toggleEffectDisplay(force?: boolean): void;
3139
3139
  /**
@@ -3143,7 +3143,7 @@ declare class DebugDisplay extends Feature {
3143
3143
  *
3144
3144
  * @param force Optional. A boolean that represents the value to force the display to. For
3145
3145
  * example, you can specify true to always make the display turn on, regardless of
3146
- * whether or not it is already on.
3146
+ * whether it is already on.
3147
3147
  */
3148
3148
  toggleNPCDisplay(force?: boolean): void;
3149
3149
  /**
@@ -3153,7 +3153,7 @@ declare class DebugDisplay extends Feature {
3153
3153
  *
3154
3154
  * @param force Optional. A boolean that represents the value to force the display to. For
3155
3155
  * example, you can specify true to always make the display turn on, regardless of
3156
- * whether or not it is already on.
3156
+ * whether it is already on.
3157
3157
  */
3158
3158
  toggleRockDisplay(force?: boolean): void;
3159
3159
  /**
@@ -3163,7 +3163,7 @@ declare class DebugDisplay extends Feature {
3163
3163
  *
3164
3164
  * @param force Optional. A boolean that represents the value to force the display to. For
3165
3165
  * example, you can specify true to always make the display turn on, regardless of
3166
- * whether or not it is already on.
3166
+ * whether it is already on.
3167
3167
  */
3168
3168
  togglePitDisplay(force?: boolean): void;
3169
3169
  /**
@@ -3173,7 +3173,7 @@ declare class DebugDisplay extends Feature {
3173
3173
  *
3174
3174
  * @param force Optional. A boolean that represents the value to force the display to. For
3175
3175
  * example, you can specify true to always make the display turn on, regardless of
3176
- * whether or not it is already on.
3176
+ * whether it is already on.
3177
3177
  */
3178
3178
  toggleSpikesDisplay(force?: boolean): void;
3179
3179
  /**
@@ -3183,7 +3183,7 @@ declare class DebugDisplay extends Feature {
3183
3183
  *
3184
3184
  * @param force Optional. A boolean that represents the value to force the display to. For
3185
3185
  * example, you can specify true to always make the display turn on, regardless of
3186
- * whether or not it is already on.
3186
+ * whether it is already on.
3187
3187
  */
3188
3188
  toggleTNTDisplay(force?: boolean): void;
3189
3189
  /**
@@ -3193,7 +3193,7 @@ declare class DebugDisplay extends Feature {
3193
3193
  *
3194
3194
  * @param force Optional. A boolean that represents the value to force the display to. For
3195
3195
  * example, you can specify true to always make the display turn on, regardless of
3196
- * whether or not it is already on.
3196
+ * whether it is already on.
3197
3197
  */
3198
3198
  togglePoopDisplay(force?: boolean): void;
3199
3199
  /**
@@ -3203,7 +3203,7 @@ declare class DebugDisplay extends Feature {
3203
3203
  *
3204
3204
  * @param force Optional. A boolean that represents the value to force the display to. For
3205
3205
  * example, you can specify true to always make the display turn on, regardless of
3206
- * whether or not it is already on.
3206
+ * whether it is already on.
3207
3207
  */
3208
3208
  toggleDoorDisplay(force?: boolean): void;
3209
3209
  /**
@@ -3214,7 +3214,7 @@ declare class DebugDisplay extends Feature {
3214
3214
  *
3215
3215
  * @param force Optional. A boolean that represents the value to force the display to. For
3216
3216
  * example, you can specify true to always make the display turn on, regardless of
3217
- * whether or not it is already on.
3217
+ * whether it is already on.
3218
3218
  */
3219
3219
  togglePressurePlateDisplay(force?: boolean): void;
3220
3220
  }
@@ -3262,8 +3262,8 @@ export declare type Decrement<N extends number> = Arr<N> extends [unknown, ...in
3262
3262
  * user-defined TSTL classes when recursively iterating through the given
3263
3263
  * object, it will use this map to instantiate a new class. Default is an
3264
3264
  * empty Lua table.
3265
- * @param insideMap Optional. Tracks whether or not the deep copy function is in the process of
3266
- * recursively copying a TSTL Map. Default is false.
3265
+ * @param insideMap Optional. Tracks whether the deep copy function is in the process of recursively
3266
+ * copying a TSTL Map. Default is false.
3267
3267
  */
3268
3268
  export declare function deepCopy<T>(value: T, serializationType?: SerializationType.NONE, traversalDescription?: string, classConstructors?: LuaMap<string, AnyClass>, insideMap?: boolean): T;
3269
3269
 
@@ -3512,7 +3512,7 @@ declare class DeployJSONRoom extends Feature {
3512
3512
  *
3513
3513
  * If the player does not have an item currently queued, then this function will be a no-op.
3514
3514
  *
3515
- * Returns whether or not an item was actually dequeued.
3515
+ * Returns whether an item was actually dequeued.
3516
3516
  */
3517
3517
  export declare function dequeueItem(player: EntityPlayer): boolean;
3518
3518
 
@@ -3747,7 +3747,7 @@ export declare function doesEntityExist(entityType?: EntityType | -1, variant?:
3747
3747
  export declare function doesGridEntityExist(gridEntityType: GridEntityType, variant?: number): boolean;
3748
3748
 
3749
3749
  /**
3750
- * Returns whether or not all of the player's soul-heart-type hearts are black hearts.
3750
+ * Returns whether all of the player's soul-heart-type hearts are black hearts.
3751
3751
  *
3752
3752
  * Note that this function does not consider red heart containers.
3753
3753
  *
@@ -3762,7 +3762,7 @@ export declare function doesGridEntityExist(gridEntityType: GridEntityType, vari
3762
3762
  export declare function doesPlayerHaveAllBlackHearts(player: EntityPlayer): boolean;
3763
3763
 
3764
3764
  /**
3765
- * Returns whether or not all of the player's soul-heart-type hearts are soul hearts.
3765
+ * Returns whether all of the player's soul-heart-type hearts are soul hearts.
3766
3766
  *
3767
3767
  * Note that this function does not consider red heart containers.
3768
3768
  *
@@ -4668,7 +4668,7 @@ export declare function getAngleDifference(angle1: float, angle2: float): float;
4668
4668
  * From: https://github.com/firstandthird/combinations/blob/master/index.js
4669
4669
  *
4670
4670
  * @param array The array to get the combinations of.
4671
- * @param includeEmptyArray Whether or not to include an empty array in the combinations.
4671
+ * @param includeEmptyArray Whether to include an empty array in the combinations.
4672
4672
  * @param min Optional. The minimum number of elements to include in each combination. Default is 1.
4673
4673
  * @param max Optional. The maximum number of elements to include in each combination. Default is
4674
4674
  * the length of the array.
@@ -5049,7 +5049,7 @@ export declare function getCurseIDByName(name: string): LevelCurse;
5049
5049
  * Helper function to get a set containing all of the global variable names that are contained
5050
5050
  * within the Isaac environment by default.
5051
5051
  *
5052
- * Returns a slightly different set depending on whether the "--luadebug" flag is enabled or not.
5052
+ * Returns a slightly different set depending on whether the "--luadebug" flag is enabled.
5053
5053
  */
5054
5054
  export declare function getDefaultGlobals(): ReadonlySet<string>;
5055
5055
 
@@ -5374,10 +5374,9 @@ export declare function getFlagName<T extends BitFlag | BitFlag128>(flag: BitFla
5374
5374
  * Helper function to get the minimap `DisplayFlag` value for every room on the floor. Returns a map
5375
5375
  * that is indexed by the room's safe grid index.
5376
5376
  *
5377
- * This function automatically accounts for whether or not MinimapAPI is being used.
5377
+ * This function automatically accounts for if MinimapAPI is being used.
5378
5378
  *
5379
- * @param minimapAPI Optional. Whether or not MinimapAPI should be used, if present. Default is
5380
- * true.
5379
+ * @param minimapAPI Optional. If MinimapAPI should be used, if present. Default is true.
5381
5380
  */
5382
5381
  export declare function getFloorDisplayFlags(minimapAPI?: boolean): Map<int, BitFlags<DisplayFlag>>;
5383
5382
 
@@ -5813,8 +5812,8 @@ export declare function getNextStage(): LevelStage;
5813
5812
  * `getNextStageTypeUsingHistory` helper function instead (from the stage history feature). Handling
5814
5813
  * this requires stateful tracking as the player progresses through the run.
5815
5814
  *
5816
- * @param upwards Whether or not the player should go up to Cathedral in the case of being on Womb
5817
- * 2. Default is false.
5815
+ * @param upwards Whether the player should go up to Cathedral in the case of being on Womb 2.
5816
+ * Default is false.
5818
5817
  */
5819
5818
  export declare function getNextStageType(upwards?: boolean): StageType;
5820
5819
 
@@ -5960,8 +5959,8 @@ export declare function getPillColorFromEffect(pillEffect: PillEffect): PillColo
5960
5959
  /**
5961
5960
  * Helper function to get a pill effect class from a PillEffect enum value. In this context, the
5962
5961
  * class is equal to the numerical prefix in the "class" tag in the "pocketitems.xml" file. Use the
5963
- * `getPillEffectType` helper function to determine whether or not the pill effect is positive,
5964
- * negative, or neutral.
5962
+ * `getPillEffectType` helper function to determine whether the pill effect is positive, negative,
5963
+ * or neutral.
5965
5964
  *
5966
5965
  * Due to limitations in the API, this function will not work properly for modded pill effects, and
5967
5966
  * will always return `DEFAULT_PILL_EFFECT_CLASS` in those cases.
@@ -6159,9 +6158,8 @@ export declare function getPlayerNumHitsRemaining(player: EntityPlayer): int;
6159
6158
  *
6160
6159
  * If this is not desired, use the `getAllPlayers` helper function instead.
6161
6160
  *
6162
- * @param performCharacterExclusions Whether or not to exclude characters that are not directly
6163
- * controlled by the player (i.e. Esau & Tainted Soul). Default is
6164
- * false.
6161
+ * @param performCharacterExclusions Whether to exclude characters that are not directly controlled
6162
+ * by the player (i.e. Esau & Tainted Soul). Default is false.
6165
6163
  */
6166
6164
  export declare function getPlayers(performCharacterExclusions?: boolean): EntityPlayer[];
6167
6165
 
@@ -6616,14 +6614,13 @@ export declare function getRoomDescriptorReadOnly(): Readonly<RoomDescriptor>;
6616
6614
  export declare function getRoomDescriptorsForType(...roomTypes: RoomType[]): RoomDescriptor[];
6617
6615
 
6618
6616
  /**
6619
- * Helper function to get a particular room's minimap display flags (e.g. whether or not it is
6620
- * visible and so on).
6617
+ * Helper function to get a particular room's minimap display flags (e.g. whether it is visible and
6618
+ * so on).
6621
6619
  *
6622
- * This function automatically accounts for whether or not MinimapAPI is being used.
6620
+ * This function automatically accounts for if MinimapAPI is being used.
6623
6621
  *
6624
6622
  * @param roomGridIndex Optional. Default is the current room index.
6625
- * @param minimapAPI Optional. Whether or not MinimapAPI should be used, if present. Default is
6626
- * true.
6623
+ * @param minimapAPI Optional. If MinimapAPI should be used, if present. Default is true.
6627
6624
  */
6628
6625
  export declare function getRoomDisplayFlags(roomGridIndex?: int, minimapAPI?: boolean): BitFlags<DisplayFlag>;
6629
6626
 
@@ -6940,7 +6937,7 @@ export declare function getScreenTopRightPos(): Readonly<Vector>;
6940
6937
  * - [1, 2, 3]
6941
6938
  *
6942
6939
  * @param set The set to get the combinations of.
6943
- * @param includeEmptyArray Whether or not to include an empty array in the combinations.
6940
+ * @param includeEmptyArray Whether to include an empty array in the combinations.
6944
6941
  */
6945
6942
  export declare function getSetCombinations<T>(set: Set<T> | ReadonlySet<T>, includeEmptyArray: boolean): ReadonlyArray<ReadonlySet<T>>;
6946
6943
 
@@ -7039,8 +7036,8 @@ export declare function getSurroundingGridEntities(gridEntity: GridEntity): Grid
7039
7036
  *
7040
7037
  * If Tainted Magdalene has Birthright, she will gained an additional non-temporary heart container.
7041
7038
  *
7042
- * This function does not validate whether or not the provided player is Tainted Magdalene; that
7043
- * should be accomplished before invoking this function.
7039
+ * This function does not validate whether the provided player is Tainted Magdalene; that should be
7040
+ * accomplished before invoking this function.
7044
7041
  */
7045
7042
  export declare function getTaintedMagdaleneNonTemporaryMaxHearts(player: EntityPlayer): int;
7046
7043
 
@@ -7084,7 +7081,7 @@ export declare function getTeleporters(variant?: number): GridEntity[];
7084
7081
  * Helper function to get the current time for benchmarking / profiling purposes.
7085
7082
  *
7086
7083
  * The return value will either be in seconds or milliseconds, depending on if the "--luadebug" flag
7087
- * is turned on or not.
7084
+ * is turned on.
7088
7085
  *
7089
7086
  * If the "--luadebug" flag is present, then this function will use the `socket.gettime` method,
7090
7087
  * which returns the epoch timestamp in seconds (e.g. "1640320492.5779"). This is preferable over
@@ -7474,8 +7471,8 @@ export declare type HasFunction<T> = Record<string, unknown> extends {
7474
7471
  export declare function hasLostCurse(player: EntityPlayer): boolean;
7475
7472
 
7476
7473
  /**
7477
- * Returns whether or not the player can hold an additional active item, beyond what they are
7478
- * currently carrying. This takes the Schoolbag into account.
7474
+ * Returns whether the player can hold an additional active item, beyond what they are currently
7475
+ * carrying. This takes the Schoolbag into account.
7479
7476
  *
7480
7477
  * If the player is the Tainted Soul, this always returns false, since that character cannot pick up
7481
7478
  * items. (Only Tainted Forgotten can pick up items.)
@@ -7483,9 +7480,9 @@ export declare function hasLostCurse(player: EntityPlayer): boolean;
7483
7480
  export declare function hasOpenActiveItemSlot(player: EntityPlayer): boolean;
7484
7481
 
7485
7482
  /**
7486
- * Returns whether or not the player can hold an additional pocket item, beyond what they are
7487
- * currently carrying. This takes into account items that modify the max number of pocket items,
7488
- * like Starter Deck.
7483
+ * Returns whether the player can hold an additional pocket item, beyond what they are currently
7484
+ * carrying. This takes into account items that modify the max number of pocket items, like Starter
7485
+ * Deck.
7489
7486
  *
7490
7487
  * If the player is the Tainted Soul, this always returns false, since that character cannot pick up
7491
7488
  * items. (Only Tainted Forgotten can pick up items.)
@@ -7493,7 +7490,7 @@ export declare function hasOpenActiveItemSlot(player: EntityPlayer): boolean;
7493
7490
  export declare function hasOpenPocketItemSlot(player: EntityPlayer): boolean;
7494
7491
 
7495
7492
  /**
7496
- * Returns whether or not the player can hold an additional trinket, beyond what they are currently
7493
+ * Returns whether the player can hold an additional trinket, beyond what they are currently
7497
7494
  * carrying. This takes into account items that modify the max number of trinkets, like Mom's Purse.
7498
7495
  *
7499
7496
  * If the player is the Tainted Soul, this always returns false, since that character cannot pick up
@@ -7547,7 +7544,7 @@ export declare function hexToKColor(hexString: string, alpha?: number): Readonly
7547
7544
  * This is because if the player enters into the room or walks into an adjacent room, the room will
7548
7545
  * reappear on the minimap.
7549
7546
  *
7550
- * This function automatically accounts for whether or not MinimapAPI is being used.
7547
+ * This function automatically accounts for if MinimapAPI is being used.
7551
7548
  */
7552
7549
  export declare function hideRoomOnMinimap(roomGridIndex: int): void;
7553
7550
 
@@ -7744,9 +7741,9 @@ export declare function inSecretExit(): boolean;
7744
7741
  export declare function inSecretShop(): boolean;
7745
7742
 
7746
7743
  /**
7747
- * Helper function to determine whether or not the current room is the starting room of a floor. It
7748
- * only returns true for the starting room of the primary dimension (meaning that being in the
7749
- * starting room of the mirror world does not count).
7744
+ * Helper function to determine whether the current room is the starting room of a floor. It only
7745
+ * returns true for the starting room of the primary dimension (meaning that being in the starting
7746
+ * room of the mirror world does not count).
7750
7747
  */
7751
7748
  export declare function inStartingRoom(): boolean;
7752
7749
 
@@ -7879,10 +7876,10 @@ export declare function isAllPressurePlatesPushed(): boolean;
7879
7876
  * @param onlyCheckRoomTypes Optional. A whitelist of room types. If specified, room types not in
7880
7877
  * the array will be ignored. If not specified, then all rooms will be
7881
7878
  * checked. Undefined by default.
7882
- * @param includeSecretAndSuperSecretRoom Optional. Whether or not to include the Secret Room and
7883
- * the Super Secret Room. Default is false.
7884
- * @param includeUltraSecretRoom Optional. Whether or not to include the Ultra Secret Room. Default
7885
- * is false.
7879
+ * @param includeSecretAndSuperSecretRoom Optional. Whether to include the Secret Room and the Super
7880
+ * Secret Room. Default is false.
7881
+ * @param includeUltraSecretRoom Optional. Whether to include the Ultra Secret Room. Default is
7882
+ * false.
7886
7883
  * @allowEmptyVariadic
7887
7884
  */
7888
7885
  export declare function isAllRoomsClear(onlyCheckRoomTypes?: RoomType[], includeSecretAndSuperSecretRoom?: boolean, includeUltraSecretRoom?: boolean): boolean;
@@ -7899,8 +7896,8 @@ export declare function isAngelShop(roomData: RoomConfig): boolean;
7899
7896
  * - the table has no keys (i.e. an "empty" table)
7900
7897
  *
7901
7898
  * @param object The object to analyze.
7902
- * @param ensureContiguousValues Optional. Whether or not the Lua table has to have all contiguous
7903
- * keys in order to be considered an array. Default is true.
7899
+ * @param ensureContiguousValues Optional. Whether the Lua table has to have all contiguous keys in
7900
+ * order to be considered an array. Default is true.
7904
7901
  */
7905
7902
  export declare function isArray(object: unknown, ensureContiguousValues?: boolean): object is unknown[];
7906
7903
 
@@ -7965,7 +7962,7 @@ export declare function isCard(cardType: CardType): boolean;
7965
7962
  /** For `PickupVariant.TAROT_CARD` (300). */
7966
7963
  export declare function isCardPickup(pickup: EntityPickup): pickup is EntityPickupCard;
7967
7964
 
7968
- /** Returns whether or not the given card type matches the specified item config card type. */
7965
+ /** Returns whether the given card type matches the specified item config card type. */
7969
7966
  export declare function isCardType(cardType: CardType, itemConfigCardType: ItemConfigCardType): boolean;
7970
7967
 
7971
7968
  export declare enum ISCFeature {
@@ -8334,11 +8331,21 @@ export declare function isFamiliarStolenBySiren(familiar: EntityFamiliar): boole
8334
8331
  */
8335
8332
  export declare function isFamiliarThatShootsPlayerTears(familiar: EntityFamiliar): boolean;
8336
8333
 
8334
+ /**
8335
+ * Returns whether the provided stage and stage type represent a "final floor". This is defined as a
8336
+ * floor that prevents the player from entering the I AM ERROR room on.
8337
+ *
8338
+ * For example, when using Undefined on The Chest, it has a 50% chance of teleporting the player to
8339
+ * the Secret Room and a 50% chance of teleporting the player to the Super Secret Room, because the
8340
+ * I AM ERROR room is never entered into the list of possibilities.
8341
+ */
8342
+ export declare function isFinalFloor(stage: LevelStage, stageType: StageType): boolean;
8343
+
8337
8344
  export declare function isFirstPlayer(player: EntityPlayer): boolean;
8338
8345
 
8339
8346
  /**
8340
- * Helper function to determine whether or not the player's "active" pocket item slot is set to
8341
- * their pocket active item.
8347
+ * Helper function to determine whether the player's "active" pocket item slot is set to their
8348
+ * pocket active item.
8342
8349
  */
8343
8350
  export declare function isFirstSlotPocketActiveItem(player: EntityPlayer): boolean;
8344
8351
 
@@ -8358,9 +8365,9 @@ export declare function isFunction(variable: unknown): variable is Function;
8358
8365
  export declare function isGenesisRoom(roomDescriptor: RoomDescriptor): boolean;
8359
8366
 
8360
8367
  /**
8361
- * Returns whether or not the given collectible is a "glitched" item. All items are replaced by
8362
- * glitched items once a player has TMTRAINER. However, glitched items can also "naturally" appear
8363
- * in secret rooms and I AM ERROR rooms if the "Corrupted Data" achievement is unlocked.
8368
+ * Returns whether the given collectible is a "glitched" item. All items are replaced by glitched
8369
+ * items once a player has TMTRAINER. However, glitched items can also "naturally" appear in secret
8370
+ * rooms and I AM ERROR rooms if the "Corrupted Data" achievement is unlocked.
8364
8371
  */
8365
8372
  export declare function isGlitchedCollectible(collectible: EntityPickup): boolean;
8366
8373
 
@@ -8473,7 +8480,7 @@ export declare function isLRoomShape(roomShape: RoomShape): boolean;
8473
8480
  * documented here: https://wofsauge.github.io/IsaacDocs/rep/Globals.html
8474
8481
  *
8475
8482
  * This function uses the `package` global variable as a proxy to determine if the "--luadebug" flag
8476
- * is enabled or not.
8483
+ * is enabled.
8477
8484
  *
8478
8485
  * Note that this function will return false if the Racing+ sandbox is enabled, even if the
8479
8486
  * "--luadebug" flag is really turned on. If checking for this case is needed, check for the
@@ -8709,8 +8716,7 @@ export declare function isRoomType(roomData: RoomConfig, ...roomTypes: RoomType[
8709
8716
  * Helper function to check if a given room is visible on the minimap.
8710
8717
  *
8711
8718
  * @param roomGridIndex The room to check.
8712
- * @param minimapAPI Optional. Whether or not MinimapAPI should be used, if present. Default is
8713
- * true.
8719
+ * @param minimapAPI Optional. Whether MinimapAPI should be used, if present. Default is true.
8714
8720
  */
8715
8721
  export declare function isRoomVisible(roomGridIndex: int, minimapAPI?: boolean): boolean;
8716
8722
 
@@ -8829,6 +8835,61 @@ export declare function isSpecialCard(cardType: CardType): boolean;
8829
8835
  /** Helper function to detect if a variable is of type `GridEntitySpikes`. */
8830
8836
  export declare function isSpikes(variable: unknown): variable is GridEntitySpikes;
8831
8837
 
8838
+ /**
8839
+ * Helper function to check if the provided effective stage is one that has the possibility to grant
8840
+ * a natural Devil Room or Angel Room after killing the boss.
8841
+ *
8842
+ * Note that in order for this function to work properly, you must provide it with the effective
8843
+ * stage (e.g. from the `getEffectiveStage` helper function) and not the absolute stage (e.g. from
8844
+ * the `Level.GetStage` method).
8845
+ */
8846
+ export declare function isStageWithNaturalDevilRoom(effectiveStage: LevelStage): boolean;
8847
+
8848
+ /**
8849
+ * Helper function to check if the provided stage is one that will have a random collectible drop
8850
+ * upon defeating the boss of the floor.
8851
+ *
8852
+ * This happens on most stages but will not happen on Depths 2, Womb 2, Sheol, Cathedral, Dark Room,
8853
+ * The Chest, and Home (due to the presence of a story boss).
8854
+ *
8855
+ * Note that even though Delirium does not drop a random boss collectible, The Void is still
8856
+ * considered to be a stage that has a random boss collectible since all of the non-Delirium Boss
8857
+ * Rooms will drop random boss collectibles.
8858
+ */
8859
+ export declare function isStageWithRandomBossCollectible(stage: LevelStage): boolean;
8860
+
8861
+ /**
8862
+ * Helper function to check if the provided stage will spawn a locked door to Downpour/Dross after
8863
+ * defeating the boss.
8864
+ */
8865
+ export declare function isStageWithSecretExitToDownpour(stage: LevelStage): boolean;
8866
+
8867
+ /**
8868
+ * Helper function to check if the provided stage and stage type will spawn a spiked door to
8869
+ * Mausoleum/Gehenna after defeating the boss.
8870
+ */
8871
+ export declare function isStageWithSecretExitToMausoleum(stage: LevelStage, stageType: StageType): boolean;
8872
+
8873
+ /**
8874
+ * Helper function to check if the provided stage and stage type will spawn a wooden door to
8875
+ * Mines/Ashpit after defeating the boss.
8876
+ */
8877
+ export declare function isStageWithSecretExitToMines(stage: LevelStage, stageType: StageType): boolean;
8878
+
8879
+ /**
8880
+ * Helper function to check if the current stage is one that would create a trapdoor if We Need to
8881
+ * Go Deeper was used.
8882
+ */
8883
+ export declare function isStageWithShovelTrapdoors(stage: LevelStage, stageType: StageType): boolean;
8884
+
8885
+ /**
8886
+ * Helper function to check if the provided stage is one with a story boss. Specifically, this is
8887
+ * Depths 2 (Mom), Womb 2 (Mom's Heart / It Lives), Blue Womb (Hush), Sheol (Satan), Cathedral
8888
+ * (Isaac), Dark Room (Lamb), The Chest (Blue Baby), The Void (Delirium), and Home (Dogma / The
8889
+ * Beast).
8890
+ */
8891
+ export declare function isStageWithStoryBoss(stage: LevelStage): boolean;
8892
+
8832
8893
  /**
8833
8894
  * Helper function to determine if the specified entity type is an end-game story boss, like Isaac,
8834
8895
  * Blue Baby, Mega Satan, The Beast, and so on. This is useful because certain effects should only
@@ -9335,7 +9396,7 @@ export declare function logAllEntities(this: void, includeBackgroundEffects: boo
9335
9396
  /**
9336
9397
  * Helper function for printing out every grid entity (or filtered grid entity) in the current room.
9337
9398
  *
9338
- * @param includeWalls Optional. Whether or not to log the walls. Default is false.
9399
+ * @param includeWalls Optional. Whether oto log the walls. Default is false.
9339
9400
  * @param gridEntityTypeFilter Optional. If specified, will only log the given `GridEntityType`.
9340
9401
  * Default is undefined.
9341
9402
  */
@@ -12716,8 +12777,8 @@ declare class ModdedElementSets extends Feature {
12716
12777
  *
12717
12778
  * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
12718
12779
  *
12719
- * @param includeConditionalItems Whether or not collectibles that only grant flight conditionally
12720
- * should be included in the set (like Empty Vessel).
12780
+ * @param includeConditionalItems Whether collectibles that only grant flight conditionally should
12781
+ * be included in the set (like Empty Vessel).
12721
12782
  */
12722
12783
  getFlyingCollectibles(includeConditionalItems: boolean): ReadonlySet<CollectibleType>;
12723
12784
  /**
@@ -13058,7 +13119,7 @@ export declare class ModFeature {
13058
13119
  *
13059
13120
  * ```ts
13060
13121
  * <T extends boolean>(
13061
- * vanilla: T, // Whether or not this is a vanilla or custom callback.
13122
+ * vanilla: T, // Whether this is a vanilla or custom callback.
13062
13123
  * modCallback: T extends true ? ModCallback : ModCallbackCustom,
13063
13124
  * ...callbackArgs: unknown[] // This would be e.g. `pickup: EntityPickup` for the `POST_PICKUP_INIT` callback.
13064
13125
  * ) => boolean;
@@ -13066,7 +13127,7 @@ export declare class ModFeature {
13066
13127
  */
13067
13128
  protected shouldCallbackMethodsFire: (<T extends boolean>(vanilla: T, modCallback: T extends true ? ModCallback : ModCallbackCustom, ...callbackArgs: unknown[]) => boolean) | null;
13068
13129
  /**
13069
- * Whether or not the feature has registered its callbacks yet.
13130
+ * Whether the feature has registered its callbacks yet.
13070
13131
  *
13071
13132
  * This will almost always be equal to true unless you explicitly passed `false` to the second
13072
13133
  * argument of the constructor.
@@ -13438,8 +13499,8 @@ export declare const ONE_BY_ONE_ROOM_GRID_SIZE = 135;
13438
13499
  export declare function onEffectiveStage(...effectiveStages: LevelStage[]): boolean;
13439
13500
 
13440
13501
  /**
13441
- * Returns whether or not the player is on the "final floor" of the particular run. The final floor
13442
- * is defined as one that prevents the player from entering the I AM ERROR room on.
13502
+ * Returns whether the player is on the "final floor" of the particular run. The final floor is
13503
+ * defined as one that prevents the player from entering the I AM ERROR room on.
13443
13504
  *
13444
13505
  * For example, when using Undefined on The Chest, it has a 50% chance of teleporting the player to
13445
13506
  * the Secret Room and a 50% chance of teleporting the player to the Super Secret Room, because the
@@ -13448,7 +13509,7 @@ export declare function onEffectiveStage(...effectiveStages: LevelStage[]): bool
13448
13509
  export declare function onFinalFloor(): boolean;
13449
13510
 
13450
13511
  /**
13451
- * Returns whether or not the player is on the first floor of the particular run.
13512
+ * Returns whether the player is on the first floor of the particular run.
13452
13513
  *
13453
13514
  * This is tricky to determine because we have to handle the cases of Downpour/Dross 1 not being the
13454
13515
  * first floor and The Ascent.
@@ -13462,7 +13523,7 @@ export declare function onFirstFloor(): boolean;
13462
13523
  export declare function onRepentanceStage(): boolean;
13463
13524
 
13464
13525
  /**
13465
- * Whether or not the player is playing on a set seed (i.e. that they entered in a specific seed by
13526
+ * Whether the player is playing on a set seed (i.e. that they entered in a specific seed by
13466
13527
  * pressing tab on the character selection screen). When the player resets the game on a set seed,
13467
13528
  * the game will not switch to a different seed.
13468
13529
  */
@@ -13497,8 +13558,15 @@ export declare function onStageType(...stageTypes: StageType[]): boolean;
13497
13558
  export declare function onStageWithNaturalDevilRoom(): boolean;
13498
13559
 
13499
13560
  /**
13500
- * After defeating the boss on most stages, a random collectible will spawn from the Boss Room pool.
13501
- * However, this does not happen on Depths 2, Womb 2, and beyond.
13561
+ * Helper function to check if the current stage is one that will have a random collectible drop
13562
+ * upon defeating the boss of the floor.
13563
+ *
13564
+ * This happens on most stages but will not happen on Depths 2, Womb 2, Sheol, Cathedral, Dark Room,
13565
+ * The Chest, and Home (due to the presence of a story boss).
13566
+ *
13567
+ * Note that even though Delirium does not drop a random boss collectible, The Void is still
13568
+ * considered to be a stage that has a random boss collectible since all of the non-Delirium Boss
13569
+ * Rooms will drop random boss collectibles.
13502
13570
  */
13503
13571
  export declare function onStageWithRandomBossCollectible(): boolean;
13504
13572
 
@@ -13524,7 +13592,15 @@ export declare function onStageWithSecretExitToMines(): boolean;
13524
13592
  * Helper function to check if the current stage is one that would create a trapdoor if We Need to
13525
13593
  * Go Deeper was used.
13526
13594
  */
13527
- export declare function onStageWithShovelWorking(): boolean;
13595
+ export declare function onStageWithShovelTrapdoors(): boolean;
13596
+
13597
+ /**
13598
+ * Helper function to check if the current stage is one with a story boss. Specifically, this is
13599
+ * Depths 2 (Mom), Womb 2 (Mom's Heart / It Lives), Blue Womb (Hush), Sheol (Satan), Cathedral
13600
+ * (Isaac), Dark Room (Lamb), The Chest (Blue Baby), The Void (Delirium), and Home (Dogma / The
13601
+ * Beast).
13602
+ */
13603
+ export declare function onStageWithStoryBoss(): boolean;
13528
13604
 
13529
13605
  /**
13530
13606
  * For the purposes of this function, doors to Secret Rooms or Super Secret Rooms that have not been
@@ -13739,7 +13815,7 @@ export declare const PILL_NAME_TO_EFFECT_MAP: ReadonlyMap<string, PillEffect>;
13739
13815
  /**
13740
13816
  * Helper function to play the appropriate sound effect for a player after getting one or more
13741
13817
  * charges on their active item. (There is a different sound depending on whether the item is fully
13742
- * charged or not.)
13818
+ * charged.)
13743
13819
  *
13744
13820
  * @param player The player to play the sound effect for.
13745
13821
  * @param activeSlot Optional. The slot that was just charged. Default is `ActiveSlot.PRIMARY`.
@@ -14383,7 +14459,7 @@ export declare function removeAllCollectibles(collectibleType?: CollectibleType,
14383
14459
  *
14384
14460
  * @param crawlSpaceVariant Optional. If specified, will only remove the crawl spaces that match
14385
14461
  * this variant. Default is -1, which matches every variant.
14386
- * @param updateRoom Optional. Whether or not to update the room after the crawl spaces are removed.
14462
+ * @param updateRoom Optional. Whether to update the room after the crawl spaces are removed.
14387
14463
  * Default is false. For more information, see the description of the
14388
14464
  * `removeGridEntities` helper function.
14389
14465
  * @param cap Optional. If specified, will only remove the given amount of crawl spaces.
@@ -14563,8 +14639,8 @@ export declare function removeAllPills(pillColor?: PillColor, cap?: int): Entity
14563
14639
  *
14564
14640
  * @param pitVariant Optional. If specified, will only remove the pits that match this variant.
14565
14641
  * Default is -1, which matches every variant.
14566
- * @param updateRoom Optional. Whether or not to update the room after the pits are removed. Default
14567
- * is false. For more information, see the description of the `removeGridEntities`
14642
+ * @param updateRoom Optional. Whether to update the room after the pits are removed. Default is
14643
+ * false. For more information, see the description of the `removeGridEntities`
14568
14644
  * helper function.
14569
14645
  * @param cap Optional. If specified, will only remove the given amount of pits.
14570
14646
  * @returns The pits that were removed.
@@ -14589,9 +14665,9 @@ export declare function removeAllPlayerTrinkets(player: EntityPlayer): void;
14589
14665
  *
14590
14666
  * @param poopVariant Optional. If specified, will only remove the poops that match this variant.
14591
14667
  * Default is -1, which matches every variant.
14592
- * @param updateRoom Optional. Whether or not to update the room after the poops are removed.
14593
- * Default is false. For more information, see the description of the
14594
- * `removeGridEntities` helper function.
14668
+ * @param updateRoom Optional. Whether to update the room after the poops are removed. Default is
14669
+ * false. For more information, see the description of the `removeGridEntities`
14670
+ * helper function.
14595
14671
  * @param cap Optional. If specified, will only remove the given amount of poops.
14596
14672
  * @returns The poops that were removed.
14597
14673
  */
@@ -14602,8 +14678,8 @@ export declare function removeAllPoops(poopVariant?: PoopGridEntityVariant | -1,
14602
14678
  *
14603
14679
  * @param pressurePlateVariant Optional. If specified, will only remove the pressure plates that
14604
14680
  * match this variant. Default is -1, which matches every variant.
14605
- * @param updateRoom Optional. Whether or not to update the room after the pressure plates are
14606
- * removed. Default is false. For more information, see the description of the
14681
+ * @param updateRoom Optional. Whether to update the room after the pressure plates are removed.
14682
+ * Default is false. For more information, see the description of the
14607
14683
  * `removeGridEntities` helper function.
14608
14684
  * @param cap Optional. If specified, will only remove the given amount of pressure plates.
14609
14685
  * @returns The pressure plates that were removed.
@@ -14637,9 +14713,9 @@ export declare function removeAllRedHearts(cap?: int): EntityPickupHeart[];
14637
14713
  * Default is -1, which matches every variant. Note that this is not the same thing
14638
14714
  * as the `RockVariant` enum, since that only applies to `GridEntityType.ROCK`, and
14639
14715
  * other types of grid entities can be the `GridEntityRock` class.
14640
- * @param updateRoom Optional. Whether or not to update the room after the rocks are removed.
14641
- * Default is false. For more information, see the description of the
14642
- * `removeGridEntities` helper function.
14716
+ * @param updateRoom Optional. Whether to update the room after the rocks are removed. Default is
14717
+ * false. For more information, see the description of the `removeGridEntities`
14718
+ * helper function.
14643
14719
  * @param cap Optional. If specified, will only remove the given amount of rocks.
14644
14720
  * @returns The rocks that were removed.
14645
14721
  */
@@ -14672,9 +14748,9 @@ export declare function removeAllSlots(slotVariant?: SlotVariant | -1, subType?:
14672
14748
  *
14673
14749
  * @param variant Optional. If specified, will only remove the spikes that match this variant.
14674
14750
  * Default is -1, which matches every variant.
14675
- * @param updateRoom Optional. Whether or not to update the room after the spikes are removed.
14676
- * Default is false. For more information, see the description of the
14677
- * `removeGridEntities` helper function.
14751
+ * @param updateRoom Optional. Whether to update the room after the spikes are removed. Default is
14752
+ * false. For more information, see the description of the `removeGridEntities`
14753
+ * helper function.
14678
14754
  * @param cap Optional. If specified, will only remove the given amount of spikes.
14679
14755
  * @returns The spikes that were removed.
14680
14756
  */
@@ -14697,9 +14773,9 @@ export declare function removeAllTears(tearVariant?: TearVariant | -1, subType?:
14697
14773
  *
14698
14774
  * @param variant Optional. If specified, will only remove the teleporters that match this variant.
14699
14775
  * Default is -1, which matches every variant.
14700
- * @param updateRoom Optional. Whether or not to update the room after the teleporters are removed.
14701
- * Default is false. For more information, see the description of the
14702
- * `removeGridEntities` helper function.
14776
+ * @param updateRoom Optional. Whether to update the room after the teleporters are removed. Default
14777
+ * is false. For more information, see the description of the `removeGridEntities`
14778
+ * helper function.
14703
14779
  * @param cap Optional. If specified, will only remove the given amount of teleporters.
14704
14780
  * @returns The teleporters that were removed.
14705
14781
  */
@@ -14710,8 +14786,8 @@ export declare function removeAllTeleporters(variant?: number, updateRoom?: bool
14710
14786
  *
14711
14787
  * @param variant Optional. If specified, will only remove the TNTs that match this variant. Default
14712
14788
  * is -1, which matches every variant.
14713
- * @param updateRoom Optional. Whether or not to update the room after the TNTs are removed. Default
14714
- * is false. For more information, see the description of the `removeGridEntities`
14789
+ * @param updateRoom Optional. Whether to update the room after the TNTs are removed. Default is
14790
+ * false. For more information, see the description of the `removeGridEntities`
14715
14791
  * helper function.
14716
14792
  * @param cap Optional. If specified, will only remove the given amount of TNTs.
14717
14793
  * @returns The TNTs that were removed.
@@ -14723,9 +14799,9 @@ export declare function removeAllTNT(variant?: number, updateRoom?: boolean, cap
14723
14799
  *
14724
14800
  * @param trapdoorVariant Optional. If specified, will only remove the trapdoors that match this
14725
14801
  * variant. Default is -1, which matches every variant.
14726
- * @param updateRoom Optional. Whether or not to update the room after the trapdoors are removed.
14727
- * Default is false. For more information, see the description of the
14728
- * `removeGridEntities` helper function.
14802
+ * @param updateRoom Optional. Whether to update the room after the trapdoors are removed. Default
14803
+ * is false. For more information, see the description of the `removeGridEntities`
14804
+ * helper function.
14729
14805
  * @param cap Optional. If specified, will only remove the given amount of trapdoors.
14730
14806
  * @returns The trapdoors that were removed.
14731
14807
  */
@@ -14856,7 +14932,7 @@ export declare function removeFlag<T extends BitFlag | BitFlag128>(flags: T | Bi
14856
14932
  * Helper function to remove all of the grid entities in the supplied array.
14857
14933
  *
14858
14934
  * @param gridEntities The array of grid entities to remove.
14859
- * @param updateRoom Whether or not to update the room after the grid entities are removed. This is
14935
+ * @param updateRoom Whether to update the room after the grid entities are removed. This is
14860
14936
  * generally a good idea because if the room is not updated, you will be unable to
14861
14937
  * spawn another grid entity on the same tile until a frame has passed. However,
14862
14938
  * doing this is expensive, since it involves a call to `Isaac.GetRoomEntities`,
@@ -14874,11 +14950,11 @@ export declare function removeGridEntities<T extends AnyGridEntity>(gridEntities
14874
14950
  * (`EffectVariant.DEVIL` (6) or `EffectVariant.ANGEL` (9), respectively.)
14875
14951
  *
14876
14952
  * @param gridEntityOrGridIndex The grid entity or grid index to remove.
14877
- * @param updateRoom Whether or not to update the room after the grid entity is removed. This is
14878
- * generally a good idea because if the room is not updated, you will be unable to
14879
- * spawn another grid entity on the same tile until a frame has passed. However,
14880
- * doing this is expensive, since it involves a call to `Isaac.GetRoomEntities`,
14881
- * so set this to false if you need to run this function multiple times.
14953
+ * @param updateRoom Whether to update the room after the grid entity is removed. This is generally
14954
+ * a good idea because if the room is not updated, you will be unable to spawn
14955
+ * another grid entity on the same tile until a frame has passed. However, doing
14956
+ * this is expensive, since it involves a call to `Isaac.GetRoomEntities`, so set
14957
+ * this to false if you need to run this function multiple times.
14882
14958
  */
14883
14959
  export declare function removeGridEntity(gridEntityOrGridIndex: GridEntity | int, updateRoom: boolean): void;
14884
14960
 
@@ -15175,8 +15251,8 @@ declare class RunInNFrames extends Feature {
15175
15251
  *
15176
15252
  * @param func The function to run.
15177
15253
  * @param numGameFrames The amount of game frames to wait before running the function.
15178
- * @param cancelIfRoomChanges Optional. Whether or not to cancel running the function if a new
15179
- * room is loaded in the interim. Default is false.
15254
+ * @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
15255
+ * loaded in the interim. Default is false.
15180
15256
  */
15181
15257
  runInNGameFrames(func: () => void, numGameFrames: int, cancelIfRoomChanges?: boolean): void;
15182
15258
  /**
@@ -15193,8 +15269,8 @@ declare class RunInNFrames extends Feature {
15193
15269
  *
15194
15270
  * @param func The function to run.
15195
15271
  * @param numRenderFrames The amount of render frames to wait before running the function.
15196
- * @param cancelIfRoomChanges Optional. Whether or not to cancel running the function if a new
15197
- * room is loaded in the interim. Default is false.
15272
+ * @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
15273
+ * loaded in the interim. Default is false.
15198
15274
  */
15199
15275
  runInNRenderFrames(func: () => void, numRenderFrames: int, cancelIfRoomChanges?: boolean): void;
15200
15276
  /**
@@ -15228,8 +15304,8 @@ declare class RunInNFrames extends Feature {
15228
15304
  * In order to use this function, you must upgrade your mod with `ISCFeature.RUN_IN_N_FRAMES`.
15229
15305
  *
15230
15306
  * @param func The function to run.
15231
- * @param cancelIfRoomChanges Optional. Whether or not to cancel running the function if a new
15232
- * room is loaded in the interim. Default is false.
15307
+ * @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
15308
+ * loaded in the interim. Default is false.
15233
15309
  */
15234
15310
  runNextGameFrame(func: () => void, cancelIfRoomChanges?: boolean): void;
15235
15311
  /**
@@ -15243,8 +15319,8 @@ declare class RunInNFrames extends Feature {
15243
15319
  * In order to use this function, you must upgrade your mod with `ISCFeature.RUN_IN_N_FRAMES`.
15244
15320
  *
15245
15321
  * @param func The function to run.
15246
- * @param cancelIfRoomChanges Optional. Whether or not to cancel running the function if a new
15247
- * room is loaded in the interim. Default is false.
15322
+ * @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
15323
+ * loaded in the interim. Default is false.
15248
15324
  */
15249
15325
  runNextRenderFrame(func: () => void, cancelIfRoomChanges?: boolean): void;
15250
15326
  /**
@@ -15262,10 +15338,10 @@ declare class RunInNFrames extends Feature {
15262
15338
  *
15263
15339
  * @param func The function to repeatedly run on an interval.
15264
15340
  * @param numGameFrames The amount of game frames to wait between each run.
15265
- * @param runImmediately Whether or not to execute the function right now before waiting for the
15341
+ * @param runImmediately Whether to execute the function right now before waiting for the
15266
15342
  * interval.
15267
- * @param cancelIfRoomChanges Optional. Whether or not to cancel running the function if a new
15268
- * room is loaded in the interim. Default is false.
15343
+ * @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
15344
+ * loaded in the interim. Default is false.
15269
15345
  */
15270
15346
  setIntervalGameFrames(func: () => boolean, numGameFrames: int, runImmediately: boolean, cancelIfRoomChanges?: boolean): void;
15271
15347
  /**
@@ -15283,10 +15359,10 @@ declare class RunInNFrames extends Feature {
15283
15359
  *
15284
15360
  * @param func The function to repeatedly run on an interval.
15285
15361
  * @param numRenderFrames The amount of game frames to wait between each run.
15286
- * @param runImmediately Whether or not to execute the function right now before waiting for the
15362
+ * @param runImmediately Whether to execute the function right now before waiting for the
15287
15363
  * interval.
15288
- * @param cancelIfRoomChanges Optional. Whether or not to cancel running the function if a new
15289
- * room is loaded in the interim. Default is false.
15364
+ * @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
15365
+ * loaded in the interim. Default is false.
15290
15366
  */
15291
15367
  setIntervalRenderFrames(func: () => boolean, numRenderFrames: int, runImmediately: boolean, cancelIfRoomChanges?: boolean): void;
15292
15368
  }
@@ -15370,8 +15446,8 @@ declare class SaveDataManager extends Feature {
15370
15446
  */
15371
15447
  private readonly saveDataDefaultsMap;
15372
15448
  /**
15373
- * Each mod feature can optionally provide a function that can control whether or not the save
15374
- * data is written to disk.
15449
+ * Each mod feature can optionally provide a function that can control whether the save data is
15450
+ * written to disk.
15375
15451
  */
15376
15452
  private readonly saveDataConditionalFuncMap;
15377
15453
  /**
@@ -15714,7 +15790,7 @@ export declare function serializeVector(vector: Vector): SerializedVector;
15714
15790
  * @param activeSlot Optional. The slot to set. Default is `ActiveSlot.PRIMARY`.
15715
15791
  * @param charge Optional. The argument of charges to set. If not specified, the item will be set
15716
15792
  * with maximum charges.
15717
- * @param keepInPools Optional. Whether or not to remove the item from pools. Default is false.
15793
+ * @param keepInPools Optional. Whether to remove the item from pools. Default is false.
15718
15794
  */
15719
15795
  export declare function setActiveItem(player: EntityPlayer, collectibleType: CollectibleType, activeSlot?: ActiveSlot, charge?: int, keepInPools?: boolean): void;
15720
15796
 
@@ -15747,7 +15823,7 @@ export declare function setAllArrayElements<T>(array: T[], value: T): void;
15747
15823
  * This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
15748
15824
  * the changes will be immediately visible.
15749
15825
  *
15750
- * This function automatically accounts for whether or not MinimapAPI is being used.
15826
+ * This function automatically accounts for if MinimapAPI is being used.
15751
15827
  */
15752
15828
  export declare function setAllDisplayFlags(displayFlags: BitFlags<DisplayFlag>): void;
15753
15829
 
@@ -15772,7 +15848,7 @@ export declare function setBackdrop(backdropType: BackdropType): void;
15772
15848
  * The method used in this function was discovered by im_tem.
15773
15849
  *
15774
15850
  * @param player The player to apply or remove the blindfold state from.
15775
- * @param enabled Whether or not to apply or remove the blindfold.
15851
+ * @param enabled Whether to apply or remove the blindfold.
15776
15852
  * @param modifyCostume Optional. Whether to add or remove the blindfold costume. Default is true.
15777
15853
  */
15778
15854
  export declare function setBlindfold(player: EntityPlayer, enabled: boolean, modifyCostume?: boolean): void;
@@ -15897,7 +15973,7 @@ export declare function setEntityVelocities(entityVelocities: Map<PtrHash, Vecto
15897
15973
  * This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
15898
15974
  * the changes will be immediately visible.
15899
15975
  *
15900
- * This function automatically accounts for whether or not MinimapAPI is being used.
15976
+ * This function automatically accounts for if MinimapAPI is being used.
15901
15977
  *
15902
15978
  * @param displayFlagsMap A map of the display flags that is indexed by the room's safe grid index.
15903
15979
  */
@@ -15963,10 +16039,10 @@ export declare function setRoomCleared(): void;
15963
16039
  export declare function setRoomData(roomGridIndex: int, roomData: RoomConfig): void;
15964
16040
 
15965
16041
  /**
15966
- * Helper function to set a particular room's minimap display flags (e.g. whether or not it is
15967
- * visible and so on).
16042
+ * Helper function to set a particular room's minimap display flags (e.g. whether it is visible and
16043
+ * so on).
15968
16044
  *
15969
- * This function automatically accounts for whether or not MinimapAPI is being used.
16045
+ * This function automatically accounts for if MinimapAPI is being used.
15970
16046
  *
15971
16047
  * @param roomGridIndex Set to undefined to use the current room index.
15972
16048
  * @param displayFlags The bit flags value to set. (See the `DisplayFlag` enum.)
@@ -16003,9 +16079,9 @@ export declare function setSpriteOpacity(sprite: Sprite, alpha: float): void;
16003
16079
  *
16004
16080
  * @param stage The stage number to warp to.
16005
16081
  * @param stageType The stage type to warp to.
16006
- * @param reseed Optional. Whether or not to reseed the floor upon arrival. Default is false. Set
16007
- * this to true if you are warping to the same stage but a different stage type (or
16008
- * else the floor layout will be identical to the old floor).
16082
+ * @param reseed Optional. Whether to reseed the floor upon arrival. Default is false. Set this to
16083
+ * true if you are warping to the same stage but a different stage type (or else the
16084
+ * floor layout will be identical to the old floor).
16009
16085
  */
16010
16086
  export declare function setStage(stage: LevelStage, stageType: StageType, reseed?: boolean): void;
16011
16087
 
@@ -16618,7 +16694,7 @@ declare class SpawnRockAltRewards extends Feature {
16618
16694
  * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided,
16619
16695
  * the `RNG.Next` method will be called. Default is `getRandomSeed()`. Normally,
16620
16696
  * you should pass the `InitSeed` of the grid entity that was broken.
16621
- * @returns Whether or not this function spawned something.
16697
+ * @returns Whether this function spawned something.
16622
16698
  */
16623
16699
  spawnRockAltReward(positionOrGridIndex: Vector | int, rockAltType: RockAltType, seedOrRNG?: Seed | RNG): boolean;
16624
16700
  /**
@@ -16784,8 +16860,8 @@ declare class StageHistory extends Feature {
16784
16860
  *
16785
16861
  * In order to use this function, you must upgrade your mod with `ISCFeature.STAGE_HISTORY`.
16786
16862
  *
16787
- * @param upwards Whether or not the player should go up to Cathedral in the case of being on Womb
16788
- * 2. Default is false.
16863
+ * @param upwards Whether the player should go up to Cathedral in the case of being on Womb 2.
16864
+ * Default is false.
16789
16865
  */
16790
16866
  getNextStageTypeWithHistory(upwards?: boolean): StageType;
16791
16867
  /**
@@ -17240,9 +17316,9 @@ export declare const VectorZero: Readonly<Vector>;
17240
17316
  export declare type WeightedArray<T> = Array<[T, float]>;
17241
17317
 
17242
17318
  /**
17243
- * Assuming that we are on the frame of fatal damage, this function returns whether or not
17244
- * Mysterious Paper would rotate to Missing Poster on the frame that the "Game Over" screen would
17245
- * appear (which would subsequently save the player from fatal damage).
17319
+ * Assuming that we are on the frame of fatal damage, this function returns whether Mysterious Paper
17320
+ * would rotate to Missing Poster on the frame that the "Game Over" screen would appear (which would
17321
+ * subsequently save the player from fatal damage).
17246
17322
  *
17247
17323
  * Mysterious Paper rotates between the 4 items on every frame, in order. The formula for whether
17248
17324
  * Mysterious Paper be Missing Power is: `gameFrameCount % 4 === 3`