isaacscript-common 3.17.0 → 4.0.2

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 (425) hide show
  1. package/cachedClasses.ts +39 -0
  2. package/callbacks/customRevive.lua +2 -1
  3. package/callbacks/customRevive.ts +215 -0
  4. package/callbacks/itemPickup.ts +101 -0
  5. package/callbacks/postAmbush.ts +73 -0
  6. package/callbacks/postBombExploded.ts +26 -0
  7. package/callbacks/postBombInitLate.ts +36 -0
  8. package/callbacks/postBoneSwing.ts +64 -0
  9. package/callbacks/postCollectibleInitFirst.ts +40 -0
  10. package/callbacks/postCursedTeleport.lua +2 -1
  11. package/callbacks/postCursedTeleport.ts +185 -0
  12. package/callbacks/postCustomDoorEnter.lua +0 -7
  13. package/callbacks/postCustomDoorEnter.ts +292 -0
  14. package/callbacks/postDiceRoomActivated.ts +60 -0
  15. package/callbacks/postDoorRender.ts +26 -0
  16. package/callbacks/postDoorUpdate.ts +26 -0
  17. package/callbacks/postEffectInitLate.ts +36 -0
  18. package/callbacks/postEffectStateChanged.ts +43 -0
  19. package/callbacks/postEsauJr.lua +2 -1
  20. package/callbacks/postEsauJr.ts +109 -0
  21. package/callbacks/postFamiliarInitLate.ts +36 -0
  22. package/callbacks/postFamiliarStateChanged.ts +43 -0
  23. package/callbacks/postFlip.lua +4 -3
  24. package/callbacks/postFlip.ts +90 -0
  25. package/callbacks/postGreedModeWave.ts +41 -0
  26. package/callbacks/postGridEntity.ts +164 -0
  27. package/callbacks/postGridEntityCollision.ts +69 -0
  28. package/callbacks/postGridEntityRender.ts +26 -0
  29. package/callbacks/postHolyMantleRemoved.ts +55 -0
  30. package/callbacks/postItemDischarged.lua +4 -3
  31. package/callbacks/postItemDischarged.ts +154 -0
  32. package/callbacks/postKnifeInitLate.ts +36 -0
  33. package/callbacks/postLaserInitLate.ts +36 -0
  34. package/callbacks/postNPCInitLate.ts +36 -0
  35. package/callbacks/postNPCStateChanged.ts +42 -0
  36. package/callbacks/postNewRoomEarly.lua +2 -1
  37. package/callbacks/postNewRoomEarly.ts +96 -0
  38. package/callbacks/postPickupCollect.ts +48 -0
  39. package/callbacks/postPickupInitFirst.ts +70 -0
  40. package/callbacks/postPickupInitLate.ts +36 -0
  41. package/callbacks/postPickupStateChanged.ts +43 -0
  42. package/callbacks/postPitRender.ts +26 -0
  43. package/callbacks/postPitUpdate.ts +26 -0
  44. package/callbacks/postPlayerChangeHealth.ts +62 -0
  45. package/callbacks/postPlayerChangeType.ts +56 -0
  46. package/callbacks/postPlayerCollectible.ts +113 -0
  47. package/callbacks/postPlayerFatalDamage.ts +141 -0
  48. package/callbacks/postPlayerInitLate.ts +37 -0
  49. package/callbacks/postPlayerReordered.ts +142 -0
  50. package/callbacks/postPoopRender.ts +26 -0
  51. package/callbacks/postPoopUpdate.ts +26 -0
  52. package/callbacks/postPressurePlateRender.ts +26 -0
  53. package/callbacks/postPressurePlateUpdate.ts +26 -0
  54. package/callbacks/postProjectileInitLate.ts +36 -0
  55. package/callbacks/postPurchase.ts +64 -0
  56. package/callbacks/postRockRender.ts +26 -0
  57. package/callbacks/postRockUpdate.ts +26 -0
  58. package/callbacks/postRoomClearChanged.ts +57 -0
  59. package/callbacks/postSacrifice.lua +3 -2
  60. package/callbacks/postSacrifice.ts +64 -0
  61. package/callbacks/postSlotDestroyed.ts +92 -0
  62. package/callbacks/postSlotInitUpdate.ts +68 -0
  63. package/callbacks/postSlotRender.ts +69 -0
  64. package/callbacks/postSpikesRender.ts +26 -0
  65. package/callbacks/postSpikesUpdate.ts +26 -0
  66. package/callbacks/postTNTRender.ts +26 -0
  67. package/callbacks/postTNTUpdate.ts +26 -0
  68. package/callbacks/postTearInitLate.ts +36 -0
  69. package/callbacks/postTearInitVeryLate.ts +41 -0
  70. package/callbacks/postTransformation.ts +59 -0
  71. package/callbacks/postTrinketBreak.lua +3 -2
  72. package/callbacks/postTrinketBreak.ts +112 -0
  73. package/callbacks/preBerserkDeath.ts +49 -0
  74. package/callbacks/preNewLevel.ts +55 -0
  75. package/callbacks/reorderedCallbacks.lua +1 -0
  76. package/callbacks/reorderedCallbacks.ts +168 -0
  77. package/callbacks/subscriptions/postAmbushFinished.ts +32 -0
  78. package/callbacks/subscriptions/postAmbushStarted.ts +32 -0
  79. package/callbacks/subscriptions/postBombInitLate.ts +32 -0
  80. package/callbacks/subscriptions/postBoneExploded.ts +32 -0
  81. package/callbacks/subscriptions/postBoneSwing.ts +24 -0
  82. package/callbacks/subscriptions/postCollectibleInitFirst.ts +37 -0
  83. package/callbacks/subscriptions/postCursedTeleport.ts +24 -0
  84. package/callbacks/subscriptions/postCustomDoorEnter.ts +45 -0
  85. package/callbacks/subscriptions/postCustomRevive.ts +36 -0
  86. package/callbacks/subscriptions/postDiceRoomActivated.ts +38 -0
  87. package/callbacks/subscriptions/postDoorRender.ts +35 -0
  88. package/callbacks/subscriptions/postDoorUpdate.ts +35 -0
  89. package/callbacks/subscriptions/postEffectInitLate.ts +32 -0
  90. package/callbacks/subscriptions/postEffectStateChanged.ts +40 -0
  91. package/callbacks/subscriptions/postEsauJr.ts +24 -0
  92. package/callbacks/subscriptions/postFamiliarInitLate.ts +32 -0
  93. package/callbacks/subscriptions/postFamiliarStateChanged.ts +40 -0
  94. package/callbacks/subscriptions/postFirstEsauJr.ts +24 -0
  95. package/callbacks/subscriptions/postFirstFlip.ts +24 -0
  96. package/callbacks/subscriptions/postFlip.ts +22 -0
  97. package/callbacks/subscriptions/postGameStartedReordered.ts +24 -0
  98. package/callbacks/subscriptions/postGreedModeWave.ts +24 -0
  99. package/callbacks/subscriptions/postGridEntityBroken.ts +51 -0
  100. package/callbacks/subscriptions/postGridEntityCollision.ts +54 -0
  101. package/callbacks/subscriptions/postGridEntityInit.ts +51 -0
  102. package/callbacks/subscriptions/postGridEntityRemove.ts +52 -0
  103. package/callbacks/subscriptions/postGridEntityRender.ts +51 -0
  104. package/callbacks/subscriptions/postGridEntityStateChanged.ts +55 -0
  105. package/callbacks/subscriptions/postGridEntityUpdate.ts +51 -0
  106. package/callbacks/subscriptions/postHolyMantleRemoved.ts +48 -0
  107. package/callbacks/subscriptions/postItemDischarged.ts +43 -0
  108. package/callbacks/subscriptions/postItemPickup.ts +64 -0
  109. package/callbacks/subscriptions/postKnifeInitLate.ts +32 -0
  110. package/callbacks/subscriptions/postLaserInitLate.ts +32 -0
  111. package/callbacks/subscriptions/postNPCInitLate.ts +32 -0
  112. package/callbacks/subscriptions/postNPCStateChanged.ts +42 -0
  113. package/callbacks/subscriptions/postNewLevelReordered.ts +22 -0
  114. package/callbacks/subscriptions/postNewRoomEarly.ts +22 -0
  115. package/callbacks/subscriptions/postNewRoomReordered.ts +22 -0
  116. package/callbacks/subscriptions/postPEffectUpdateReordered.ts +40 -0
  117. package/callbacks/subscriptions/postPickupCollect.ts +35 -0
  118. package/callbacks/subscriptions/postPickupInitFirst.ts +32 -0
  119. package/callbacks/subscriptions/postPickupInitLate.ts +32 -0
  120. package/callbacks/subscriptions/postPickupStateChanged.ts +40 -0
  121. package/callbacks/subscriptions/postPitRender.ts +35 -0
  122. package/callbacks/subscriptions/postPitUpdate.ts +35 -0
  123. package/callbacks/subscriptions/postPlayerChangeHealth.ts +49 -0
  124. package/callbacks/subscriptions/postPlayerChangeType.ts +40 -0
  125. package/callbacks/subscriptions/postPlayerCollectibleAdded.d.ts +2 -3
  126. package/callbacks/subscriptions/postPlayerCollectibleAdded.lua +2 -7
  127. package/callbacks/subscriptions/postPlayerCollectibleAdded.ts +38 -0
  128. package/callbacks/subscriptions/postPlayerCollectibleRemoved.d.ts +2 -3
  129. package/callbacks/subscriptions/postPlayerCollectibleRemoved.lua +2 -7
  130. package/callbacks/subscriptions/postPlayerCollectibleRemoved.ts +38 -0
  131. package/callbacks/subscriptions/postPlayerFatalDamage.d.ts +1 -1
  132. package/callbacks/subscriptions/postPlayerFatalDamage.ts +68 -0
  133. package/callbacks/subscriptions/postPlayerInitLate.ts +40 -0
  134. package/callbacks/subscriptions/postPlayerInitReordered.ts +40 -0
  135. package/callbacks/subscriptions/postPlayerRenderReordered.ts +40 -0
  136. package/callbacks/subscriptions/postPlayerUpdateReordered.ts +40 -0
  137. package/callbacks/subscriptions/postPoopRender.ts +35 -0
  138. package/callbacks/subscriptions/postPoopUpdate.ts +35 -0
  139. package/callbacks/subscriptions/postPressurePlateRender.ts +37 -0
  140. package/callbacks/subscriptions/postPressurePlateUpdate.ts +37 -0
  141. package/callbacks/subscriptions/postProjectileInitLate.ts +35 -0
  142. package/callbacks/subscriptions/postPurchase.ts +31 -0
  143. package/callbacks/subscriptions/postRockRender.ts +35 -0
  144. package/callbacks/subscriptions/postRockUpdate.ts +35 -0
  145. package/callbacks/subscriptions/postRoomClearChanged.ts +30 -0
  146. package/callbacks/subscriptions/postSacrifice.ts +43 -0
  147. package/callbacks/subscriptions/postSlotAnimationChanged.ts +40 -0
  148. package/callbacks/subscriptions/postSlotDestroyed.ts +55 -0
  149. package/callbacks/subscriptions/postSlotInit.ts +32 -0
  150. package/callbacks/subscriptions/postSlotRender.ts +32 -0
  151. package/callbacks/subscriptions/postSlotUpdate.ts +32 -0
  152. package/callbacks/subscriptions/postSpikesRender.ts +35 -0
  153. package/callbacks/subscriptions/postSpikesUpdate.ts +35 -0
  154. package/callbacks/subscriptions/postTNTRender.ts +35 -0
  155. package/callbacks/subscriptions/postTNTUpdate.ts +35 -0
  156. package/callbacks/subscriptions/postTearInitLate.ts +32 -0
  157. package/callbacks/subscriptions/postTearInitVeryLate.ts +32 -0
  158. package/callbacks/subscriptions/postTransformation.ts +40 -0
  159. package/callbacks/subscriptions/postTrinketBreak.ts +38 -0
  160. package/callbacks/subscriptions/preBerserkDeath.d.ts +1 -1
  161. package/callbacks/subscriptions/preBerserkDeath.ts +42 -0
  162. package/callbacks/subscriptions/preCustomRevive.d.ts +1 -1
  163. package/callbacks/subscriptions/preCustomRevive.ts +46 -0
  164. package/callbacks/subscriptions/preItemPickup.ts +64 -0
  165. package/callbacks/subscriptions/preNewLevel.ts +24 -0
  166. package/classes/DefaultMap.ts +174 -0
  167. package/classes/ModUpgraded.d.ts +8 -4
  168. package/classes/ModUpgraded.lua +5 -8
  169. package/classes/ModUpgraded.ts +84 -0
  170. package/constants.ts +162 -0
  171. package/constantsFirstLast.ts +217 -0
  172. package/enums/AmbushType.ts +4 -0
  173. package/enums/HealthType.ts +16 -0
  174. package/enums/ModCallbackCustom.d.ts +20 -18
  175. package/enums/ModCallbackCustom.ts +1278 -0
  176. package/enums/PocketItemType.ts +8 -0
  177. package/enums/SerializationType.ts +5 -0
  178. package/enums/SlotDestructionType.ts +4 -0
  179. package/enums/private/CopyableIsaacAPIClassType.ts +7 -0
  180. package/enums/private/SaveDataKey.ts +14 -0
  181. package/enums/private/SerializationBrand.ts +42 -0
  182. package/features/characterHealthConversion.lua +2 -9
  183. package/features/characterHealthConversion.ts +111 -0
  184. package/features/characterStats.ts +61 -0
  185. package/features/debugDisplay/debugDisplay.ts +221 -0
  186. package/features/debugDisplay/exports.ts +368 -0
  187. package/features/debugDisplay/v.ts +65 -0
  188. package/features/deployJSONRoom.ts +743 -0
  189. package/features/disableInputs.ts +193 -0
  190. package/features/disableSound.ts +77 -0
  191. package/features/extraConsoleCommands/commandsDisplay.ts +290 -0
  192. package/features/extraConsoleCommands/commandsSubroutines.lua +1 -1
  193. package/features/extraConsoleCommands/commandsSubroutines.ts +139 -0
  194. package/features/extraConsoleCommands/init.ts +334 -0
  195. package/features/extraConsoleCommands/listCommands.ts +1299 -0
  196. package/features/extraConsoleCommands/v.ts +14 -0
  197. package/features/fadeInRemover.ts +60 -0
  198. package/features/fastReset.ts +75 -0
  199. package/features/forgottenSwitch.ts +50 -0
  200. package/features/getCollectibleItemPoolType.ts +66 -0
  201. package/features/persistentEntities.ts +183 -0
  202. package/features/playerInventory.lua +1 -0
  203. package/features/playerInventory.ts +135 -0
  204. package/features/ponyDetection.ts +74 -0
  205. package/features/preventCollectibleRotation.ts +115 -0
  206. package/features/runInNFrames.ts +148 -0
  207. package/features/saveDataManager/constants.ts +4 -0
  208. package/features/saveDataManager/exports.ts +229 -0
  209. package/features/saveDataManager/load.ts +99 -0
  210. package/features/saveDataManager/main.ts +195 -0
  211. package/features/saveDataManager/maps.ts +13 -0
  212. package/features/saveDataManager/merge.ts +194 -0
  213. package/features/saveDataManager/save.ts +74 -0
  214. package/features/saveDataManager/serializationBrand.ts +16 -0
  215. package/features/sirenHelpers.ts +129 -0
  216. package/features/taintedLazarusPlayers.ts +113 -0
  217. package/featuresInitialized.ts +20 -0
  218. package/functions/ambush.ts +47 -0
  219. package/functions/array.ts +410 -0
  220. package/functions/benchmark.ts +36 -0
  221. package/functions/bitwise.ts +24 -0
  222. package/functions/bombs.ts +12 -0
  223. package/functions/boss.ts +227 -0
  224. package/functions/cacheFlag.ts +12 -0
  225. package/functions/cards.lua +1 -1
  226. package/functions/cards.ts +271 -0
  227. package/functions/challenges.ts +13 -0
  228. package/functions/character.ts +126 -0
  229. package/functions/charge.ts +237 -0
  230. package/functions/chargeBar.ts +67 -0
  231. package/functions/collectibleCacheFlag.ts +90 -0
  232. package/functions/collectibleSet.ts +56 -0
  233. package/functions/collectibleTag.ts +89 -0
  234. package/functions/collectibles.ts +659 -0
  235. package/functions/color.d.ts +1 -1
  236. package/functions/color.lua +0 -7
  237. package/functions/color.ts +128 -0
  238. package/functions/debug.lua +2 -2
  239. package/functions/debug.ts +68 -0
  240. package/functions/deepCopy.lua +46 -51
  241. package/functions/deepCopy.ts +535 -0
  242. package/functions/deepCopyTests.ts +386 -0
  243. package/functions/direction.ts +49 -0
  244. package/functions/doors.lua +1 -2
  245. package/functions/doors.ts +347 -0
  246. package/functions/easing.ts +182 -0
  247. package/functions/eden.ts +47 -0
  248. package/functions/effects.ts +20 -0
  249. package/functions/entity.ts +439 -0
  250. package/functions/entitySpecific.ts +889 -0
  251. package/functions/entityTypes.ts +6 -0
  252. package/functions/enums.ts +146 -0
  253. package/functions/familiars.ts +106 -0
  254. package/functions/flag.ts +165 -0
  255. package/functions/flying.ts +117 -0
  256. package/functions/globals.d.ts +3 -3
  257. package/functions/globals.lua +8 -2
  258. package/functions/globals.ts +242 -0
  259. package/functions/gridEntity.ts +511 -0
  260. package/functions/gridEntitySpecific.ts +112 -0
  261. package/functions/input.ts +139 -0
  262. package/functions/isaacAPIClass.ts +67 -0
  263. package/functions/jsonHelpers.ts +45 -0
  264. package/functions/jsonRoom.ts +100 -0
  265. package/functions/kColor.d.ts +1 -1
  266. package/functions/kColor.lua +0 -7
  267. package/functions/kColor.ts +129 -0
  268. package/functions/language.ts +13 -0
  269. package/functions/level.ts +31 -0
  270. package/functions/log.ts +720 -0
  271. package/functions/map.ts +56 -0
  272. package/functions/math.ts +149 -0
  273. package/functions/mergeTests.ts +288 -0
  274. package/functions/npc.ts +148 -0
  275. package/functions/pickupVariants.ts +60 -0
  276. package/functions/pickups.ts +499 -0
  277. package/functions/pills.lua +1 -1
  278. package/functions/pills.ts +205 -0
  279. package/functions/player.lua +9 -20
  280. package/functions/player.ts +1056 -0
  281. package/functions/playerDataStructures.ts +150 -0
  282. package/functions/playerHealth.lua +28 -39
  283. package/functions/playerHealth.ts +382 -0
  284. package/functions/playerIndex.ts +195 -0
  285. package/functions/pocketItems.ts +149 -0
  286. package/functions/positionVelocity.ts +188 -0
  287. package/functions/random.ts +77 -0
  288. package/functions/revive.ts +201 -0
  289. package/functions/rng.d.ts +1 -1
  290. package/functions/rng.lua +0 -7
  291. package/functions/rng.ts +172 -0
  292. package/functions/roomData.ts +199 -0
  293. package/functions/roomGrid.ts +109 -0
  294. package/functions/roomShape.ts +80 -0
  295. package/functions/rooms.lua +1 -3
  296. package/functions/rooms.ts +648 -0
  297. package/functions/run.ts +36 -0
  298. package/functions/saveFile.ts +128 -0
  299. package/functions/seeds.ts +19 -0
  300. package/functions/serialization.lua +0 -3
  301. package/functions/serialization.ts +91 -0
  302. package/functions/set.ts +95 -0
  303. package/functions/sound.ts +9 -0
  304. package/functions/spawnCollectible.ts +104 -0
  305. package/functions/sprite.ts +107 -0
  306. package/functions/stage.ts +125 -0
  307. package/functions/string.ts +47 -0
  308. package/functions/table.ts +189 -0
  309. package/functions/tears.ts +32 -0
  310. package/functions/transformations.lua +1 -3
  311. package/functions/transformations.ts +131 -0
  312. package/functions/trinketCacheFlag.ts +60 -0
  313. package/functions/trinketGive.ts +157 -0
  314. package/functions/trinkets.ts +215 -0
  315. package/functions/tstlClass.ts +157 -0
  316. package/functions/types.ts +36 -0
  317. package/functions/ui.ts +138 -0
  318. package/functions/utils.d.ts +0 -37
  319. package/functions/utils.lua +0 -35
  320. package/functions/utils.ts +189 -0
  321. package/functions/vector.d.ts +1 -1
  322. package/functions/vector.lua +0 -7
  323. package/functions/vector.ts +126 -0
  324. package/index.ts +172 -0
  325. package/initCustomCallbacks.ts +132 -0
  326. package/initFeatures.ts +39 -0
  327. package/interfaces/AddCallbackParameterCustom.ts +188 -0
  328. package/interfaces/ChargeBarSprites.ts +12 -0
  329. package/interfaces/JSONDoor.d.ts +4 -4
  330. package/interfaces/JSONDoor.ts +13 -0
  331. package/interfaces/JSONEntity.d.ts +5 -5
  332. package/interfaces/JSONEntity.ts +16 -0
  333. package/interfaces/JSONRoom.d.ts +9 -9
  334. package/interfaces/JSONRoom.ts +36 -0
  335. package/interfaces/JSONRooms.ts +12 -0
  336. package/interfaces/JSONSpawn.d.ts +3 -3
  337. package/interfaces/JSONSpawn.ts +14 -0
  338. package/interfaces/PlayerHealth.ts +16 -0
  339. package/interfaces/PocketItemDescription.ts +9 -0
  340. package/interfaces/SaveData.ts +29 -0
  341. package/interfaces/TrinketSituation.ts +9 -0
  342. package/interfaces/private/TSTLClassMetatable.ts +8 -0
  343. package/maps/PHDPillConversions.ts +21 -0
  344. package/maps/cardMap.ts +209 -0
  345. package/maps/characterMap.ts +87 -0
  346. package/maps/collectibleDescriptionMap.ts +732 -0
  347. package/maps/collectibleNameMap.ts +731 -0
  348. package/maps/defaultPlayerStatMap.ts +17 -0
  349. package/maps/falsePHDPillConversions.ts +35 -0
  350. package/maps/gridEntityTypeToBrokenStateMap.ts +50 -0
  351. package/maps/gridEntityXMLMap.ts +176 -0
  352. package/maps/pillEffectMap.ts +88 -0
  353. package/maps/roomShapeToTopLeftWallGridIndexMap.ts +18 -0
  354. package/maps/roomTypeMap.ts +40 -0
  355. package/maps/trinketDescriptionMap.ts +200 -0
  356. package/maps/trinketNameMap.ts +198 -0
  357. package/objects/LRoomShapeToRectangles.ts +44 -0
  358. package/objects/callbackRegisterFunctions.ts +187 -0
  359. package/objects/cardDescriptions.ts +105 -0
  360. package/objects/cardNames.ts +105 -0
  361. package/objects/cardTypes.ts +104 -0
  362. package/objects/challengeNames.ts +52 -0
  363. package/objects/characterNames.ts +48 -0
  364. package/objects/coinSubTypeToValue.ts +14 -0
  365. package/objects/colors.ts +16 -0
  366. package/objects/directionNames.ts +11 -0
  367. package/objects/directionToDegrees.ts +11 -0
  368. package/objects/directionToVector.ts +12 -0
  369. package/objects/doorSlotFlagToDoorSlot.ts +16 -0
  370. package/objects/doorSlotToDirection.ts +14 -0
  371. package/objects/isaacAPIClassTypeToBrand.ts +11 -0
  372. package/objects/isaacAPIClassTypeToCopyFunction.ts +18 -0
  373. package/objects/languageNames.ts +13 -0
  374. package/objects/oppositeDoorSlots.ts +15 -0
  375. package/objects/pillEffectClasses.ts +63 -0
  376. package/objects/pillEffectNames.ts +57 -0
  377. package/objects/pillEffectTypes.ts +62 -0
  378. package/objects/roomShapeBounds.ts +71 -0
  379. package/objects/roomShapeLayoutSizes.ts +45 -0
  380. package/objects/roomShapeToBottomRightPosition.ts +25 -0
  381. package/objects/roomShapeToDoorSlots.ts +83 -0
  382. package/objects/roomShapeToDoorSlotsToGridIndexDelta.ts +127 -0
  383. package/objects/roomShapeToGridWidth.ts +21 -0
  384. package/objects/roomShapeToTopLeftPosition.ts +26 -0
  385. package/objects/roomShapeVolumes.ts +38 -0
  386. package/objects/roomTypeNames.ts +36 -0
  387. package/objects/serializedIsaacAPIClassTypeToIdentityFunction.ts +14 -0
  388. package/objects/stageTypeToLetter.ts +15 -0
  389. package/objects/transformationNames.d.ts +0 -1
  390. package/objects/transformationNames.lua +0 -1
  391. package/objects/transformationNames.ts +18 -0
  392. package/package.json +2 -2
  393. package/patchErrorFunctions.ts +92 -0
  394. package/sets/LRoomShapesSet.ts +8 -0
  395. package/sets/bossSets.ts +470 -0
  396. package/sets/charactersThatStartWithAnActiveItemSet.ts +16 -0
  397. package/sets/charactersWithBlackHeartFromEternalHeartSet.ts +7 -0
  398. package/sets/charactersWithFreeDevilDealsSet.ts +4 -0
  399. package/sets/charactersWithNoRedHeartsSet.ts +17 -0
  400. package/sets/charactersWithNoSoulHeartsSet.ts +14 -0
  401. package/sets/chestPickupVariantsSet.ts +16 -0
  402. package/sets/familiarsThatShootPlayerTearsSet.ts +13 -0
  403. package/sets/lostStyleCharactersSet.ts +13 -0
  404. package/sets/mineShaftRoomSubTypesSet.ts +10 -0
  405. package/sets/redHeartSubTypesSet.ts +7 -0
  406. package/sets/sinEntityTypesSet.ts +11 -0
  407. package/sets/singleUseActiveCollectibleTypesSet.ts +13 -0
  408. package/sets/storyBossesSet.ts +17 -0
  409. package/types/AnyEntity.ts +12 -0
  410. package/types/AwaitingTextInput.d.ts +2 -0
  411. package/types/CollectibleIndex.d.ts +1 -1
  412. package/types/CollectibleIndex.ts +16 -0
  413. package/types/PickingUpItem.d.ts +3 -3
  414. package/types/PickingUpItem.ts +89 -0
  415. package/types/PlayerIndex.d.ts +1 -1
  416. package/types/PlayerIndex.ts +13 -0
  417. package/types/private/IsaacAPIClass.d.ts +1 -1
  418. package/types/private/IsaacAPIClass.ts +3 -0
  419. package/types/private/SerializedIsaacAPIClass.d.ts +1 -1
  420. package/types/private/SerializedIsaacAPIClass.ts +3 -0
  421. package/types/private/TSTLClass.d.ts +1 -1
  422. package/types/private/TSTLClass.ts +3 -0
  423. package/upgradeMod.d.ts +2 -2
  424. package/upgradeMod.lua +2 -2
  425. package/upgradeMod.ts +55 -0
@@ -0,0 +1,56 @@
1
+ /** Helper function to copy a map. (You can also use a Map constructor to accomplish this task.) */
2
+ export function copyMap<K, V>(oldMap: Map<K, V>): Map<K, V> {
3
+ const newMap = new Map<K, V>();
4
+ for (const [key, value] of oldMap.entries()) {
5
+ newMap.set(key, value);
6
+ }
7
+
8
+ return newMap;
9
+ }
10
+
11
+ /**
12
+ * Helper function to get the closest value from a map based on partial search text. For the
13
+ * purposes of this function, both search text and map keys are converted to lowercase before
14
+ * attempting to find a match.
15
+ *
16
+ * For example:
17
+ *
18
+ * ```ts
19
+ * const map = new <string, number>Map([
20
+ * ["foo", 123],
21
+ * ["bar", 456],
22
+ * ]);
23
+ * const searchText = "f";
24
+ * const match = getMapPartialMatch(map, searchText); // match is now equal to 123
25
+ *
26
+ * @returns If a match was found, returns a tuple of the map key and value. If a match was not
27
+ * found, returns undefined.
28
+ * ```
29
+ */
30
+ export function getMapPartialMatch<T>(
31
+ searchText: string,
32
+ map: ReadonlyMap<string, T>,
33
+ ): [string, T] | undefined {
34
+ const keys = [...map.keys()];
35
+ keys.sort();
36
+
37
+ searchText = searchText.toLowerCase();
38
+ searchText = searchText.replaceAll(" ", "");
39
+
40
+ const matchingKeys = keys.filter((key) =>
41
+ key.toLowerCase().startsWith(searchText),
42
+ );
43
+ matchingKeys.sort();
44
+
45
+ const matchingKey = matchingKeys[0];
46
+ if (matchingKey === undefined) {
47
+ return undefined;
48
+ }
49
+
50
+ const value = map.get(matchingKey);
51
+ if (value === undefined) {
52
+ return undefined;
53
+ }
54
+
55
+ return [matchingKey, value];
56
+ }
@@ -0,0 +1,149 @@
1
+ import { Direction } from "isaac-typescript-definitions";
2
+ import { directionToVector } from "./direction";
3
+
4
+ /**
5
+ * Helper function to normalize an integer.
6
+ *
7
+ * - If `x` is less than `min`, then it will be clamped to `min`.
8
+ * - If `x` is greater than `max`, then it will be clamped to `max`.
9
+ */
10
+ export function clamp(x: int, min: int, max: int): int {
11
+ return Math.max(min, Math.min(x, max));
12
+ }
13
+
14
+ export function getAngleDifference(angle1: float, angle2: float): float {
15
+ const subtractedAngle = angle1 - angle2;
16
+ return ((subtractedAngle + 180) % 360) - 180;
17
+ }
18
+
19
+ /**
20
+ * Helper function to get an array of equidistant points on the circumference around a circle.
21
+ * Useful for equally distributing things in a circle pattern.
22
+ *
23
+ * @param centerPos A position that represents the center of the center to get the points from.
24
+ * @param radius The radius of the circle.
25
+ * @param numPoints The number of points on the circumference of the circle to get.
26
+ * @param xMultiplier An optional multiplier to get the points around an oval. Default is 1.
27
+ * @param yMultiplier An optional multiplier to get the points around an oval. Default is 1.
28
+ * @param initialDirection By default, the first point on the circle will be on the top center, but
29
+ * this can be optionally changed by specifying this argument.
30
+ */
31
+ export function getCircleDiscretizedPoints(
32
+ centerPos: Vector,
33
+ radius: float,
34
+ numPoints: int,
35
+ xMultiplier = 1,
36
+ yMultiplier = 1,
37
+ initialDirection = Direction.UP,
38
+ ): Vector[] {
39
+ const vector = directionToVector(initialDirection);
40
+ const initialPosition = vector.mul(radius);
41
+ const positions: Vector[] = [];
42
+ for (let i = 0; i < numPoints; i++) {
43
+ const rotatedPosition = initialPosition.Rotated((i * 360) / numPoints);
44
+ rotatedPosition.X *= xMultiplier;
45
+ rotatedPosition.Y *= yMultiplier;
46
+ const positionFromCenter = centerPos.add(rotatedPosition);
47
+ positions.push(positionFromCenter);
48
+ }
49
+
50
+ return positions;
51
+ }
52
+
53
+ /**
54
+ * Helper function to check if a given position is within a given rectangle.
55
+ *
56
+ * This is an inclusive check, meaning that it will return true if the position is on the border of
57
+ * the rectangle.
58
+ */
59
+ export function inRectangle(
60
+ position: Vector,
61
+ topLeft: Vector,
62
+ bottomRight: Vector,
63
+ ): boolean {
64
+ return (
65
+ position.X >= topLeft.X &&
66
+ position.X <= bottomRight.X &&
67
+ position.Y >= topLeft.Y &&
68
+ position.Y <= bottomRight.Y
69
+ );
70
+ }
71
+
72
+ /**
73
+ * From: https://www.geeksforgeeks.org/check-if-any-point-overlaps-the-given-circle-and-rectangle/
74
+ */
75
+ export function isCircleIntersectingRectangle(
76
+ circleCenter: Vector,
77
+ circleRadius: float,
78
+ rectangleTopLeft: Vector,
79
+ rectangleBottomRight: Vector,
80
+ ): boolean {
81
+ const nearestX = Math.max(
82
+ rectangleTopLeft.X,
83
+ Math.min(circleCenter.X, rectangleBottomRight.X),
84
+ );
85
+
86
+ const nearestY = Math.max(
87
+ rectangleTopLeft.Y,
88
+ Math.min(circleCenter.Y, rectangleBottomRight.Y),
89
+ );
90
+
91
+ const nearestPointToCircleOnRectangle = Vector(nearestX, nearestY);
92
+ const distanceToCenterOfCircle =
93
+ nearestPointToCircleOnRectangle.Distance(circleCenter);
94
+
95
+ return distanceToCenterOfCircle <= circleRadius;
96
+ }
97
+
98
+ export function isEven(num: int): boolean {
99
+ // This is benchmarked to be faster than using the modulus operator by 3%.
100
+ return (num & 1) === 0;
101
+ }
102
+
103
+ export function isOdd(num: int): boolean {
104
+ // This is benchmarked to be faster than using the modulus operator by 3%.
105
+ return (num & 1) === 1;
106
+ }
107
+
108
+ export function lerp(a: number, b: number, pos: float): number {
109
+ return a + (b - a) * pos;
110
+ }
111
+
112
+ export function lerpAngleDegrees(
113
+ aStart: number,
114
+ aEnd: number,
115
+ percent: float,
116
+ ): number {
117
+ return aStart + getAngleDifference(aStart, aEnd) * percent;
118
+ }
119
+
120
+ /**
121
+ * If rounding fails, this function returns 0.
122
+ * From: http://lua-users.org/wiki/SimpleRound
123
+ *
124
+ * @param num The number to round.
125
+ * @param numDecimalPlaces Default is 0.
126
+ */
127
+ export function round(num: float, numDecimalPlaces = 0): float {
128
+ const roundedNum = tonumber(string.format(`%.${numDecimalPlaces}f`, num));
129
+ return roundedNum === undefined ? 0 : roundedNum;
130
+ }
131
+
132
+ /**
133
+ * @returns 1 if n is positive, -1 if n is negative, or 0 if n is 0.
134
+ */
135
+ export function sign(n: number): int {
136
+ if (n > 0) {
137
+ return 1;
138
+ }
139
+
140
+ if (n < 0) {
141
+ return -1;
142
+ }
143
+
144
+ return 0;
145
+ }
146
+
147
+ export function tanh(x: number): number {
148
+ return (Math.exp(x) - Math.exp(-x)) / (Math.exp(x) + Math.exp(-x));
149
+ }
@@ -0,0 +1,288 @@
1
+ import { SerializationType } from "../enums/SerializationType";
2
+ import { merge } from "../features/saveDataManager/merge";
3
+ import { deepCopy } from "./deepCopy";
4
+ import { log } from "./log";
5
+ import { isRNG, newRNG } from "./rng";
6
+ import { isSerializedIsaacAPIClass } from "./serialization";
7
+ import { copyVector, isVector } from "./vector";
8
+
9
+ export function mergeTests(): void {
10
+ oldTableHasUpdatedValue();
11
+ newTableHasSameValue();
12
+ oldTableHasUpdatedValueFromNull();
13
+ oldTableHasSerializedIsaacAPIClass();
14
+
15
+ oldTableHasFilledInterface();
16
+ oldTableHasVector();
17
+ oldTableHasVectorSerialized();
18
+ oldTableHasRNG();
19
+ oldTableHasRNGSerialized();
20
+
21
+ log("All merge tests passed!");
22
+ }
23
+
24
+ function oldTableHasUpdatedValue() {
25
+ const key = "foo";
26
+ const oldValue = "bar";
27
+ const newValue = "baz";
28
+ const oldTable = {
29
+ foo: oldValue,
30
+ } as unknown as LuaTable<AnyNotNil, unknown>;
31
+ const newTable = {
32
+ foo: newValue,
33
+ } as unknown as LuaTable<AnyNotNil, unknown>;
34
+
35
+ merge(oldTable, newTable, "oldTableHasUpdatedValue");
36
+
37
+ const oldTableValue = oldTable.get(key) as string;
38
+ if (oldTableValue !== newValue) {
39
+ error(`The old table does not have a value of: ${newValue}`);
40
+ }
41
+ }
42
+
43
+ function newTableHasSameValue() {
44
+ const key = "foo";
45
+ const oldValue = "bar";
46
+ const newValue = "baz";
47
+ const oldTable = {
48
+ foo: oldValue,
49
+ } as unknown as LuaTable<AnyNotNil, unknown>;
50
+ const newTable = {
51
+ foo: newValue,
52
+ } as unknown as LuaTable<AnyNotNil, unknown>;
53
+
54
+ merge(oldTable, newTable, "newTableHasSameValue");
55
+
56
+ const newTableValue = newTable.get(key) as string;
57
+ if (newTableValue !== newValue) {
58
+ error(`The new table does not have a value of: ${newValue}`);
59
+ }
60
+ }
61
+
62
+ function oldTableHasUpdatedValueFromNull() {
63
+ const key = "foo";
64
+ const newValue = "baz";
65
+ const oldTable = {
66
+ foo: null as string | null,
67
+ } as unknown as LuaTable<AnyNotNil, unknown>;
68
+ const newTable = {
69
+ foo: newValue,
70
+ } as unknown as LuaTable<AnyNotNil, unknown>;
71
+
72
+ merge(oldTable, newTable, "oldTableHasUpdatedValueFromNull");
73
+
74
+ const oldTableValue = oldTable.get(key) as string;
75
+ if (oldTableValue !== newValue) {
76
+ error(`The old table does not have a value of: ${newValue}`);
77
+ }
78
+ }
79
+
80
+ function oldTableHasSerializedIsaacAPIClass() {
81
+ const x = 50;
82
+ const y = 60;
83
+ const vector = Vector(x, y);
84
+
85
+ const vectorSerialized = copyVector(vector, SerializationType.SERIALIZE);
86
+ if (!isSerializedIsaacAPIClass(vectorSerialized)) {
87
+ error(
88
+ 'The "isSerializedIsaacAPIClass" function says that a serialized vector is not serialized.',
89
+ );
90
+ }
91
+ }
92
+
93
+ function oldTableHasFilledInterface() {
94
+ interface Foo {
95
+ bar: string;
96
+ }
97
+
98
+ const key = "foo";
99
+ const newValue = "baz";
100
+ const oldTable = {
101
+ foo: null as Foo | null,
102
+ } as unknown as LuaTable<AnyNotNil, unknown>;
103
+ const foo: Foo = {
104
+ bar: newValue,
105
+ };
106
+ const newTable = {
107
+ foo,
108
+ } as unknown as LuaTable<AnyNotNil, unknown>;
109
+
110
+ merge(oldTable, newTable, "oldTableHasFilledInterface");
111
+
112
+ const oldTableValue = oldTable.get(key) as Foo | undefined;
113
+ if (oldTableValue === undefined) {
114
+ error(`The old table's key of "${key}" was not filled.`);
115
+ }
116
+
117
+ if (oldTableValue.bar !== newValue) {
118
+ error('The old table\'s key of "bar" was not filled.');
119
+ }
120
+ }
121
+
122
+ function oldTableHasVector() {
123
+ log("Starting test: oldTableHasVector");
124
+
125
+ interface Foo {
126
+ bar: Vector;
127
+ }
128
+
129
+ const key = "foo";
130
+ const x = 50;
131
+ const y = 60;
132
+ const newValue = Vector(x, y);
133
+ const oldTable = {
134
+ foo: null as Foo | null,
135
+ } as unknown as LuaTable<AnyNotNil, unknown>;
136
+ const foo: Foo = {
137
+ bar: newValue,
138
+ };
139
+ const newTable = {
140
+ foo,
141
+ } as unknown as LuaTable<AnyNotNil, unknown>;
142
+
143
+ merge(oldTable, newTable, "oldTableHasVector");
144
+
145
+ const oldTableValue = oldTable.get(key) as Foo | undefined;
146
+ if (oldTableValue === undefined) {
147
+ error(`The old table's key of "${key}" was not filled.`);
148
+ }
149
+
150
+ if (oldTableValue.bar.X !== x) {
151
+ error(`The old table's value for "x" does not match: ${x}`);
152
+ }
153
+
154
+ if (oldTableValue.bar.Y !== y) {
155
+ error(`The old table's value for "y" does not match: ${y}`);
156
+ }
157
+
158
+ if (!isVector(oldTableValue.bar)) {
159
+ error("The old table's value is not a Vector object.");
160
+ }
161
+ }
162
+
163
+ function oldTableHasVectorSerialized() {
164
+ log("Starting test: oldTableHasVectorSerialized");
165
+
166
+ interface Foo {
167
+ bar: Vector;
168
+ }
169
+
170
+ const key = "foo";
171
+ const x = 50;
172
+ const y = 60;
173
+ const newValue = Vector(x, y);
174
+ const oldTable = {
175
+ foo: null as Foo | null,
176
+ } as unknown as LuaTable<AnyNotNil, unknown>;
177
+ const foo: Foo = {
178
+ bar: newValue,
179
+ };
180
+ const newTable = {
181
+ foo,
182
+ } as unknown as LuaTable<AnyNotNil, unknown>;
183
+ const newTableSerialized = deepCopy(
184
+ newTable,
185
+ SerializationType.SERIALIZE,
186
+ ) as LuaTable<AnyNotNil, unknown>;
187
+
188
+ merge(oldTable, newTableSerialized, "oldTableHasVectorSerialized");
189
+
190
+ const oldTableValue = oldTable.get(key) as Foo | undefined;
191
+ if (oldTableValue === undefined) {
192
+ error(`The old table's key of "${key}" was not filled.`);
193
+ }
194
+
195
+ if (oldTableValue.bar.X !== x) {
196
+ error(`The old table's value for "x" does not match: ${x}`);
197
+ }
198
+
199
+ if (oldTableValue.bar.Y !== y) {
200
+ error(`The old table's value for "y" does not match: ${y}`);
201
+ }
202
+
203
+ if (!isVector(oldTableValue.bar)) {
204
+ error(
205
+ "The old table's value is not a Vector object (during the serialized test).",
206
+ );
207
+ }
208
+ }
209
+
210
+ function oldTableHasRNG() {
211
+ log("Starting test: oldTableHasRNG");
212
+
213
+ interface Foo {
214
+ bar: RNG;
215
+ }
216
+
217
+ const key = "foo";
218
+ const seed = 50 as Seed;
219
+ const newValue = newRNG(seed);
220
+ const oldTable = {
221
+ foo: null as Foo | null,
222
+ } as unknown as LuaTable<AnyNotNil, unknown>;
223
+ const foo: Foo = {
224
+ bar: newValue,
225
+ };
226
+ const newTable = {
227
+ foo,
228
+ } as unknown as LuaTable<AnyNotNil, unknown>;
229
+
230
+ merge(oldTable, newTable, "oldTableHasRNG");
231
+
232
+ const oldTableValue = oldTable.get(key) as Foo | undefined;
233
+ if (oldTableValue === undefined) {
234
+ error(`The old table's key of "${key}" was not filled.`);
235
+ }
236
+
237
+ if (!isRNG(oldTableValue.bar)) {
238
+ error("The old table's value is not an RNG object.");
239
+ }
240
+
241
+ const newSeed = oldTableValue.bar.GetSeed();
242
+ if (newSeed !== seed) {
243
+ error(`The old table's seed not match: ${seed}`);
244
+ }
245
+ }
246
+
247
+ function oldTableHasRNGSerialized() {
248
+ log("Starting test: oldTableHasRNGSerialized");
249
+
250
+ interface Foo {
251
+ bar: RNG;
252
+ }
253
+
254
+ const key = "foo";
255
+ const seed = 50 as Seed;
256
+ const newValue = newRNG(seed);
257
+ const oldTable = {
258
+ foo: null as Foo | null,
259
+ } as unknown as LuaTable<AnyNotNil, unknown>;
260
+ const foo: Foo = {
261
+ bar: newValue,
262
+ };
263
+ const newTable = {
264
+ foo,
265
+ } as unknown as LuaTable<AnyNotNil, unknown>;
266
+ const newTableSerialized = deepCopy(
267
+ newTable,
268
+ SerializationType.SERIALIZE,
269
+ ) as LuaTable<AnyNotNil, unknown>;
270
+
271
+ merge(oldTable, newTableSerialized, "oldTableHasRNGSerialized");
272
+
273
+ const oldTableValue = oldTable.get(key) as Foo | undefined;
274
+ if (oldTableValue === undefined) {
275
+ error(`The old table's key of "${key}" was not filled.`);
276
+ }
277
+
278
+ if (!isRNG(oldTableValue.bar)) {
279
+ error(
280
+ "The old table's value is not an RNG object (during the serialized test).",
281
+ );
282
+ }
283
+
284
+ const newSeed = oldTableValue.bar.GetSeed();
285
+ if (newSeed !== seed) {
286
+ error(`The old table's seed not match: ${seed}`);
287
+ }
288
+ }
@@ -0,0 +1,148 @@
1
+ import {
2
+ BegottenVariant,
3
+ BigHornVariant,
4
+ ChargerSubType,
5
+ ChargerVariant,
6
+ DarkEsauVariant,
7
+ DeathVariant,
8
+ EntityType,
9
+ MamaGurdyVariant,
10
+ MotherSubType,
11
+ MotherVariant,
12
+ NpcState,
13
+ PeepVariant,
14
+ ProjectilesMode,
15
+ RaglingVariant,
16
+ VisVariant,
17
+ } from "isaac-typescript-definitions";
18
+ import { EGGY_STATE_FRAME_OF_FINAL_SPIDER } from "../constants";
19
+ import { getFilteredNewEntities } from "./entity";
20
+ import { getNPCs, getProjectiles } from "./entitySpecific";
21
+
22
+ /**
23
+ * Used to filter out certain NPCs when determining of an NPC is "alive" and/or should keep the
24
+ * doors open.
25
+ */
26
+ const NON_ALIVE_NPCS_TYPE_VARIANT: ReadonlySet<string> = new Set([
27
+ `${EntityType.VIS}.${VisVariant.CHUBBER_PROJECTILE}`, // 39.22
28
+ `${EntityType.DEATH}.${DeathVariant.DEATH_SCYTHE}`, // 66.10
29
+ `${EntityType.PEEP}.${PeepVariant.PEEP_EYE}`, // 68.10
30
+ `${EntityType.PEEP}.${PeepVariant.BLOAT_EYE}`, // 68.11
31
+ `${EntityType.BEGOTTEN}.${BegottenVariant.BEGOTTEN_CHAIN}`, // 251.10
32
+ `${EntityType.MAMA_GURDY}.${MamaGurdyVariant.LEFT_HAND}`, // 266.1
33
+ `${EntityType.MAMA_GURDY}.${MamaGurdyVariant.RIGHT_HAND}`, // 266.2
34
+ `${EntityType.BIG_HORN}.${BigHornVariant.SMALL_HOLE}`, // 411.1
35
+ `${EntityType.BIG_HORN}.${BigHornVariant.BIG_HOLE}`, // 411.2
36
+ `${EntityType.DARK_ESAU}.${DarkEsauVariant.DARK_ESAU}`, // 866.0
37
+ `${EntityType.DARK_ESAU}.${DarkEsauVariant.PIT}`, // 866.1
38
+ ]);
39
+
40
+ /**
41
+ * Used to filter out certain NPCs when determining of an NPC is "alive" and/or should keep the
42
+ * doors open.
43
+ */
44
+ const NON_ALIVE_NPCS_TYPE_VARIANT_SUBTYPE: ReadonlySet<string> = new Set([
45
+ `${EntityType.CHARGER}.${ChargerVariant.CHARGER}.${ChargerSubType.MY_SHADOW}`, // 23.0.1
46
+ `${EntityType.MOTHER}.${MotherVariant.MOTHER_1}.${MotherSubType.PHASE_2}`, // 912
47
+ ]);
48
+
49
+ /**
50
+ * Helper function to make an NPC fire a projectile. Returns the fired projectile. Use this function
51
+ * instead of the `EntityNPC.FireProjectiles` method, since that returns void.
52
+ *
53
+ * @param npc The NPC to fire the projectile from.
54
+ * @param position The staring position of the projectile.
55
+ * @param velocity The starting velocity of the projectile.
56
+ * @param projectilesMode The mode of the projectile. Optional. Default is
57
+ * `ProjectilesMode.ONE_PROJECTILE`.
58
+ * @param projectileParams The parameters of the projectile. Optional. Default is
59
+ * `ProjectileParams()`.
60
+ * @returns The fired projectile.
61
+ */
62
+ export function fireProjectiles(
63
+ npc: EntityNPC,
64
+ position: Vector,
65
+ velocity: Vector,
66
+ projectilesMode: ProjectilesMode = ProjectilesMode.ONE_PROJECTILE,
67
+ projectileParams: ProjectileParams = ProjectileParams(),
68
+ ): EntityProjectile[] {
69
+ const oldProjectiles = getProjectiles(projectileParams.Variant);
70
+ npc.FireProjectiles(position, velocity, projectilesMode, projectileParams);
71
+ const newProjectiles = getProjectiles(projectileParams.Variant);
72
+
73
+ return getFilteredNewEntities(oldProjectiles, newProjectiles);
74
+ }
75
+
76
+ /**
77
+ * Helper function to get all of the non-dead NPCs in the room.
78
+ *
79
+ * This function will not include NPCs on an internal blacklist, such as Death's scythes or Big Horn
80
+ * holes.
81
+ */
82
+ export function getAliveNPCs(
83
+ matchingEntityType?: EntityType,
84
+ matchingVariant?: int,
85
+ matchingSubType?: int,
86
+ ignoreFriendly = false,
87
+ ): EntityNPC[] {
88
+ const npcs = getNPCs(
89
+ matchingEntityType,
90
+ matchingVariant,
91
+ matchingSubType,
92
+ ignoreFriendly,
93
+ );
94
+ return npcs.filter((npc) => !npc.IsDead() && !isAliveExceptionNPC(npc));
95
+ }
96
+
97
+ /**
98
+ * Checks for specific NPCs that have "CanShutDoors" set to true naturally by the game, but should
99
+ * not actually keep the doors closed (like Death's scythes).
100
+ */
101
+ export function isAliveExceptionNPC(npc: EntityNPC): boolean {
102
+ const entityTypeVariant = `${npc.Type}.${npc.Variant}`;
103
+ if (NON_ALIVE_NPCS_TYPE_VARIANT.has(entityTypeVariant)) {
104
+ return true;
105
+ }
106
+
107
+ const entityTypeVariantSubType = `${npc.Type}.${npc.Variant}.${npc.SubType}`;
108
+ if (NON_ALIVE_NPCS_TYPE_VARIANT_SUBTYPE.has(entityTypeVariantSubType)) {
109
+ return true;
110
+ }
111
+
112
+ if (isRaglingDeathPatch(npc)) {
113
+ return true;
114
+ }
115
+
116
+ if (isDyingEggyWithNoSpidersLeft(npc)) {
117
+ return true;
118
+ }
119
+
120
+ return false;
121
+ }
122
+
123
+ /**
124
+ * Helper function to detect the custom death state of an Eggy. Eggies are never actually marked
125
+ * dead by the game. Instead, when Eggies take fatal damage, they go into NpcState.STATE_SUICIDE and
126
+ * spawn 14 Swarm Spiders while their StateFrame ticks upwards.
127
+ */
128
+ export function isDyingEggyWithNoSpidersLeft(npc: EntityNPC): boolean {
129
+ return (
130
+ npc.State === NpcState.SUICIDE &&
131
+ npc.StateFrame >= EGGY_STATE_FRAME_OF_FINAL_SPIDER
132
+ );
133
+ }
134
+
135
+ /**
136
+ * Helper function to detect the custom death state of a Rag Man Ragling. When Rag Man Raglings die,
137
+ * they turn into a patch on the ground and can be revived by Rag Man at a later time. This causes
138
+ * them to show up as an "alive" enemy, so they should usually be filtered out of lists of alive
139
+ * enemies.
140
+ */
141
+ export function isRaglingDeathPatch(npc: EntityNPC): boolean {
142
+ return (
143
+ npc.Type === EntityType.RAGLING &&
144
+ npc.Variant === (RaglingVariant.RAG_MANS_RAGLING as int) &&
145
+ // They go to `STATE_SPECIAL` when they are patches on the ground.
146
+ npc.State === NpcState.SPECIAL
147
+ );
148
+ }
@@ -0,0 +1,60 @@
1
+ /* eslint-disable sort-exports/sort-exports */
2
+
3
+ import { PickupVariant } from "isaac-typescript-definitions";
4
+
5
+ /** For `PickupVariant.HEART` (10) */
6
+ export function isHeart(pickup: EntityPickup): pickup is EntityPickupHeart {
7
+ return pickup.Variant === PickupVariant.HEART;
8
+ }
9
+
10
+ /** For `PickupVariant.COIN` (20) */
11
+ export function isCoin(pickup: EntityPickup): pickup is EntityPickupCoin {
12
+ return pickup.Variant === PickupVariant.COIN;
13
+ }
14
+
15
+ /** For `PickupVariant.KEY` (30) */
16
+ export function isKey(pickup: EntityPickup): pickup is EntityPickupKey {
17
+ return pickup.Variant === PickupVariant.KEY;
18
+ }
19
+
20
+ /** For `PickupVariant.BOMB` (40) */
21
+ export function isBomb(pickup: EntityPickup): pickup is EntityPickupBomb {
22
+ return pickup.Variant === PickupVariant.BOMB;
23
+ }
24
+
25
+ /** For `PickupVariant.POOP` (42) */
26
+ export function isPoop(pickup: EntityPickup): pickup is EntityPickupPoop {
27
+ return pickup.Variant === PickupVariant.POOP;
28
+ }
29
+
30
+ /** For `PickupVariant.SACK` (69) */
31
+ export function isSack(pickup: EntityPickup): pickup is EntityPickupSack {
32
+ return pickup.Variant === PickupVariant.SACK;
33
+ }
34
+
35
+ /** For `PickupVariant.PILL` (70) */
36
+ export function isPill(pickup: EntityPickup): pickup is EntityPickupPill {
37
+ return pickup.Variant === PickupVariant.PILL;
38
+ }
39
+
40
+ /** For `PickupVariant.LIL_BATTERY` (90) */
41
+ export function isBattery(pickup: EntityPickup): pickup is EntityPickupBattery {
42
+ return pickup.Variant === PickupVariant.LIL_BATTERY;
43
+ }
44
+
45
+ /** For `PickupVariant.COLLECTIBLE` (100) */
46
+ export function isCollectible(
47
+ pickup: EntityPickup,
48
+ ): pickup is EntityPickupCollectible {
49
+ return pickup.Variant === PickupVariant.COLLECTIBLE;
50
+ }
51
+
52
+ /** For `PickupVariant.TAROT_CARD` (300) */
53
+ export function isCardPickup(pickup: EntityPickup): pickup is EntityPickupCard {
54
+ return pickup.Variant === PickupVariant.TAROT_CARD;
55
+ }
56
+
57
+ /** For `PickupVariant.TRINKET` (350) */
58
+ export function isTrinket(pickup: EntityPickup): pickup is EntityPickupTrinket {
59
+ return pickup.Variant === PickupVariant.TRINKET;
60
+ }