isaacscript-common 31.7.2 → 31.8.0

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 (111) hide show
  1. package/dist/index.rollup.d.ts +215 -153
  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/input.d.ts +4 -4
  41. package/dist/src/functions/input.lua +4 -4
  42. package/dist/src/functions/logEntities.d.ts +1 -1
  43. package/dist/src/functions/logEntities.lua +1 -1
  44. package/dist/src/functions/minimap.d.ts +17 -20
  45. package/dist/src/functions/minimap.d.ts.map +1 -1
  46. package/dist/src/functions/minimap.lua +17 -20
  47. package/dist/src/functions/nextStage.d.ts +2 -2
  48. package/dist/src/functions/nextStage.lua +2 -2
  49. package/dist/src/functions/pills.d.ts +2 -2
  50. package/dist/src/functions/pills.lua +2 -2
  51. package/dist/src/functions/playerHealth.d.ts +4 -4
  52. package/dist/src/functions/playerHealth.lua +4 -4
  53. package/dist/src/functions/playerIndex.d.ts +2 -3
  54. package/dist/src/functions/playerIndex.d.ts.map +1 -1
  55. package/dist/src/functions/playerIndex.lua +2 -3
  56. package/dist/src/functions/players.d.ts +5 -5
  57. package/dist/src/functions/players.lua +5 -5
  58. package/dist/src/functions/pocketItems.d.ts +5 -5
  59. package/dist/src/functions/pocketItems.lua +5 -5
  60. package/dist/src/functions/revive.d.ts +3 -3
  61. package/dist/src/functions/revive.lua +3 -3
  62. package/dist/src/functions/rooms.d.ts +7 -7
  63. package/dist/src/functions/rooms.lua +7 -7
  64. package/dist/src/functions/run.d.ts +1 -1
  65. package/dist/src/functions/run.lua +1 -1
  66. package/dist/src/functions/set.d.ts +1 -1
  67. package/dist/src/functions/set.lua +1 -1
  68. package/dist/src/functions/stage.d.ts +64 -7
  69. package/dist/src/functions/stage.d.ts.map +1 -1
  70. package/dist/src/functions/stage.lua +80 -16
  71. package/dist/src/functions/trinkets.d.ts +1 -1
  72. package/dist/src/functions/trinkets.lua +1 -1
  73. package/package.json +2 -2
  74. package/src/classes/ModFeature.ts +2 -2
  75. package/src/classes/callbacks/PostPlayerFatalDamage.ts +1 -1
  76. package/src/classes/callbacks/PostUsePillFilter.ts +2 -2
  77. package/src/classes/features/callbackLogic/CustomGridEntities.ts +1 -1
  78. package/src/classes/features/other/CustomItemPools.ts +1 -1
  79. package/src/classes/features/other/CustomTrapdoors.ts +2 -2
  80. package/src/classes/features/other/DebugDisplay.ts +18 -18
  81. package/src/classes/features/other/DisableInputs.ts +2 -2
  82. package/src/classes/features/other/ModdedElementSets.ts +2 -2
  83. package/src/classes/features/other/RunInNFrames.ts +15 -15
  84. package/src/classes/features/other/SaveDataManager.ts +2 -2
  85. package/src/classes/features/other/SpawnRockAltRewards.ts +1 -1
  86. package/src/classes/features/other/StageHistory.ts +2 -2
  87. package/src/classes/features/other/extraConsoleCommands/commands.ts +1 -1
  88. package/src/functions/array.ts +4 -4
  89. package/src/functions/cards.ts +1 -1
  90. package/src/functions/charge.ts +1 -1
  91. package/src/functions/collectibles.ts +3 -3
  92. package/src/functions/debugFunctions.ts +2 -2
  93. package/src/functions/deepCopy.ts +3 -3
  94. package/src/functions/globals.ts +1 -1
  95. package/src/functions/gridEntities.ts +6 -6
  96. package/src/functions/gridEntitiesSpecific.ts +22 -22
  97. package/src/functions/input.ts +4 -4
  98. package/src/functions/logEntities.ts +1 -1
  99. package/src/functions/minimap.ts +17 -20
  100. package/src/functions/nextStage.ts +2 -2
  101. package/src/functions/pills.ts +2 -2
  102. package/src/functions/playerHealth.ts +4 -4
  103. package/src/functions/playerIndex.ts +2 -3
  104. package/src/functions/players.ts +5 -5
  105. package/src/functions/pocketItems.ts +5 -5
  106. package/src/functions/revive.ts +3 -3
  107. package/src/functions/rooms.ts +7 -7
  108. package/src/functions/run.ts +1 -1
  109. package/src/functions/set.ts +1 -1
  110. package/src/functions/stage.ts +139 -33
  111. package/src/functions/trinkets.ts +1 -1
@@ -377,7 +377,7 @@ export class DebugDisplay extends Feature {
377
377
  *
378
378
  * @param force Optional. A boolean that represents the value to force the display to. For
379
379
  * example, you can specify true to always make the display turn on, regardless of
380
- * whether or not it is already on.
380
+ * whether it is already on.
381
381
  */
382
382
  @Exported
383
383
  public togglePlayerDisplay(force?: boolean): void {
@@ -391,7 +391,7 @@ export class DebugDisplay extends Feature {
391
391
  *
392
392
  * @param force Optional. A boolean that represents the value to force the display to. For
393
393
  * example, you can specify true to always make the display turn on, regardless of
394
- * whether or not it is already on.
394
+ * whether it is already on.
395
395
  */
396
396
  @Exported
397
397
  public toggleTearDisplay(force?: boolean): void {
@@ -406,7 +406,7 @@ export class DebugDisplay extends Feature {
406
406
  *
407
407
  * @param force Optional. A boolean that represents the value to force the display to. For
408
408
  * example, you can specify true to always make the display turn on, regardless of
409
- * whether or not it is already on.
409
+ * whether it is already on.
410
410
  */
411
411
  @Exported
412
412
  public toggleFamiliarDisplay(force?: boolean): void {
@@ -420,7 +420,7 @@ export class DebugDisplay extends Feature {
420
420
  *
421
421
  * @param force Optional. A boolean that represents the value to force the display to. For
422
422
  * example, you can specify true to always make the display turn on, regardless of
423
- * whether or not it is already on.
423
+ * whether it is already on.
424
424
  */
425
425
  @Exported
426
426
  public toggleBombDisplay(force?: boolean): void {
@@ -434,7 +434,7 @@ export class DebugDisplay extends Feature {
434
434
  *
435
435
  * @param force Optional. A boolean that represents the value to force the display to. For
436
436
  * example, you can specify true to always make the display turn on, regardless of
437
- * whether or not it is already on.
437
+ * whether it is already on.
438
438
  */
439
439
  @Exported
440
440
  public togglePickupDisplay(force?: boolean): void {
@@ -448,7 +448,7 @@ export class DebugDisplay extends Feature {
448
448
  *
449
449
  * @param force Optional. A boolean that represents the value to force the display to. For
450
450
  * example, you can specify true to always make the display turn on, regardless of
451
- * whether or not it is already on.
451
+ * whether it is already on.
452
452
  */
453
453
  @Exported
454
454
  public toggleSlotDisplay(force?: boolean): void {
@@ -462,7 +462,7 @@ export class DebugDisplay extends Feature {
462
462
  *
463
463
  * @param force Optional. A boolean that represents the value to force the display to. For
464
464
  * example, you can specify true to always make the display turn on, regardless of
465
- * whether or not it is already on.
465
+ * whether it is already on.
466
466
  */
467
467
  @Exported
468
468
  public toggleLaserDisplay(force?: boolean): void {
@@ -476,7 +476,7 @@ export class DebugDisplay extends Feature {
476
476
  *
477
477
  * @param force Optional. A boolean that represents the value to force the display to. For
478
478
  * example, you can specify true to always make the display turn on, regardless of
479
- * whether or not it is already on.
479
+ * whether it is already on.
480
480
  */
481
481
  @Exported
482
482
  public toggleKnifeDisplay(force?: boolean): void {
@@ -491,7 +491,7 @@ export class DebugDisplay extends Feature {
491
491
  *
492
492
  * @param force Optional. A boolean that represents the value to force the display to. For
493
493
  * example, you can specify true to always make the display turn on, regardless of
494
- * whether or not it is already on.
494
+ * whether it is already on.
495
495
  */
496
496
  @Exported
497
497
  public toggleProjectileDisplay(force?: boolean): void {
@@ -505,7 +505,7 @@ export class DebugDisplay extends Feature {
505
505
  *
506
506
  * @param force Optional. A boolean that represents the value to force the display to. For
507
507
  * example, you can specify true to always make the display turn on, regardless of
508
- * whether or not it is already on.
508
+ * whether it is already on.
509
509
  */
510
510
  @Exported
511
511
  public toggleEffectDisplay(force?: boolean): void {
@@ -519,7 +519,7 @@ export class DebugDisplay extends Feature {
519
519
  *
520
520
  * @param force Optional. A boolean that represents the value to force the display to. For
521
521
  * example, you can specify true to always make the display turn on, regardless of
522
- * whether or not it is already on.
522
+ * whether it is already on.
523
523
  */
524
524
  @Exported
525
525
  public toggleNPCDisplay(force?: boolean): void {
@@ -533,7 +533,7 @@ export class DebugDisplay extends Feature {
533
533
  *
534
534
  * @param force Optional. A boolean that represents the value to force the display to. For
535
535
  * example, you can specify true to always make the display turn on, regardless of
536
- * whether or not it is already on.
536
+ * whether it is already on.
537
537
  */
538
538
  @Exported
539
539
  public toggleRockDisplay(force?: boolean): void {
@@ -547,7 +547,7 @@ export class DebugDisplay extends Feature {
547
547
  *
548
548
  * @param force Optional. A boolean that represents the value to force the display to. For
549
549
  * example, you can specify true to always make the display turn on, regardless of
550
- * whether or not it is already on.
550
+ * whether it is already on.
551
551
  */
552
552
  @Exported
553
553
  public togglePitDisplay(force?: boolean): void {
@@ -561,7 +561,7 @@ export class DebugDisplay extends Feature {
561
561
  *
562
562
  * @param force Optional. A boolean that represents the value to force the display to. For
563
563
  * example, you can specify true to always make the display turn on, regardless of
564
- * whether or not it is already on.
564
+ * whether it is already on.
565
565
  */
566
566
  @Exported
567
567
  public toggleSpikesDisplay(force?: boolean): void {
@@ -575,7 +575,7 @@ export class DebugDisplay extends Feature {
575
575
  *
576
576
  * @param force Optional. A boolean that represents the value to force the display to. For
577
577
  * example, you can specify true to always make the display turn on, regardless of
578
- * whether or not it is already on.
578
+ * whether it is already on.
579
579
  */
580
580
  @Exported
581
581
  public toggleTNTDisplay(force?: boolean): void {
@@ -589,7 +589,7 @@ export class DebugDisplay extends Feature {
589
589
  *
590
590
  * @param force Optional. A boolean that represents the value to force the display to. For
591
591
  * example, you can specify true to always make the display turn on, regardless of
592
- * whether or not it is already on.
592
+ * whether it is already on.
593
593
  */
594
594
  @Exported
595
595
  public togglePoopDisplay(force?: boolean): void {
@@ -603,7 +603,7 @@ export class DebugDisplay extends Feature {
603
603
  *
604
604
  * @param force Optional. A boolean that represents the value to force the display to. For
605
605
  * example, you can specify true to always make the display turn on, regardless of
606
- * whether or not it is already on.
606
+ * whether it is already on.
607
607
  */
608
608
  @Exported
609
609
  public toggleDoorDisplay(force?: boolean): void {
@@ -618,7 +618,7 @@ export class DebugDisplay extends Feature {
618
618
  *
619
619
  * @param force Optional. A boolean that represents the value to force the display to. For
620
620
  * example, you can specify true to always make the display turn on, regardless of
621
- * whether or not it is already on.
621
+ * whether it is already on.
622
622
  */
623
623
  @Exported
624
624
  public togglePressurePlateDisplay(force?: boolean): void {
@@ -12,8 +12,8 @@ const v = {
12
12
  run: {
13
13
  /**
14
14
  * Glowing Hour Glass support is disabled by default since it can cause bugs with extra-gameplay
15
- * features. (For example, whether the player should be able to move or not should often not be
16
- * reset by the Glowing Hour Glass.)
15
+ * features. (For example, whether the player should be able to move is not something that
16
+ * should be reset by the Glowing Hour Glass.)
17
17
  */
18
18
  __ignoreGlowingHourGlass: true,
19
19
 
@@ -699,8 +699,8 @@ export class ModdedElementSets extends Feature {
699
699
  *
700
700
  * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
701
701
  *
702
- * @param includeConditionalItems Whether or not collectibles that only grant flight conditionally
703
- * should be included in the set (like Empty Vessel).
702
+ * @param includeConditionalItems Whether collectibles that only grant flight conditionally should
703
+ * be included in the set (like Empty Vessel).
704
704
  */
705
705
  @Exported
706
706
  public getFlyingCollectibles(
@@ -19,7 +19,7 @@ interface QueuedFunction {
19
19
  /**
20
20
  * Used for `setInterval` functions.
21
21
  *
22
- * The return value is whether or not to continue the function from firing.
22
+ * The return value is whether to continue the function from firing.
23
23
  */
24
24
  interface IntervalFunction extends QueuedFunction {
25
25
  func: () => boolean;
@@ -125,8 +125,8 @@ export class RunInNFrames extends Feature {
125
125
  *
126
126
  * @param func The function to run.
127
127
  * @param numGameFrames The amount of game frames to wait before running the function.
128
- * @param cancelIfRoomChanges Optional. Whether or not to cancel running the function if a new
129
- * room is loaded in the interim. Default is false.
128
+ * @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
129
+ * loaded in the interim. Default is false.
130
130
  */
131
131
  @Exported
132
132
  public runInNGameFrames(
@@ -161,8 +161,8 @@ export class RunInNFrames extends Feature {
161
161
  *
162
162
  * @param func The function to run.
163
163
  * @param numRenderFrames The amount of render frames to wait before running the function.
164
- * @param cancelIfRoomChanges Optional. Whether or not to cancel running the function if a new
165
- * room is loaded in the interim. Default is false.
164
+ * @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
165
+ * loaded in the interim. Default is false.
166
166
  */
167
167
  @Exported
168
168
  public runInNRenderFrames(
@@ -214,8 +214,8 @@ export class RunInNFrames extends Feature {
214
214
  * In order to use this function, you must upgrade your mod with `ISCFeature.RUN_IN_N_FRAMES`.
215
215
  *
216
216
  * @param func The function to run.
217
- * @param cancelIfRoomChanges Optional. Whether or not to cancel running the function if a new
218
- * room is loaded in the interim. Default is false.
217
+ * @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
218
+ * loaded in the interim. Default is false.
219
219
  */
220
220
  @Exported
221
221
  public runNextGameFrame(func: () => void, cancelIfRoomChanges = false): void {
@@ -233,8 +233,8 @@ export class RunInNFrames extends Feature {
233
233
  * In order to use this function, you must upgrade your mod with `ISCFeature.RUN_IN_N_FRAMES`.
234
234
  *
235
235
  * @param func The function to run.
236
- * @param cancelIfRoomChanges Optional. Whether or not to cancel running the function if a new
237
- * room is loaded in the interim. Default is false.
236
+ * @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
237
+ * loaded in the interim. Default is false.
238
238
  */
239
239
  @Exported
240
240
  public runNextRenderFrame(
@@ -259,10 +259,10 @@ export class RunInNFrames extends Feature {
259
259
  *
260
260
  * @param func The function to repeatedly run on an interval.
261
261
  * @param numGameFrames The amount of game frames to wait between each run.
262
- * @param runImmediately Whether or not to execute the function right now before waiting for the
262
+ * @param runImmediately Whether to execute the function right now before waiting for the
263
263
  * interval.
264
- * @param cancelIfRoomChanges Optional. Whether or not to cancel running the function if a new
265
- * room is loaded in the interim. Default is false.
264
+ * @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
265
+ * loaded in the interim. Default is false.
266
266
  */
267
267
  @Exported
268
268
  public setIntervalGameFrames(
@@ -306,10 +306,10 @@ export class RunInNFrames extends Feature {
306
306
  *
307
307
  * @param func The function to repeatedly run on an interval.
308
308
  * @param numRenderFrames The amount of game frames to wait between each run.
309
- * @param runImmediately Whether or not to execute the function right now before waiting for the
309
+ * @param runImmediately Whether to execute the function right now before waiting for the
310
310
  * interval.
311
- * @param cancelIfRoomChanges Optional. Whether or not to cancel running the function if a new
312
- * room is loaded in the interim. Default is false.
311
+ * @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
312
+ * loaded in the interim. Default is false.
313
313
  */
314
314
  @Exported
315
315
  public setIntervalRenderFrames(
@@ -57,8 +57,8 @@ export class SaveDataManager extends Feature {
57
57
  private readonly saveDataDefaultsMap = new LuaMap<string, SaveData>();
58
58
 
59
59
  /**
60
- * Each mod feature can optionally provide a function that can control whether or not the save
61
- * data is written to disk.
60
+ * Each mod feature can optionally provide a function that can control whether the save data is
61
+ * written to disk.
62
62
  */
63
63
  private readonly saveDataConditionalFuncMap = new LuaMap<
64
64
  string,
@@ -98,7 +98,7 @@ export class SpawnRockAltRewards extends Feature {
98
98
  * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided,
99
99
  * the `RNG.Next` method will be called. Default is `getRandomSeed()`. Normally,
100
100
  * you should pass the `InitSeed` of the grid entity that was broken.
101
- * @returns Whether or not this function spawned something.
101
+ * @returns Whether this function spawned something.
102
102
  */
103
103
  @Exported
104
104
  public spawnRockAltReward(
@@ -53,8 +53,8 @@ export class StageHistory extends Feature {
53
53
  *
54
54
  * In order to use this function, you must upgrade your mod with `ISCFeature.STAGE_HISTORY`.
55
55
  *
56
- * @param upwards Whether or not the player should go up to Cathedral in the case of being on Womb
57
- * 2. Default is false.
56
+ * @param upwards Whether the player should go up to Cathedral in the case of being on Womb 2.
57
+ * Default is false.
58
58
  */
59
59
  @Exported
60
60
  public getNextStageTypeWithHistory(upwards = false): StageType {
@@ -579,7 +579,7 @@ export function dirtyBedroom(): void {
579
579
  warpToRoomType(RoomType.DIRTY_BEDROOM);
580
580
  }
581
581
 
582
- /** Toggles whether or not curses can appear. */
582
+ /** Toggles whether curses can appear. */
583
583
  export function disableCurses(): void {
584
584
  v.persistent.disableCurses = !v.persistent.disableCurses;
585
585
  printEnabled(!v.persistent.disableCurses, "curses");
@@ -151,7 +151,7 @@ export function arrayRemoveIndex<T>(
151
151
  *
152
152
  * This function is variadic, meaning that you can specify N arguments to remove N elements.
153
153
  *
154
- * @returns Whether or not any array elements were removed.
154
+ * @returns Whether any array elements were removed.
155
155
  */
156
156
  export function arrayRemoveIndexInPlace<T>(
157
157
  array: T[],
@@ -278,7 +278,7 @@ export function filterMap<OldT, NewT>(
278
278
  * From: https://github.com/firstandthird/combinations/blob/master/index.js
279
279
  *
280
280
  * @param array The array to get the combinations of.
281
- * @param includeEmptyArray Whether or not to include an empty array in the combinations.
281
+ * @param includeEmptyArray Whether to include an empty array in the combinations.
282
282
  * @param min Optional. The minimum number of elements to include in each combination. Default is 1.
283
283
  * @param max Optional. The maximum number of elements to include in each combination. Default is
284
284
  * the length of the array.
@@ -437,8 +437,8 @@ export function getRandomArrayIndex<T>(
437
437
  * - the table has no keys (i.e. an "empty" table)
438
438
  *
439
439
  * @param object The object to analyze.
440
- * @param ensureContiguousValues Optional. Whether or not the Lua table has to have all contiguous
441
- * keys in order to be considered an array. Default is true.
440
+ * @param ensureContiguousValues Optional. Whether the Lua table has to have all contiguous keys in
441
+ * order to be considered an array. Default is true.
442
442
  */
443
443
  export function isArray(
444
444
  object: unknown,
@@ -102,7 +102,7 @@ export function isCard(cardType: CardType): boolean {
102
102
  return ITEM_CONFIG_CARD_TYPES_FOR_CARDS_SET.has(itemConfigCardType);
103
103
  }
104
104
 
105
- /** Returns whether or not the given card type matches the specified item config card type. */
105
+ /** Returns whether the given card type matches the specified item config card type. */
106
106
  export function isCardType(
107
107
  cardType: CardType,
108
108
  itemConfigCardType: ItemConfigCardType,
@@ -277,7 +277,7 @@ export function isActiveSlotDoubleCharged(
277
277
  /**
278
278
  * Helper function to play the appropriate sound effect for a player after getting one or more
279
279
  * charges on their active item. (There is a different sound depending on whether the item is fully
280
- * charged or not.)
280
+ * charged.)
281
281
  *
282
282
  * @param player The player to play the sound effect for.
283
283
  * @param activeSlot Optional. The slot that was just charged. Default is `ActiveSlot.PRIMARY`.
@@ -456,9 +456,9 @@ export function isBlindCollectible(collectible: EntityPickup): boolean {
456
456
  }
457
457
 
458
458
  /**
459
- * Returns whether or not the given collectible is a "glitched" item. All items are replaced by
460
- * glitched items once a player has TMTRAINER. However, glitched items can also "naturally" appear
461
- * in secret rooms and I AM ERROR rooms if the "Corrupted Data" achievement is unlocked.
459
+ * Returns whether the given collectible is a "glitched" item. All items are replaced by glitched
460
+ * items once a player has TMTRAINER. However, glitched items can also "naturally" appear in secret
461
+ * rooms and I AM ERROR rooms if the "Corrupted Data" achievement is unlocked.
462
462
  */
463
463
  export function isGlitchedCollectible(collectible: EntityPickup): boolean {
464
464
  return (
@@ -4,7 +4,7 @@ import { log } from "./log";
4
4
  * Helper function to get the current time for benchmarking / profiling purposes.
5
5
  *
6
6
  * The return value will either be in seconds or milliseconds, depending on if the "--luadebug" flag
7
- * is turned on or not.
7
+ * is turned on.
8
8
  *
9
9
  * If the "--luadebug" flag is present, then this function will use the `socket.gettime` method,
10
10
  * which returns the epoch timestamp in seconds (e.g. "1640320492.5779"). This is preferable over
@@ -70,7 +70,7 @@ export function getTraceback(this: void): string {
70
70
  * documented here: https://wofsauge.github.io/IsaacDocs/rep/Globals.html
71
71
  *
72
72
  * This function uses the `package` global variable as a proxy to determine if the "--luadebug" flag
73
- * is enabled or not.
73
+ * is enabled.
74
74
  *
75
75
  * Note that this function will return false if the Racing+ sandbox is enabled, even if the
76
76
  * "--luadebug" flag is really turned on. If checking for this case is needed, check for the
@@ -62,8 +62,8 @@ import { assertDefined, getTraversalDescription } from "./utils";
62
62
  * user-defined TSTL classes when recursively iterating through the given
63
63
  * object, it will use this map to instantiate a new class. Default is an
64
64
  * empty Lua table.
65
- * @param insideMap Optional. Tracks whether or not the deep copy function is in the process of
66
- * recursively copying a TSTL Map. Default is false.
65
+ * @param insideMap Optional. Tracks whether the deep copy function is in the process of recursively
66
+ * copying a TSTL Map. Default is false.
67
67
  */
68
68
  export function deepCopy<T>(
69
69
  // An overload describing the trivial case of a normal copy. (T --> T)
@@ -327,7 +327,7 @@ function deepCopyDefaultMap(
327
327
 
328
328
  /**
329
329
  * The new copied default map with either be a TSTL `DefaultMap` class or a Lua table, depending on
330
- * whether we are serializing or not.
330
+ * whether we are serializing.
331
331
  */
332
332
  function getNewDefaultMap(
333
333
  defaultMap: DefaultMap<AnyNotNil, unknown> | LuaMap<AnyNotNil, unknown>,
@@ -191,7 +191,7 @@ const RACING_PLUS_SANDBOX_ADDED_GLOBALS = new ReadonlySet<string>([
191
191
  * Helper function to get a set containing all of the global variable names that are contained
192
192
  * within the Isaac environment by default.
193
193
  *
194
- * Returns a slightly different set depending on whether the "--luadebug" flag is enabled or not.
194
+ * Returns a slightly different set depending on whether the "--luadebug" flag is enabled.
195
195
  */
196
196
  export function getDefaultGlobals(): ReadonlySet<string> {
197
197
  const defaultGlobals = copySet(DEFAULT_GLOBALS);
@@ -568,7 +568,7 @@ export function removeEntitiesSpawnedFromGridEntity(
568
568
  * Helper function to remove all of the grid entities in the supplied array.
569
569
  *
570
570
  * @param gridEntities The array of grid entities to remove.
571
- * @param updateRoom Whether or not to update the room after the grid entities are removed. This is
571
+ * @param updateRoom Whether to update the room after the grid entities are removed. This is
572
572
  * generally a good idea because if the room is not updated, you will be unable to
573
573
  * spawn another grid entity on the same tile until a frame has passed. However,
574
574
  * doing this is expensive, since it involves a call to `Isaac.GetRoomEntities`,
@@ -610,11 +610,11 @@ export function removeGridEntities<T extends AnyGridEntity>(
610
610
  * (`EffectVariant.DEVIL` (6) or `EffectVariant.ANGEL` (9), respectively.)
611
611
  *
612
612
  * @param gridEntityOrGridIndex The grid entity or grid index to remove.
613
- * @param updateRoom Whether or not to update the room after the grid entity is removed. This is
614
- * generally a good idea because if the room is not updated, you will be unable to
615
- * spawn another grid entity on the same tile until a frame has passed. However,
616
- * doing this is expensive, since it involves a call to `Isaac.GetRoomEntities`,
617
- * so set this to false if you need to run this function multiple times.
613
+ * @param updateRoom Whether to update the room after the grid entity is removed. This is generally
614
+ * a good idea because if the room is not updated, you will be unable to spawn
615
+ * another grid entity on the same tile until a frame has passed. However, doing
616
+ * this is expensive, since it involves a call to `Isaac.GetRoomEntities`, so set
617
+ * this to false if you need to run this function multiple times.
618
618
  */
619
619
  export function removeGridEntity(
620
620
  gridEntityOrGridIndex: GridEntity | int,
@@ -199,7 +199,7 @@ export function getTrapdoors(
199
199
  *
200
200
  * @param crawlSpaceVariant Optional. If specified, will only remove the crawl spaces that match
201
201
  * this variant. Default is -1, which matches every variant.
202
- * @param updateRoom Optional. Whether or not to update the room after the crawl spaces are removed.
202
+ * @param updateRoom Optional. Whether to update the room after the crawl spaces are removed.
203
203
  * Default is false. For more information, see the description of the
204
204
  * `removeGridEntities` helper function.
205
205
  * @param cap Optional. If specified, will only remove the given amount of crawl spaces.
@@ -222,8 +222,8 @@ export function removeAllCrawlSpaces(
222
222
  *
223
223
  * @param pitVariant Optional. If specified, will only remove the pits that match this variant.
224
224
  * Default is -1, which matches every variant.
225
- * @param updateRoom Optional. Whether or not to update the room after the pits are removed. Default
226
- * is false. For more information, see the description of the `removeGridEntities`
225
+ * @param updateRoom Optional. Whether to update the room after the pits are removed. Default is
226
+ * false. For more information, see the description of the `removeGridEntities`
227
227
  * helper function.
228
228
  * @param cap Optional. If specified, will only remove the given amount of pits.
229
229
  * @returns The pits that were removed.
@@ -245,9 +245,9 @@ export function removeAllPits(
245
245
  *
246
246
  * @param poopVariant Optional. If specified, will only remove the poops that match this variant.
247
247
  * Default is -1, which matches every variant.
248
- * @param updateRoom Optional. Whether or not to update the room after the poops are removed.
249
- * Default is false. For more information, see the description of the
250
- * `removeGridEntities` helper function.
248
+ * @param updateRoom Optional. Whether to update the room after the poops are removed. Default is
249
+ * false. For more information, see the description of the `removeGridEntities`
250
+ * helper function.
251
251
  * @param cap Optional. If specified, will only remove the given amount of poops.
252
252
  * @returns The poops that were removed.
253
253
  */
@@ -265,8 +265,8 @@ export function removeAllPoops(
265
265
  *
266
266
  * @param pressurePlateVariant Optional. If specified, will only remove the pressure plates that
267
267
  * match this variant. Default is -1, which matches every variant.
268
- * @param updateRoom Optional. Whether or not to update the room after the pressure plates are
269
- * removed. Default is false. For more information, see the description of the
268
+ * @param updateRoom Optional. Whether to update the room after the pressure plates are removed.
269
+ * Default is false. For more information, see the description of the
270
270
  * `removeGridEntities` helper function.
271
271
  * @param cap Optional. If specified, will only remove the given amount of pressure plates.
272
272
  * @returns The pressure plates that were removed.
@@ -287,9 +287,9 @@ export function removeAllPressurePlates(
287
287
  * Default is -1, which matches every variant. Note that this is not the same thing
288
288
  * as the `RockVariant` enum, since that only applies to `GridEntityType.ROCK`, and
289
289
  * other types of grid entities can be the `GridEntityRock` class.
290
- * @param updateRoom Optional. Whether or not to update the room after the rocks are removed.
291
- * Default is false. For more information, see the description of the
292
- * `removeGridEntities` helper function.
290
+ * @param updateRoom Optional. Whether to update the room after the rocks are removed. Default is
291
+ * false. For more information, see the description of the `removeGridEntities`
292
+ * helper function.
293
293
  * @param cap Optional. If specified, will only remove the given amount of rocks.
294
294
  * @returns The rocks that were removed.
295
295
  */
@@ -307,9 +307,9 @@ export function removeAllRocks(
307
307
  *
308
308
  * @param variant Optional. If specified, will only remove the spikes that match this variant.
309
309
  * Default is -1, which matches every variant.
310
- * @param updateRoom Optional. Whether or not to update the room after the spikes are removed.
311
- * Default is false. For more information, see the description of the
312
- * `removeGridEntities` helper function.
310
+ * @param updateRoom Optional. Whether to update the room after the spikes are removed. Default is
311
+ * false. For more information, see the description of the `removeGridEntities`
312
+ * helper function.
313
313
  * @param cap Optional. If specified, will only remove the given amount of spikes.
314
314
  * @returns The spikes that were removed.
315
315
  */
@@ -327,8 +327,8 @@ export function removeAllSpikes(
327
327
  *
328
328
  * @param variant Optional. If specified, will only remove the TNTs that match this variant. Default
329
329
  * is -1, which matches every variant.
330
- * @param updateRoom Optional. Whether or not to update the room after the TNTs are removed. Default
331
- * is false. For more information, see the description of the `removeGridEntities`
330
+ * @param updateRoom Optional. Whether to update the room after the TNTs are removed. Default is
331
+ * false. For more information, see the description of the `removeGridEntities`
332
332
  * helper function.
333
333
  * @param cap Optional. If specified, will only remove the given amount of TNTs.
334
334
  * @returns The TNTs that were removed.
@@ -347,9 +347,9 @@ export function removeAllTNT(
347
347
  *
348
348
  * @param variant Optional. If specified, will only remove the teleporters that match this variant.
349
349
  * Default is -1, which matches every variant.
350
- * @param updateRoom Optional. Whether or not to update the room after the teleporters are removed.
351
- * Default is false. For more information, see the description of the
352
- * `removeGridEntities` helper function.
350
+ * @param updateRoom Optional. Whether to update the room after the teleporters are removed. Default
351
+ * is false. For more information, see the description of the `removeGridEntities`
352
+ * helper function.
353
353
  * @param cap Optional. If specified, will only remove the given amount of teleporters.
354
354
  * @returns The teleporters that were removed.
355
355
  */
@@ -367,9 +367,9 @@ export function removeAllTeleporters(
367
367
  *
368
368
  * @param trapdoorVariant Optional. If specified, will only remove the trapdoors that match this
369
369
  * variant. Default is -1, which matches every variant.
370
- * @param updateRoom Optional. Whether or not to update the room after the trapdoors are removed.
371
- * Default is false. For more information, see the description of the
372
- * `removeGridEntities` helper function.
370
+ * @param updateRoom Optional. Whether to update the room after the trapdoors are removed. Default
371
+ * is false. For more information, see the description of the `removeGridEntities`
372
+ * helper function.
373
373
  * @param cap Optional. If specified, will only remove the given amount of trapdoors.
374
374
  * @returns The trapdoors that were removed.
375
375
  */
@@ -60,8 +60,8 @@ export function controllerToString(controller: Controller): string | undefined {
60
60
 
61
61
  /**
62
62
  * Helper function to get the movement actions that the specified `ControllerIndex` is currently
63
- * pressing down. This returns an array because a player can technically be holding down more than
64
- * one movement key at a time.
63
+ * pressing down. This returns an array because a player can be holding down more than one movement
64
+ * key at a time.
65
65
  */
66
66
  export function getMoveActions(
67
67
  controllerIndex: ControllerIndex,
@@ -73,8 +73,8 @@ export function getMoveActions(
73
73
 
74
74
  /**
75
75
  * Helper function to get the shooting actions that the specified `ControllerIndex` is currently
76
- * pressing down. This returns an array because a player can technically be holding down more than
77
- * one shooting key at a time.
76
+ * pressing down. This returns an array because a player can be holding down more than one shooting
77
+ * key at a time.
78
78
  */
79
79
  export function getShootActions(
80
80
  controllerIndex: ControllerIndex,
@@ -81,7 +81,7 @@ export function logAllEntities(
81
81
  /**
82
82
  * Helper function for printing out every grid entity (or filtered grid entity) in the current room.
83
83
  *
84
- * @param includeWalls Optional. Whether or not to log the walls. Default is false.
84
+ * @param includeWalls Optional. Whether oto log the walls. Default is false.
85
85
  * @param gridEntityTypeFilter Optional. If specified, will only log the given `GridEntityType`.
86
86
  * Default is undefined.
87
87
  */