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.
- package/cachedClasses.ts +39 -0
- package/callbacks/customRevive.lua +2 -1
- package/callbacks/customRevive.ts +215 -0
- package/callbacks/itemPickup.ts +101 -0
- package/callbacks/postAmbush.ts +73 -0
- package/callbacks/postBombExploded.ts +26 -0
- package/callbacks/postBombInitLate.ts +36 -0
- package/callbacks/postBoneSwing.ts +64 -0
- package/callbacks/postCollectibleInitFirst.ts +40 -0
- package/callbacks/postCursedTeleport.lua +2 -1
- package/callbacks/postCursedTeleport.ts +185 -0
- package/callbacks/postCustomDoorEnter.lua +0 -7
- package/callbacks/postCustomDoorEnter.ts +292 -0
- package/callbacks/postDiceRoomActivated.ts +60 -0
- package/callbacks/postDoorRender.ts +26 -0
- package/callbacks/postDoorUpdate.ts +26 -0
- package/callbacks/postEffectInitLate.ts +36 -0
- package/callbacks/postEffectStateChanged.ts +43 -0
- package/callbacks/postEsauJr.lua +2 -1
- package/callbacks/postEsauJr.ts +109 -0
- package/callbacks/postFamiliarInitLate.ts +36 -0
- package/callbacks/postFamiliarStateChanged.ts +43 -0
- package/callbacks/postFlip.lua +4 -3
- package/callbacks/postFlip.ts +90 -0
- package/callbacks/postGreedModeWave.ts +41 -0
- package/callbacks/postGridEntity.ts +164 -0
- package/callbacks/postGridEntityCollision.ts +69 -0
- package/callbacks/postGridEntityRender.ts +26 -0
- package/callbacks/postHolyMantleRemoved.ts +55 -0
- package/callbacks/postItemDischarged.lua +4 -3
- package/callbacks/postItemDischarged.ts +154 -0
- package/callbacks/postKnifeInitLate.ts +36 -0
- package/callbacks/postLaserInitLate.ts +36 -0
- package/callbacks/postNPCInitLate.ts +36 -0
- package/callbacks/postNPCStateChanged.ts +42 -0
- package/callbacks/postNewRoomEarly.lua +2 -1
- package/callbacks/postNewRoomEarly.ts +96 -0
- package/callbacks/postPickupCollect.ts +48 -0
- package/callbacks/postPickupInitFirst.ts +70 -0
- package/callbacks/postPickupInitLate.ts +36 -0
- package/callbacks/postPickupStateChanged.ts +43 -0
- package/callbacks/postPitRender.ts +26 -0
- package/callbacks/postPitUpdate.ts +26 -0
- package/callbacks/postPlayerChangeHealth.ts +62 -0
- package/callbacks/postPlayerChangeType.ts +56 -0
- package/callbacks/postPlayerCollectible.ts +113 -0
- package/callbacks/postPlayerFatalDamage.ts +141 -0
- package/callbacks/postPlayerInitLate.ts +37 -0
- package/callbacks/postPlayerReordered.ts +142 -0
- package/callbacks/postPoopRender.ts +26 -0
- package/callbacks/postPoopUpdate.ts +26 -0
- package/callbacks/postPressurePlateRender.ts +26 -0
- package/callbacks/postPressurePlateUpdate.ts +26 -0
- package/callbacks/postProjectileInitLate.ts +36 -0
- package/callbacks/postPurchase.ts +64 -0
- package/callbacks/postRockRender.ts +26 -0
- package/callbacks/postRockUpdate.ts +26 -0
- package/callbacks/postRoomClearChanged.ts +57 -0
- package/callbacks/postSacrifice.lua +3 -2
- package/callbacks/postSacrifice.ts +64 -0
- package/callbacks/postSlotDestroyed.ts +92 -0
- package/callbacks/postSlotInitUpdate.ts +68 -0
- package/callbacks/postSlotRender.ts +69 -0
- package/callbacks/postSpikesRender.ts +26 -0
- package/callbacks/postSpikesUpdate.ts +26 -0
- package/callbacks/postTNTRender.ts +26 -0
- package/callbacks/postTNTUpdate.ts +26 -0
- package/callbacks/postTearInitLate.ts +36 -0
- package/callbacks/postTearInitVeryLate.ts +41 -0
- package/callbacks/postTransformation.ts +59 -0
- package/callbacks/postTrinketBreak.lua +3 -2
- package/callbacks/postTrinketBreak.ts +112 -0
- package/callbacks/preBerserkDeath.ts +49 -0
- package/callbacks/preNewLevel.ts +55 -0
- package/callbacks/reorderedCallbacks.lua +1 -0
- package/callbacks/reorderedCallbacks.ts +168 -0
- package/callbacks/subscriptions/postAmbushFinished.ts +32 -0
- package/callbacks/subscriptions/postAmbushStarted.ts +32 -0
- package/callbacks/subscriptions/postBombInitLate.ts +32 -0
- package/callbacks/subscriptions/postBoneExploded.ts +32 -0
- package/callbacks/subscriptions/postBoneSwing.ts +24 -0
- package/callbacks/subscriptions/postCollectibleInitFirst.ts +37 -0
- package/callbacks/subscriptions/postCursedTeleport.ts +24 -0
- package/callbacks/subscriptions/postCustomDoorEnter.ts +45 -0
- package/callbacks/subscriptions/postCustomRevive.ts +36 -0
- package/callbacks/subscriptions/postDiceRoomActivated.ts +38 -0
- package/callbacks/subscriptions/postDoorRender.ts +35 -0
- package/callbacks/subscriptions/postDoorUpdate.ts +35 -0
- package/callbacks/subscriptions/postEffectInitLate.ts +32 -0
- package/callbacks/subscriptions/postEffectStateChanged.ts +40 -0
- package/callbacks/subscriptions/postEsauJr.ts +24 -0
- package/callbacks/subscriptions/postFamiliarInitLate.ts +32 -0
- package/callbacks/subscriptions/postFamiliarStateChanged.ts +40 -0
- package/callbacks/subscriptions/postFirstEsauJr.ts +24 -0
- package/callbacks/subscriptions/postFirstFlip.ts +24 -0
- package/callbacks/subscriptions/postFlip.ts +22 -0
- package/callbacks/subscriptions/postGameStartedReordered.ts +24 -0
- package/callbacks/subscriptions/postGreedModeWave.ts +24 -0
- package/callbacks/subscriptions/postGridEntityBroken.ts +51 -0
- package/callbacks/subscriptions/postGridEntityCollision.ts +54 -0
- package/callbacks/subscriptions/postGridEntityInit.ts +51 -0
- package/callbacks/subscriptions/postGridEntityRemove.ts +52 -0
- package/callbacks/subscriptions/postGridEntityRender.ts +51 -0
- package/callbacks/subscriptions/postGridEntityStateChanged.ts +55 -0
- package/callbacks/subscriptions/postGridEntityUpdate.ts +51 -0
- package/callbacks/subscriptions/postHolyMantleRemoved.ts +48 -0
- package/callbacks/subscriptions/postItemDischarged.ts +43 -0
- package/callbacks/subscriptions/postItemPickup.ts +64 -0
- package/callbacks/subscriptions/postKnifeInitLate.ts +32 -0
- package/callbacks/subscriptions/postLaserInitLate.ts +32 -0
- package/callbacks/subscriptions/postNPCInitLate.ts +32 -0
- package/callbacks/subscriptions/postNPCStateChanged.ts +42 -0
- package/callbacks/subscriptions/postNewLevelReordered.ts +22 -0
- package/callbacks/subscriptions/postNewRoomEarly.ts +22 -0
- package/callbacks/subscriptions/postNewRoomReordered.ts +22 -0
- package/callbacks/subscriptions/postPEffectUpdateReordered.ts +40 -0
- package/callbacks/subscriptions/postPickupCollect.ts +35 -0
- package/callbacks/subscriptions/postPickupInitFirst.ts +32 -0
- package/callbacks/subscriptions/postPickupInitLate.ts +32 -0
- package/callbacks/subscriptions/postPickupStateChanged.ts +40 -0
- package/callbacks/subscriptions/postPitRender.ts +35 -0
- package/callbacks/subscriptions/postPitUpdate.ts +35 -0
- package/callbacks/subscriptions/postPlayerChangeHealth.ts +49 -0
- package/callbacks/subscriptions/postPlayerChangeType.ts +40 -0
- package/callbacks/subscriptions/postPlayerCollectibleAdded.d.ts +2 -3
- package/callbacks/subscriptions/postPlayerCollectibleAdded.lua +2 -7
- package/callbacks/subscriptions/postPlayerCollectibleAdded.ts +38 -0
- package/callbacks/subscriptions/postPlayerCollectibleRemoved.d.ts +2 -3
- package/callbacks/subscriptions/postPlayerCollectibleRemoved.lua +2 -7
- package/callbacks/subscriptions/postPlayerCollectibleRemoved.ts +38 -0
- package/callbacks/subscriptions/postPlayerFatalDamage.d.ts +1 -1
- package/callbacks/subscriptions/postPlayerFatalDamage.ts +68 -0
- package/callbacks/subscriptions/postPlayerInitLate.ts +40 -0
- package/callbacks/subscriptions/postPlayerInitReordered.ts +40 -0
- package/callbacks/subscriptions/postPlayerRenderReordered.ts +40 -0
- package/callbacks/subscriptions/postPlayerUpdateReordered.ts +40 -0
- package/callbacks/subscriptions/postPoopRender.ts +35 -0
- package/callbacks/subscriptions/postPoopUpdate.ts +35 -0
- package/callbacks/subscriptions/postPressurePlateRender.ts +37 -0
- package/callbacks/subscriptions/postPressurePlateUpdate.ts +37 -0
- package/callbacks/subscriptions/postProjectileInitLate.ts +35 -0
- package/callbacks/subscriptions/postPurchase.ts +31 -0
- package/callbacks/subscriptions/postRockRender.ts +35 -0
- package/callbacks/subscriptions/postRockUpdate.ts +35 -0
- package/callbacks/subscriptions/postRoomClearChanged.ts +30 -0
- package/callbacks/subscriptions/postSacrifice.ts +43 -0
- package/callbacks/subscriptions/postSlotAnimationChanged.ts +40 -0
- package/callbacks/subscriptions/postSlotDestroyed.ts +55 -0
- package/callbacks/subscriptions/postSlotInit.ts +32 -0
- package/callbacks/subscriptions/postSlotRender.ts +32 -0
- package/callbacks/subscriptions/postSlotUpdate.ts +32 -0
- package/callbacks/subscriptions/postSpikesRender.ts +35 -0
- package/callbacks/subscriptions/postSpikesUpdate.ts +35 -0
- package/callbacks/subscriptions/postTNTRender.ts +35 -0
- package/callbacks/subscriptions/postTNTUpdate.ts +35 -0
- package/callbacks/subscriptions/postTearInitLate.ts +32 -0
- package/callbacks/subscriptions/postTearInitVeryLate.ts +32 -0
- package/callbacks/subscriptions/postTransformation.ts +40 -0
- package/callbacks/subscriptions/postTrinketBreak.ts +38 -0
- package/callbacks/subscriptions/preBerserkDeath.d.ts +1 -1
- package/callbacks/subscriptions/preBerserkDeath.ts +42 -0
- package/callbacks/subscriptions/preCustomRevive.d.ts +1 -1
- package/callbacks/subscriptions/preCustomRevive.ts +46 -0
- package/callbacks/subscriptions/preItemPickup.ts +64 -0
- package/callbacks/subscriptions/preNewLevel.ts +24 -0
- package/classes/DefaultMap.ts +174 -0
- package/classes/ModUpgraded.d.ts +8 -4
- package/classes/ModUpgraded.lua +5 -8
- package/classes/ModUpgraded.ts +84 -0
- package/constants.ts +162 -0
- package/constantsFirstLast.ts +217 -0
- package/enums/AmbushType.ts +4 -0
- package/enums/HealthType.ts +16 -0
- package/enums/ModCallbackCustom.d.ts +20 -18
- package/enums/ModCallbackCustom.ts +1278 -0
- package/enums/PocketItemType.ts +8 -0
- package/enums/SerializationType.ts +5 -0
- package/enums/SlotDestructionType.ts +4 -0
- package/enums/private/CopyableIsaacAPIClassType.ts +7 -0
- package/enums/private/SaveDataKey.ts +14 -0
- package/enums/private/SerializationBrand.ts +42 -0
- package/features/characterHealthConversion.lua +2 -9
- package/features/characterHealthConversion.ts +111 -0
- package/features/characterStats.ts +61 -0
- package/features/debugDisplay/debugDisplay.ts +221 -0
- package/features/debugDisplay/exports.ts +368 -0
- package/features/debugDisplay/v.ts +65 -0
- package/features/deployJSONRoom.ts +743 -0
- package/features/disableInputs.ts +193 -0
- package/features/disableSound.ts +77 -0
- package/features/extraConsoleCommands/commandsDisplay.ts +290 -0
- package/features/extraConsoleCommands/commandsSubroutines.lua +1 -1
- package/features/extraConsoleCommands/commandsSubroutines.ts +139 -0
- package/features/extraConsoleCommands/init.ts +334 -0
- package/features/extraConsoleCommands/listCommands.ts +1299 -0
- package/features/extraConsoleCommands/v.ts +14 -0
- package/features/fadeInRemover.ts +60 -0
- package/features/fastReset.ts +75 -0
- package/features/forgottenSwitch.ts +50 -0
- package/features/getCollectibleItemPoolType.ts +66 -0
- package/features/persistentEntities.ts +183 -0
- package/features/playerInventory.lua +1 -0
- package/features/playerInventory.ts +135 -0
- package/features/ponyDetection.ts +74 -0
- package/features/preventCollectibleRotation.ts +115 -0
- package/features/runInNFrames.ts +148 -0
- package/features/saveDataManager/constants.ts +4 -0
- package/features/saveDataManager/exports.ts +229 -0
- package/features/saveDataManager/load.ts +99 -0
- package/features/saveDataManager/main.ts +195 -0
- package/features/saveDataManager/maps.ts +13 -0
- package/features/saveDataManager/merge.ts +194 -0
- package/features/saveDataManager/save.ts +74 -0
- package/features/saveDataManager/serializationBrand.ts +16 -0
- package/features/sirenHelpers.ts +129 -0
- package/features/taintedLazarusPlayers.ts +113 -0
- package/featuresInitialized.ts +20 -0
- package/functions/ambush.ts +47 -0
- package/functions/array.ts +410 -0
- package/functions/benchmark.ts +36 -0
- package/functions/bitwise.ts +24 -0
- package/functions/bombs.ts +12 -0
- package/functions/boss.ts +227 -0
- package/functions/cacheFlag.ts +12 -0
- package/functions/cards.lua +1 -1
- package/functions/cards.ts +271 -0
- package/functions/challenges.ts +13 -0
- package/functions/character.ts +126 -0
- package/functions/charge.ts +237 -0
- package/functions/chargeBar.ts +67 -0
- package/functions/collectibleCacheFlag.ts +90 -0
- package/functions/collectibleSet.ts +56 -0
- package/functions/collectibleTag.ts +89 -0
- package/functions/collectibles.ts +659 -0
- package/functions/color.d.ts +1 -1
- package/functions/color.lua +0 -7
- package/functions/color.ts +128 -0
- package/functions/debug.lua +2 -2
- package/functions/debug.ts +68 -0
- package/functions/deepCopy.lua +46 -51
- package/functions/deepCopy.ts +535 -0
- package/functions/deepCopyTests.ts +386 -0
- package/functions/direction.ts +49 -0
- package/functions/doors.lua +1 -2
- package/functions/doors.ts +347 -0
- package/functions/easing.ts +182 -0
- package/functions/eden.ts +47 -0
- package/functions/effects.ts +20 -0
- package/functions/entity.ts +439 -0
- package/functions/entitySpecific.ts +889 -0
- package/functions/entityTypes.ts +6 -0
- package/functions/enums.ts +146 -0
- package/functions/familiars.ts +106 -0
- package/functions/flag.ts +165 -0
- package/functions/flying.ts +117 -0
- package/functions/globals.d.ts +3 -3
- package/functions/globals.lua +8 -2
- package/functions/globals.ts +242 -0
- package/functions/gridEntity.ts +511 -0
- package/functions/gridEntitySpecific.ts +112 -0
- package/functions/input.ts +139 -0
- package/functions/isaacAPIClass.ts +67 -0
- package/functions/jsonHelpers.ts +45 -0
- package/functions/jsonRoom.ts +100 -0
- package/functions/kColor.d.ts +1 -1
- package/functions/kColor.lua +0 -7
- package/functions/kColor.ts +129 -0
- package/functions/language.ts +13 -0
- package/functions/level.ts +31 -0
- package/functions/log.ts +720 -0
- package/functions/map.ts +56 -0
- package/functions/math.ts +149 -0
- package/functions/mergeTests.ts +288 -0
- package/functions/npc.ts +148 -0
- package/functions/pickupVariants.ts +60 -0
- package/functions/pickups.ts +499 -0
- package/functions/pills.lua +1 -1
- package/functions/pills.ts +205 -0
- package/functions/player.lua +9 -20
- package/functions/player.ts +1056 -0
- package/functions/playerDataStructures.ts +150 -0
- package/functions/playerHealth.lua +28 -39
- package/functions/playerHealth.ts +382 -0
- package/functions/playerIndex.ts +195 -0
- package/functions/pocketItems.ts +149 -0
- package/functions/positionVelocity.ts +188 -0
- package/functions/random.ts +77 -0
- package/functions/revive.ts +201 -0
- package/functions/rng.d.ts +1 -1
- package/functions/rng.lua +0 -7
- package/functions/rng.ts +172 -0
- package/functions/roomData.ts +199 -0
- package/functions/roomGrid.ts +109 -0
- package/functions/roomShape.ts +80 -0
- package/functions/rooms.lua +1 -3
- package/functions/rooms.ts +648 -0
- package/functions/run.ts +36 -0
- package/functions/saveFile.ts +128 -0
- package/functions/seeds.ts +19 -0
- package/functions/serialization.lua +0 -3
- package/functions/serialization.ts +91 -0
- package/functions/set.ts +95 -0
- package/functions/sound.ts +9 -0
- package/functions/spawnCollectible.ts +104 -0
- package/functions/sprite.ts +107 -0
- package/functions/stage.ts +125 -0
- package/functions/string.ts +47 -0
- package/functions/table.ts +189 -0
- package/functions/tears.ts +32 -0
- package/functions/transformations.lua +1 -3
- package/functions/transformations.ts +131 -0
- package/functions/trinketCacheFlag.ts +60 -0
- package/functions/trinketGive.ts +157 -0
- package/functions/trinkets.ts +215 -0
- package/functions/tstlClass.ts +157 -0
- package/functions/types.ts +36 -0
- package/functions/ui.ts +138 -0
- package/functions/utils.d.ts +0 -37
- package/functions/utils.lua +0 -35
- package/functions/utils.ts +189 -0
- package/functions/vector.d.ts +1 -1
- package/functions/vector.lua +0 -7
- package/functions/vector.ts +126 -0
- package/index.ts +172 -0
- package/initCustomCallbacks.ts +132 -0
- package/initFeatures.ts +39 -0
- package/interfaces/AddCallbackParameterCustom.ts +188 -0
- package/interfaces/ChargeBarSprites.ts +12 -0
- package/interfaces/JSONDoor.d.ts +4 -4
- package/interfaces/JSONDoor.ts +13 -0
- package/interfaces/JSONEntity.d.ts +5 -5
- package/interfaces/JSONEntity.ts +16 -0
- package/interfaces/JSONRoom.d.ts +9 -9
- package/interfaces/JSONRoom.ts +36 -0
- package/interfaces/JSONRooms.ts +12 -0
- package/interfaces/JSONSpawn.d.ts +3 -3
- package/interfaces/JSONSpawn.ts +14 -0
- package/interfaces/PlayerHealth.ts +16 -0
- package/interfaces/PocketItemDescription.ts +9 -0
- package/interfaces/SaveData.ts +29 -0
- package/interfaces/TrinketSituation.ts +9 -0
- package/interfaces/private/TSTLClassMetatable.ts +8 -0
- package/maps/PHDPillConversions.ts +21 -0
- package/maps/cardMap.ts +209 -0
- package/maps/characterMap.ts +87 -0
- package/maps/collectibleDescriptionMap.ts +732 -0
- package/maps/collectibleNameMap.ts +731 -0
- package/maps/defaultPlayerStatMap.ts +17 -0
- package/maps/falsePHDPillConversions.ts +35 -0
- package/maps/gridEntityTypeToBrokenStateMap.ts +50 -0
- package/maps/gridEntityXMLMap.ts +176 -0
- package/maps/pillEffectMap.ts +88 -0
- package/maps/roomShapeToTopLeftWallGridIndexMap.ts +18 -0
- package/maps/roomTypeMap.ts +40 -0
- package/maps/trinketDescriptionMap.ts +200 -0
- package/maps/trinketNameMap.ts +198 -0
- package/objects/LRoomShapeToRectangles.ts +44 -0
- package/objects/callbackRegisterFunctions.ts +187 -0
- package/objects/cardDescriptions.ts +105 -0
- package/objects/cardNames.ts +105 -0
- package/objects/cardTypes.ts +104 -0
- package/objects/challengeNames.ts +52 -0
- package/objects/characterNames.ts +48 -0
- package/objects/coinSubTypeToValue.ts +14 -0
- package/objects/colors.ts +16 -0
- package/objects/directionNames.ts +11 -0
- package/objects/directionToDegrees.ts +11 -0
- package/objects/directionToVector.ts +12 -0
- package/objects/doorSlotFlagToDoorSlot.ts +16 -0
- package/objects/doorSlotToDirection.ts +14 -0
- package/objects/isaacAPIClassTypeToBrand.ts +11 -0
- package/objects/isaacAPIClassTypeToCopyFunction.ts +18 -0
- package/objects/languageNames.ts +13 -0
- package/objects/oppositeDoorSlots.ts +15 -0
- package/objects/pillEffectClasses.ts +63 -0
- package/objects/pillEffectNames.ts +57 -0
- package/objects/pillEffectTypes.ts +62 -0
- package/objects/roomShapeBounds.ts +71 -0
- package/objects/roomShapeLayoutSizes.ts +45 -0
- package/objects/roomShapeToBottomRightPosition.ts +25 -0
- package/objects/roomShapeToDoorSlots.ts +83 -0
- package/objects/roomShapeToDoorSlotsToGridIndexDelta.ts +127 -0
- package/objects/roomShapeToGridWidth.ts +21 -0
- package/objects/roomShapeToTopLeftPosition.ts +26 -0
- package/objects/roomShapeVolumes.ts +38 -0
- package/objects/roomTypeNames.ts +36 -0
- package/objects/serializedIsaacAPIClassTypeToIdentityFunction.ts +14 -0
- package/objects/stageTypeToLetter.ts +15 -0
- package/objects/transformationNames.d.ts +0 -1
- package/objects/transformationNames.lua +0 -1
- package/objects/transformationNames.ts +18 -0
- package/package.json +2 -2
- package/patchErrorFunctions.ts +92 -0
- package/sets/LRoomShapesSet.ts +8 -0
- package/sets/bossSets.ts +470 -0
- package/sets/charactersThatStartWithAnActiveItemSet.ts +16 -0
- package/sets/charactersWithBlackHeartFromEternalHeartSet.ts +7 -0
- package/sets/charactersWithFreeDevilDealsSet.ts +4 -0
- package/sets/charactersWithNoRedHeartsSet.ts +17 -0
- package/sets/charactersWithNoSoulHeartsSet.ts +14 -0
- package/sets/chestPickupVariantsSet.ts +16 -0
- package/sets/familiarsThatShootPlayerTearsSet.ts +13 -0
- package/sets/lostStyleCharactersSet.ts +13 -0
- package/sets/mineShaftRoomSubTypesSet.ts +10 -0
- package/sets/redHeartSubTypesSet.ts +7 -0
- package/sets/sinEntityTypesSet.ts +11 -0
- package/sets/singleUseActiveCollectibleTypesSet.ts +13 -0
- package/sets/storyBossesSet.ts +17 -0
- package/types/AnyEntity.ts +12 -0
- package/types/AwaitingTextInput.d.ts +2 -0
- package/types/CollectibleIndex.d.ts +1 -1
- package/types/CollectibleIndex.ts +16 -0
- package/types/PickingUpItem.d.ts +3 -3
- package/types/PickingUpItem.ts +89 -0
- package/types/PlayerIndex.d.ts +1 -1
- package/types/PlayerIndex.ts +13 -0
- package/types/private/IsaacAPIClass.d.ts +1 -1
- package/types/private/IsaacAPIClass.ts +3 -0
- package/types/private/SerializedIsaacAPIClass.d.ts +1 -1
- package/types/private/SerializedIsaacAPIClass.ts +3 -0
- package/types/private/TSTLClass.d.ts +1 -1
- package/types/private/TSTLClass.ts +3 -0
- package/upgradeMod.d.ts +2 -2
- package/upgradeMod.lua +2 -2
- package/upgradeMod.ts +55 -0
package/functions/log.ts
ADDED
|
@@ -0,0 +1,720 @@
|
|
|
1
|
+
import {
|
|
2
|
+
DamageFlag,
|
|
3
|
+
EffectVariant,
|
|
4
|
+
EntityFlag,
|
|
5
|
+
EntityType,
|
|
6
|
+
GameStateFlag,
|
|
7
|
+
GridEntityType,
|
|
8
|
+
LevelStateFlag,
|
|
9
|
+
ProjectileFlag,
|
|
10
|
+
SeedEffect,
|
|
11
|
+
SoundEffect,
|
|
12
|
+
TearFlag,
|
|
13
|
+
UseFlag,
|
|
14
|
+
} from "isaac-typescript-definitions";
|
|
15
|
+
import { game, sfxManager } from "../cachedClasses";
|
|
16
|
+
import { arrayToString } from "./array";
|
|
17
|
+
import { getCollectibleName } from "./collectibles";
|
|
18
|
+
import { getEntities, getEntityID } from "./entity";
|
|
19
|
+
import { getEnumEntries } from "./enums";
|
|
20
|
+
import { hasFlag } from "./flag";
|
|
21
|
+
import { getGridEntities } from "./gridEntity";
|
|
22
|
+
import { getIsaacAPIClassName } from "./isaacAPIClass";
|
|
23
|
+
import { getEffectsList, getPlayerName } from "./player";
|
|
24
|
+
import { getPlayerHealth } from "./playerHealth";
|
|
25
|
+
import { getRoomData, getRoomGridIndex, getRoomListIndex } from "./roomData";
|
|
26
|
+
import { combineSets, getSortedSetValues } from "./set";
|
|
27
|
+
import { iterateTableInOrder } from "./table";
|
|
28
|
+
import { getTrinketName } from "./trinkets";
|
|
29
|
+
import { isTable, isUserdata } from "./types";
|
|
30
|
+
import { printConsole } from "./utils";
|
|
31
|
+
import { vectorToString } from "./vector";
|
|
32
|
+
|
|
33
|
+
const IGNORE_EFFECT_VARIANTS: ReadonlySet<EffectVariant> = new Set([
|
|
34
|
+
EffectVariant.BLOOD_EXPLOSION, // 2
|
|
35
|
+
EffectVariant.BLOOD_PARTICLE, // 5
|
|
36
|
+
EffectVariant.TINY_BUG, // 21
|
|
37
|
+
EffectVariant.TINY_FLY, // 33
|
|
38
|
+
EffectVariant.WATER_DROPLET, // 41
|
|
39
|
+
EffectVariant.WALL_BUG, // 68
|
|
40
|
+
EffectVariant.FALLING_EMBER, // 87
|
|
41
|
+
EffectVariant.LIGHT, // 121
|
|
42
|
+
EffectVariant.TADPOLE, // 158
|
|
43
|
+
]);
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* Helper function to prefix the name of the function and the line number before a debug message.
|
|
47
|
+
*/
|
|
48
|
+
export function getDebugPrependString(
|
|
49
|
+
msg: string,
|
|
50
|
+
// We use 3 as a default because:
|
|
51
|
+
// - 1 - getDebugPrependString
|
|
52
|
+
// - 2 - calling function
|
|
53
|
+
// - 3 - the function that calls the calling function
|
|
54
|
+
numParentFunctions = 3,
|
|
55
|
+
): string {
|
|
56
|
+
// "debug" is not always defined like the Lua definitions imply.
|
|
57
|
+
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
|
58
|
+
if (debug !== undefined) {
|
|
59
|
+
// The "--luadebug" launch flag is enabled.
|
|
60
|
+
const debugTable = debug.getinfo(numParentFunctions);
|
|
61
|
+
if (debugTable !== undefined) {
|
|
62
|
+
return `${debugTable.name}:${debugTable.linedefined} - ${msg}`;
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
if (getParentFunctionDescription !== undefined) {
|
|
67
|
+
// The Racing+ sandbox is enabled.
|
|
68
|
+
return `${getParentFunctionDescription(numParentFunctions + 1)} - ${msg}`;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
return msg;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
/**
|
|
75
|
+
* Helper function to avoid typing out `Isaac.DebugString()`.
|
|
76
|
+
*
|
|
77
|
+
* If you have the "--luadebug" launch flag turned on or the Racing+ sandbox enabled, then this
|
|
78
|
+
* function will also prepend the function name and the line number before the string.
|
|
79
|
+
*/
|
|
80
|
+
export function log(this: void, msg: string): void {
|
|
81
|
+
const debugMsg = getDebugPrependString(msg);
|
|
82
|
+
Isaac.DebugString(debugMsg);
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
export function logArray<T>(this: void, array: T[]): void {
|
|
86
|
+
const arrayString = arrayToString(array);
|
|
87
|
+
log(`Array: ${arrayString}`);
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
export function logColor(this: void, color: Color): void {
|
|
91
|
+
log(
|
|
92
|
+
`Color: R${color.R}, G${color.G}, B${color.B}, A${color.A}, RO${color.RO}, BO${color.BO}, GO${color.GO}`,
|
|
93
|
+
);
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
/** Helper function for printing out every damage flag that is turned on. Useful when debugging. */
|
|
97
|
+
export function logDamageFlags(
|
|
98
|
+
this: void,
|
|
99
|
+
flags: DamageFlag | BitFlags<DamageFlag>,
|
|
100
|
+
): void {
|
|
101
|
+
logFlags(flags, DamageFlag, "damage");
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
export function logEffects(this: void, player: EntityPlayer): void {
|
|
105
|
+
const effects = getEffectsList(player);
|
|
106
|
+
|
|
107
|
+
log("Logging player effects:");
|
|
108
|
+
|
|
109
|
+
if (effects.length === 0) {
|
|
110
|
+
log(" n/a (no effects)");
|
|
111
|
+
return;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
effects.forEach((effect, i) => {
|
|
115
|
+
let effectDescription: string;
|
|
116
|
+
if (effect.Item.IsCollectible()) {
|
|
117
|
+
const collectibleName = getCollectibleName(effect.Item.ID);
|
|
118
|
+
effectDescription = `Collectible: ${collectibleName}`;
|
|
119
|
+
} else if (effect.Item.IsTrinket()) {
|
|
120
|
+
const trinketName = getTrinketName(effect.Item.ID);
|
|
121
|
+
effectDescription = `Trinket: ${trinketName}`;
|
|
122
|
+
} else if (effect.Item.IsNull()) {
|
|
123
|
+
effectDescription = `Null item: ${effect.Item.ID}`;
|
|
124
|
+
} else {
|
|
125
|
+
effectDescription = `Unknown type of effect: ${effect.Item.ID}`;
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
log(` ${i + 1}) ${effectDescription} (x${effect.Count})`);
|
|
129
|
+
});
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
/** Helper function for printing out every entity (or filtered entity) in the current room. */
|
|
133
|
+
export function logEntities(
|
|
134
|
+
this: void,
|
|
135
|
+
includeBackgroundEffects: boolean,
|
|
136
|
+
entityTypeFilter?: EntityType,
|
|
137
|
+
): void {
|
|
138
|
+
let msg = "Entities in the room";
|
|
139
|
+
if (entityTypeFilter !== undefined) {
|
|
140
|
+
msg += ` (filtered to entity type ${entityTypeFilter})`;
|
|
141
|
+
} else if (!includeBackgroundEffects) {
|
|
142
|
+
msg += " (not including background effects)";
|
|
143
|
+
}
|
|
144
|
+
msg += ":\n";
|
|
145
|
+
|
|
146
|
+
const entities = getEntities();
|
|
147
|
+
let numMatchedEntities = 0;
|
|
148
|
+
entities.forEach((entity, i) => {
|
|
149
|
+
// If a filter was specified, exclude all entities outside of the filter.
|
|
150
|
+
if (entityTypeFilter !== undefined && entity.Type !== entityTypeFilter) {
|
|
151
|
+
return;
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
const effect = entity.ToEffect();
|
|
155
|
+
if (
|
|
156
|
+
!includeBackgroundEffects &&
|
|
157
|
+
effect !== undefined &&
|
|
158
|
+
IGNORE_EFFECT_VARIANTS.has(effect.Variant)
|
|
159
|
+
) {
|
|
160
|
+
return;
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
const entityID = getEntityID(entity);
|
|
164
|
+
msg += `${i + 1}) ${entityID}`;
|
|
165
|
+
|
|
166
|
+
const bomb = entity.ToBomb();
|
|
167
|
+
if (bomb !== undefined) {
|
|
168
|
+
msg += " (bomb)";
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
if (effect !== undefined) {
|
|
172
|
+
msg += ` (effect) (State: ${effect.State})`;
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
const familiar = entity.ToFamiliar();
|
|
176
|
+
if (familiar !== undefined) {
|
|
177
|
+
msg += ` (familiar) (State: ${familiar.State})`;
|
|
178
|
+
}
|
|
179
|
+
|
|
180
|
+
const knife = entity.ToKnife();
|
|
181
|
+
if (knife !== undefined) {
|
|
182
|
+
msg += " (knife)";
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
const laser = entity.ToLaser();
|
|
186
|
+
if (laser !== undefined) {
|
|
187
|
+
msg += " (laser)";
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
const npc = entity.ToNPC();
|
|
191
|
+
if (npc !== undefined) {
|
|
192
|
+
msg += ` (NPC) (State: ${npc.State})`;
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
const pickup = entity.ToPickup();
|
|
196
|
+
if (pickup !== undefined) {
|
|
197
|
+
msg += ` (pickup) (State: ${pickup.State})`;
|
|
198
|
+
}
|
|
199
|
+
|
|
200
|
+
const player = entity.ToPlayer();
|
|
201
|
+
if (player !== undefined) {
|
|
202
|
+
msg += " (player)";
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
const projectile = entity.ToProjectile();
|
|
206
|
+
if (projectile !== undefined) {
|
|
207
|
+
msg += " (projectile)";
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
const tear = entity.ToTear();
|
|
211
|
+
if (tear !== undefined) {
|
|
212
|
+
msg += " (tear)";
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
msg += "\n";
|
|
216
|
+
msg += ` - Index: ${entity.Index}\n`;
|
|
217
|
+
msg += ` - InitSeed: ${entity.InitSeed}\n`;
|
|
218
|
+
msg += ` - DropSeed: ${entity.DropSeed}\n`;
|
|
219
|
+
msg += ` - Position: (${entity.Position.X}, ${entity.Position.Y})\n`;
|
|
220
|
+
msg += ` - Velocity: (${entity.Velocity.X}, ${entity.Velocity.Y})\n`;
|
|
221
|
+
msg += ` - HP: ${entity.HitPoints} / ${entity.MaxHitPoints}\n`;
|
|
222
|
+
msg += ` - Parent: ${entity.Parent}\n`;
|
|
223
|
+
msg += ` - Child: ${entity.Child}\n`;
|
|
224
|
+
msg += ` - SpawnerEntity: ${entity.SpawnerEntity}\n`;
|
|
225
|
+
msg += ` - SpawnerType / SpawnerVariant: ${entity.SpawnerType}.${entity.SpawnerVariant}\n`;
|
|
226
|
+
if (npc !== undefined) {
|
|
227
|
+
msg += ` - CanShutDoors: ${npc.CanShutDoors}\n`;
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
numMatchedEntities += 1;
|
|
231
|
+
});
|
|
232
|
+
|
|
233
|
+
if (numMatchedEntities === 0) {
|
|
234
|
+
msg += "(no entities matched)\n";
|
|
235
|
+
} else {
|
|
236
|
+
msg += `(${numMatchedEntities} total ${
|
|
237
|
+
numMatchedEntities === 1 ? "entity" : "entities"
|
|
238
|
+
})\n`;
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
log(msg);
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
/** Helper function for printing out every entity flag that is turned on. Useful when debugging. */
|
|
245
|
+
export function logEntityFlags(
|
|
246
|
+
this: void,
|
|
247
|
+
flags: EntityFlag | BitFlags<EntityFlag>,
|
|
248
|
+
): void {
|
|
249
|
+
logFlags(flags, EntityFlag, "entity");
|
|
250
|
+
}
|
|
251
|
+
|
|
252
|
+
export function logEntityID(this: void, entity: Entity): void {
|
|
253
|
+
log(`Entity: ${entity.Type}.${entity.Variant}.${entity.SubType}`);
|
|
254
|
+
}
|
|
255
|
+
|
|
256
|
+
/**
|
|
257
|
+
* Helper function to log an error message and also print it to the console for better visibility.
|
|
258
|
+
*
|
|
259
|
+
* This is useful in situations where using the `error` function would be dangerous (since it
|
|
260
|
+
* prevents all of the subsequent code in the callback from running).
|
|
261
|
+
*/
|
|
262
|
+
export function logError(this: void, msg: string): void {
|
|
263
|
+
const errorMsg = `Error: ${msg}`;
|
|
264
|
+
log(errorMsg);
|
|
265
|
+
printConsole(errorMsg);
|
|
266
|
+
}
|
|
267
|
+
|
|
268
|
+
/** Helper function for printing out every flag that is turned on. Useful when debugging. */
|
|
269
|
+
export function logFlags<T extends BitFlag | BitFlag128>(
|
|
270
|
+
this: void,
|
|
271
|
+
flags: T | BitFlags<T>,
|
|
272
|
+
flagEnum: Record<string, T>,
|
|
273
|
+
description = "",
|
|
274
|
+
): void {
|
|
275
|
+
if (description !== "") {
|
|
276
|
+
description = "flag";
|
|
277
|
+
}
|
|
278
|
+
|
|
279
|
+
// eslint-disable-next-line @typescript-eslint/no-base-to-string
|
|
280
|
+
log(`Logging ${description} values for: ${flags}`);
|
|
281
|
+
let hasNoFlags = true;
|
|
282
|
+
for (const [key, value] of getEnumEntries(flagEnum)) {
|
|
283
|
+
if (hasFlag(flags, value)) {
|
|
284
|
+
// eslint-disable-next-line @typescript-eslint/no-base-to-string
|
|
285
|
+
log(` Has flag: ${key} (${value})`);
|
|
286
|
+
hasNoFlags = false;
|
|
287
|
+
}
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
if (hasNoFlags) {
|
|
291
|
+
log(" n/a (no flags)");
|
|
292
|
+
}
|
|
293
|
+
}
|
|
294
|
+
|
|
295
|
+
/**
|
|
296
|
+
* Helper function for printing out every game state flag that is turned on. Useful when debugging.
|
|
297
|
+
*/
|
|
298
|
+
export function logGameStateFlags(this: void): void {
|
|
299
|
+
log("Logging game state flags:");
|
|
300
|
+
|
|
301
|
+
const gameStateFlagEntries = getEnumEntries(GameStateFlag);
|
|
302
|
+
|
|
303
|
+
let hasNoFlags = true;
|
|
304
|
+
for (const [key, gameStateFlag] of gameStateFlagEntries) {
|
|
305
|
+
const flagValue = game.GetStateFlag(gameStateFlag);
|
|
306
|
+
if (flagValue) {
|
|
307
|
+
log(` Has flag: ${key} (${gameStateFlag})`);
|
|
308
|
+
hasNoFlags = false;
|
|
309
|
+
}
|
|
310
|
+
}
|
|
311
|
+
|
|
312
|
+
if (hasNoFlags) {
|
|
313
|
+
log(" n/a (no flags)");
|
|
314
|
+
}
|
|
315
|
+
}
|
|
316
|
+
|
|
317
|
+
/**
|
|
318
|
+
* Helper function for printing out every grid entity (or filtered grid entity) in the current room.
|
|
319
|
+
*/
|
|
320
|
+
export function logGridEntities(
|
|
321
|
+
this: void,
|
|
322
|
+
includeWalls: boolean,
|
|
323
|
+
gridEntityTypeFilter?: GridEntityType,
|
|
324
|
+
): void {
|
|
325
|
+
let msg = "Grid entities in the room";
|
|
326
|
+
if (gridEntityTypeFilter !== undefined) {
|
|
327
|
+
msg += ` (filtered to grid entity type ${gridEntityTypeFilter})`;
|
|
328
|
+
} else if (!includeWalls) {
|
|
329
|
+
msg += " (not including walls)";
|
|
330
|
+
}
|
|
331
|
+
msg += ":\n";
|
|
332
|
+
|
|
333
|
+
const gridEntities = getGridEntities();
|
|
334
|
+
let numMatchedEntities = 0;
|
|
335
|
+
gridEntities.forEach((gridEntity) => {
|
|
336
|
+
const gridEntityIndex = gridEntity.GetGridIndex();
|
|
337
|
+
const gridEntityType = gridEntity.GetType();
|
|
338
|
+
const gridEntityVariant = gridEntity.GetVariant();
|
|
339
|
+
const gridEntityDesc = gridEntity.GetSaveState();
|
|
340
|
+
|
|
341
|
+
// If a filter was specified, exclude all entities outside of the filter.
|
|
342
|
+
if (
|
|
343
|
+
gridEntityTypeFilter !== undefined &&
|
|
344
|
+
gridEntityType !== gridEntityTypeFilter
|
|
345
|
+
) {
|
|
346
|
+
return;
|
|
347
|
+
}
|
|
348
|
+
|
|
349
|
+
if (
|
|
350
|
+
!includeWalls &&
|
|
351
|
+
gridEntityType === GridEntityType.WALL &&
|
|
352
|
+
gridEntityTypeFilter !== GridEntityType.WALL
|
|
353
|
+
) {
|
|
354
|
+
return;
|
|
355
|
+
}
|
|
356
|
+
|
|
357
|
+
msg += `${gridEntityIndex}) ${gridEntityType}.${gridEntityVariant}.${gridEntity.State}`;
|
|
358
|
+
|
|
359
|
+
const door = gridEntity.ToDoor();
|
|
360
|
+
if (door !== undefined) {
|
|
361
|
+
msg += " (door)";
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
const pit = gridEntity.ToPit();
|
|
365
|
+
if (pit !== undefined) {
|
|
366
|
+
msg += " (pit)";
|
|
367
|
+
}
|
|
368
|
+
|
|
369
|
+
const poop = gridEntity.ToPoop();
|
|
370
|
+
if (poop !== undefined) {
|
|
371
|
+
msg += " (poop)";
|
|
372
|
+
}
|
|
373
|
+
|
|
374
|
+
const pressurePlate = gridEntity.ToPressurePlate();
|
|
375
|
+
if (pressurePlate !== undefined) {
|
|
376
|
+
msg += " (pressurePlate)";
|
|
377
|
+
}
|
|
378
|
+
|
|
379
|
+
const rock = gridEntity.ToRock();
|
|
380
|
+
if (rock !== undefined) {
|
|
381
|
+
msg += " (rock)";
|
|
382
|
+
}
|
|
383
|
+
|
|
384
|
+
const spikes = gridEntity.ToSpikes();
|
|
385
|
+
if (spikes !== undefined) {
|
|
386
|
+
msg += " (spikes)";
|
|
387
|
+
}
|
|
388
|
+
|
|
389
|
+
const tnt = gridEntity.ToTNT();
|
|
390
|
+
if (tnt !== undefined) {
|
|
391
|
+
msg += " (TNT)";
|
|
392
|
+
}
|
|
393
|
+
|
|
394
|
+
msg += ` - VarData: ${gridEntity.VarData}\n`;
|
|
395
|
+
msg += ` - Position: (${gridEntity.Position.X}, ${gridEntity.Position.Y})\n`;
|
|
396
|
+
msg += ` - SpawnSeed: ${gridEntityDesc.SpawnSeed}\n`;
|
|
397
|
+
msg += ` - VariableSeed: ${gridEntityDesc.VariableSeed})\n`;
|
|
398
|
+
if (door !== undefined) {
|
|
399
|
+
msg += ` - Slot: ${door.Slot}\n`;
|
|
400
|
+
msg += ` - Direction: ${door.Direction}\n`;
|
|
401
|
+
msg += ` - TargetRoomIndex: ${door.TargetRoomIndex}\n`;
|
|
402
|
+
msg += ` - TargetRoomType: ${door.TargetRoomType}\n`;
|
|
403
|
+
}
|
|
404
|
+
|
|
405
|
+
numMatchedEntities += 1;
|
|
406
|
+
});
|
|
407
|
+
|
|
408
|
+
if (numMatchedEntities === 0) {
|
|
409
|
+
msg += "(no grid entities matched)\n";
|
|
410
|
+
} else {
|
|
411
|
+
msg += `(${numMatchedEntities} total grid ${
|
|
412
|
+
numMatchedEntities === 1 ? "entity" : "entities"
|
|
413
|
+
})\n`;
|
|
414
|
+
}
|
|
415
|
+
|
|
416
|
+
log(msg);
|
|
417
|
+
}
|
|
418
|
+
|
|
419
|
+
export function logKColor(this: void, kColor: KColor): void {
|
|
420
|
+
log(
|
|
421
|
+
`Color: R${kColor.Red}, G${kColor.Green}, B${kColor.Blue}, A${kColor.Alpha}`,
|
|
422
|
+
);
|
|
423
|
+
}
|
|
424
|
+
|
|
425
|
+
/**
|
|
426
|
+
* Helper function for printing out every level state flag that is turned on. Useful when debugging.
|
|
427
|
+
*/
|
|
428
|
+
export function logLevelStateFlags(this: void): void {
|
|
429
|
+
const level = game.GetLevel();
|
|
430
|
+
|
|
431
|
+
const levelStateFlagEntries = getEnumEntries(LevelStateFlag);
|
|
432
|
+
|
|
433
|
+
log("Logging level state flags:");
|
|
434
|
+
let hasNoFlags = true;
|
|
435
|
+
for (const [key, levelStateFlag] of levelStateFlagEntries) {
|
|
436
|
+
const flagValue = level.GetStateFlag(levelStateFlag);
|
|
437
|
+
if (flagValue) {
|
|
438
|
+
log(` Has flag: ${key} (${levelStateFlag})`);
|
|
439
|
+
hasNoFlags = false;
|
|
440
|
+
}
|
|
441
|
+
}
|
|
442
|
+
|
|
443
|
+
if (hasNoFlags) {
|
|
444
|
+
log(" n/a (no flags)");
|
|
445
|
+
}
|
|
446
|
+
}
|
|
447
|
+
|
|
448
|
+
export function logMap(this: void, map: Map<AnyNotNil, unknown>): void {
|
|
449
|
+
log("Printing out a TSTL Map:");
|
|
450
|
+
|
|
451
|
+
const mapKeys = [...map.keys()];
|
|
452
|
+
mapKeys.sort();
|
|
453
|
+
|
|
454
|
+
for (const key of mapKeys) {
|
|
455
|
+
const value = map.get(key);
|
|
456
|
+
// eslint-disable-next-line @typescript-eslint/no-base-to-string
|
|
457
|
+
log(` ${key} --> ${value}`);
|
|
458
|
+
}
|
|
459
|
+
|
|
460
|
+
log(` The size of the map was: ${map.size}`);
|
|
461
|
+
}
|
|
462
|
+
|
|
463
|
+
export function logPlayerHealth(this: void, player: EntityPlayer): void {
|
|
464
|
+
const playerName = getPlayerName(player);
|
|
465
|
+
const playerHealth = getPlayerHealth(player);
|
|
466
|
+
|
|
467
|
+
log(`Player health for ${playerName}:`);
|
|
468
|
+
log(` Max hearts: ${playerHealth.maxHearts}`);
|
|
469
|
+
log(` Hearts: ${playerHealth.hearts}`);
|
|
470
|
+
log(` Eternal hearts: ${playerHealth.eternalHearts}`);
|
|
471
|
+
log(` Soul hearts: ${playerHealth.soulHearts}`);
|
|
472
|
+
log(` Bone hearts: ${playerHealth.boneHearts}`);
|
|
473
|
+
log(` Golden hearts: ${playerHealth.goldenHearts}`);
|
|
474
|
+
log(` Rotten hearts: ${playerHealth.rottenHearts}`);
|
|
475
|
+
log(` Broken hearts: ${playerHealth.brokenHearts}`);
|
|
476
|
+
log(` Soul charges: ${playerHealth.soulCharges}`);
|
|
477
|
+
log(` Blood charges: ${playerHealth.bloodCharges}`);
|
|
478
|
+
log(` Soul heart types: [${playerHealth.soulHeartTypes.join(",")}]`);
|
|
479
|
+
}
|
|
480
|
+
|
|
481
|
+
/**
|
|
482
|
+
* Helper function for printing out every projectile flag that is turned on. Useful when debugging.
|
|
483
|
+
*/
|
|
484
|
+
export function logProjectileFlags(
|
|
485
|
+
this: void,
|
|
486
|
+
flags: ProjectileFlag | BitFlags<ProjectileFlag>,
|
|
487
|
+
): void {
|
|
488
|
+
logFlags(flags, ProjectileFlag, "projectile");
|
|
489
|
+
}
|
|
490
|
+
|
|
491
|
+
/** Helper function for logging information about the current room. */
|
|
492
|
+
export function logRoom(this: void): void {
|
|
493
|
+
const roomGridIndex = getRoomGridIndex();
|
|
494
|
+
const roomListIndex = getRoomListIndex();
|
|
495
|
+
const roomData = getRoomData();
|
|
496
|
+
|
|
497
|
+
if (roomData === undefined) {
|
|
498
|
+
log("Current room data is undefined.");
|
|
499
|
+
} else {
|
|
500
|
+
log(`Current room stage ID: ${roomData.StageID}`);
|
|
501
|
+
log(
|
|
502
|
+
`Current room type/variant/sub-type: ${roomData.Type}.${roomData.Variant}.${roomData.Subtype}`,
|
|
503
|
+
);
|
|
504
|
+
log(`Current room name: ${roomData.Name}`);
|
|
505
|
+
}
|
|
506
|
+
log(`Current room grid index: ${roomGridIndex}`);
|
|
507
|
+
log(`Current room list index: ${roomListIndex}`);
|
|
508
|
+
}
|
|
509
|
+
|
|
510
|
+
/**
|
|
511
|
+
* Helper function for printing out every seed effect (i.e. Easter Egg) that is turned on for the
|
|
512
|
+
* particular run.
|
|
513
|
+
*/
|
|
514
|
+
export function logSeedEffects(this: void): void {
|
|
515
|
+
const seeds = game.GetSeeds();
|
|
516
|
+
|
|
517
|
+
const seedEffectEntries = getEnumEntries(SeedEffect);
|
|
518
|
+
|
|
519
|
+
log("Logging seed effects:");
|
|
520
|
+
let hasNoSeedEffects = true;
|
|
521
|
+
for (const [key, seedEffect] of seedEffectEntries) {
|
|
522
|
+
if (seeds.HasSeedEffect(seedEffect)) {
|
|
523
|
+
log(` ${key} (${seedEffect})`);
|
|
524
|
+
hasNoSeedEffects = false;
|
|
525
|
+
}
|
|
526
|
+
}
|
|
527
|
+
|
|
528
|
+
if (hasNoSeedEffects) {
|
|
529
|
+
log(" n/a (no seed effects)");
|
|
530
|
+
}
|
|
531
|
+
}
|
|
532
|
+
|
|
533
|
+
export function logSet(this: void, set: Set<AnyNotNil>): void {
|
|
534
|
+
log("Printing out a TSTL Set:");
|
|
535
|
+
|
|
536
|
+
const setValues = getSortedSetValues(set);
|
|
537
|
+
for (const value of setValues) {
|
|
538
|
+
// eslint-disable-next-line @typescript-eslint/no-base-to-string
|
|
539
|
+
log(` Value: ${value}`);
|
|
540
|
+
}
|
|
541
|
+
|
|
542
|
+
log(` The size of the set was: ${set.size}`);
|
|
543
|
+
}
|
|
544
|
+
|
|
545
|
+
/** Helper function for logging every sound effect that is currently playing. */
|
|
546
|
+
export function logSounds(this: void): void {
|
|
547
|
+
const soundEffects = getEnumEntries(SoundEffect);
|
|
548
|
+
|
|
549
|
+
for (const [key, soundEffect] of soundEffects) {
|
|
550
|
+
if (sfxManager.IsPlaying(soundEffect)) {
|
|
551
|
+
log(`Currently playing sound effect: ${key} (${soundEffect})`);
|
|
552
|
+
}
|
|
553
|
+
}
|
|
554
|
+
}
|
|
555
|
+
|
|
556
|
+
/**
|
|
557
|
+
* Helper function for logging every key and value of a table. This is a deep log; the function will
|
|
558
|
+
* recursively call itself if it counters a table within a table.
|
|
559
|
+
*
|
|
560
|
+
* This function will only work on tables that have string keys (because it logs the keys in order,
|
|
561
|
+
* instead of randomly). It will throw a runtime error if it encounters a non-string key.
|
|
562
|
+
*/
|
|
563
|
+
export function logTable(
|
|
564
|
+
this: void,
|
|
565
|
+
luaTable: unknown,
|
|
566
|
+
parentTables = 0,
|
|
567
|
+
): void {
|
|
568
|
+
if (parentTables === 0) {
|
|
569
|
+
log("Printing out a Lua table:");
|
|
570
|
+
}
|
|
571
|
+
|
|
572
|
+
const numSpaces = (parentTables + 1) * 2; // 2, 4, 6, etc.
|
|
573
|
+
const indentation = " ".repeat(numSpaces);
|
|
574
|
+
|
|
575
|
+
if (!isTable(luaTable)) {
|
|
576
|
+
log(
|
|
577
|
+
`${indentation}n/a (encountered a variable of type "${typeof luaTable}" instead of a table)`,
|
|
578
|
+
);
|
|
579
|
+
return;
|
|
580
|
+
}
|
|
581
|
+
|
|
582
|
+
iterateTableInOrder(luaTable, (key, value) => {
|
|
583
|
+
// eslint-disable-next-line @typescript-eslint/no-base-to-string
|
|
584
|
+
log(`${indentation}${key} --> ${value}`);
|
|
585
|
+
|
|
586
|
+
if (isTable(value)) {
|
|
587
|
+
if (key === "__class") {
|
|
588
|
+
log(
|
|
589
|
+
`${indentation} (skipping enumerating this key to avoid infinite recursion)`,
|
|
590
|
+
);
|
|
591
|
+
} else {
|
|
592
|
+
logTable(value, parentTables + 1);
|
|
593
|
+
}
|
|
594
|
+
}
|
|
595
|
+
});
|
|
596
|
+
|
|
597
|
+
log(`${indentation}The size of the table was: ${luaTable.length()}`);
|
|
598
|
+
}
|
|
599
|
+
|
|
600
|
+
/**
|
|
601
|
+
* Helper function to print out the differences between the entries of two tables. Note that this
|
|
602
|
+
* will only do a shallow comparison.
|
|
603
|
+
*/
|
|
604
|
+
export function logTableDifferences<K, V>(
|
|
605
|
+
this: void,
|
|
606
|
+
table1: LuaTable<K, V>,
|
|
607
|
+
table2: LuaTable<K, V>,
|
|
608
|
+
): void {
|
|
609
|
+
log("Comparing two Lua tables:");
|
|
610
|
+
|
|
611
|
+
const table1Keys = Object.keys(table1);
|
|
612
|
+
const table1KeysSet = new Set(table1Keys);
|
|
613
|
+
|
|
614
|
+
const table2Keys = Object.keys(table2);
|
|
615
|
+
const table2KeysSet = new Set(table2Keys);
|
|
616
|
+
|
|
617
|
+
const keysSet = combineSets(table1KeysSet, table2KeysSet);
|
|
618
|
+
const keys = [...keysSet.values()];
|
|
619
|
+
keys.sort();
|
|
620
|
+
|
|
621
|
+
for (const key of keys) {
|
|
622
|
+
if (!table1KeysSet.has(key)) {
|
|
623
|
+
log(` Table 1 is missing key: ${key}`);
|
|
624
|
+
} else if (!table2KeysSet.has(key)) {
|
|
625
|
+
log(` Table 2 is missing key: ${key}`);
|
|
626
|
+
} else {
|
|
627
|
+
const value1 = table1.get(key as unknown as K);
|
|
628
|
+
const value2 = table2.get(key as unknown as K);
|
|
629
|
+
if (value1 !== value2) {
|
|
630
|
+
log(` ${key} --> "${value1}" versus "${value2}"`);
|
|
631
|
+
}
|
|
632
|
+
}
|
|
633
|
+
}
|
|
634
|
+
}
|
|
635
|
+
|
|
636
|
+
/** Helper function for printing out every tear flag that is turned on. Useful when debugging. */
|
|
637
|
+
export function logTearFlags(
|
|
638
|
+
this: void,
|
|
639
|
+
flags: TearFlag | BitFlags<TearFlag>,
|
|
640
|
+
): void {
|
|
641
|
+
logFlags(flags, TearFlag, "tear");
|
|
642
|
+
}
|
|
643
|
+
|
|
644
|
+
/** Helper function for printing out every use flag that is turned on. Useful when debugging. */
|
|
645
|
+
export function logUseFlags(
|
|
646
|
+
this: void,
|
|
647
|
+
flags: UseFlag | BitFlags<UseFlag>,
|
|
648
|
+
): void {
|
|
649
|
+
logFlags(flags, UseFlag, "use");
|
|
650
|
+
}
|
|
651
|
+
|
|
652
|
+
/**
|
|
653
|
+
* Helper function to enumerate all of the properties of a "userdata" object (i.e. an object from
|
|
654
|
+
* the Isaac API).
|
|
655
|
+
*/
|
|
656
|
+
export function logUserdata(this: void, userdata: unknown): void {
|
|
657
|
+
if (isUserdata(userdata)) {
|
|
658
|
+
log("Userdata: [not userdata]");
|
|
659
|
+
return;
|
|
660
|
+
}
|
|
661
|
+
|
|
662
|
+
const metatable = getmetatable(userdata) as
|
|
663
|
+
| LuaTable<AnyNotNil, unknown>
|
|
664
|
+
| undefined;
|
|
665
|
+
if (metatable === undefined) {
|
|
666
|
+
log("Userdata: [no metatable]");
|
|
667
|
+
return;
|
|
668
|
+
}
|
|
669
|
+
|
|
670
|
+
const classType = getIsaacAPIClassName(userdata);
|
|
671
|
+
if (classType === undefined) {
|
|
672
|
+
log("Userdata: [no class type]");
|
|
673
|
+
} else {
|
|
674
|
+
log(`Userdata: ${classType}`);
|
|
675
|
+
}
|
|
676
|
+
|
|
677
|
+
logTable(metatable);
|
|
678
|
+
}
|
|
679
|
+
|
|
680
|
+
export function logVector(this: void, vector: Vector, round = false): void {
|
|
681
|
+
const vectorString = vectorToString(vector, round);
|
|
682
|
+
log(`Vector: ${vectorString}`);
|
|
683
|
+
}
|
|
684
|
+
|
|
685
|
+
/**
|
|
686
|
+
* Converts every `isaacscript-common` function that begins with "log" to a global function.
|
|
687
|
+
*
|
|
688
|
+
* This is useful when printing out variables from the in-game debug console.
|
|
689
|
+
*/
|
|
690
|
+
export function setLogFunctionsGlobal(): void {
|
|
691
|
+
const globals = _G as Record<string, unknown>;
|
|
692
|
+
|
|
693
|
+
globals["log"] = log;
|
|
694
|
+
globals["logArray"] = logArray;
|
|
695
|
+
globals["logColor"] = logColor;
|
|
696
|
+
globals["logDamageFlags"] = logDamageFlags;
|
|
697
|
+
globals["logEffects"] = logEffects;
|
|
698
|
+
globals["logEntities"] = logEntities;
|
|
699
|
+
globals["logEntityID"] = logEntityID;
|
|
700
|
+
globals["logEntityFlags"] = logEntityFlags;
|
|
701
|
+
globals["logError"] = logError;
|
|
702
|
+
globals["logFlags"] = logFlags;
|
|
703
|
+
globals["logGameStateFlags"] = logGameStateFlags;
|
|
704
|
+
globals["logGridEntities"] = logGridEntities;
|
|
705
|
+
globals["logKColor"] = logKColor;
|
|
706
|
+
globals["logLevelStateFlags"] = logLevelStateFlags;
|
|
707
|
+
globals["logMap"] = logMap;
|
|
708
|
+
globals["logPlayerHealth"] = logPlayerHealth;
|
|
709
|
+
globals["logProjectileFlags"] = logProjectileFlags;
|
|
710
|
+
globals["logRoom"] = logRoom;
|
|
711
|
+
globals["logSeedEffects"] = logSeedEffects;
|
|
712
|
+
globals["logSet"] = logSet;
|
|
713
|
+
globals["logSounds"] = logSounds;
|
|
714
|
+
globals["logTable"] = logTable;
|
|
715
|
+
globals["logTableDifferences"] = logTableDifferences;
|
|
716
|
+
globals["logTearFlags"] = logTearFlags;
|
|
717
|
+
globals["logUseFlags"] = logUseFlags;
|
|
718
|
+
globals["logUserdata"] = logUserdata;
|
|
719
|
+
globals["logVector"] = logVector;
|
|
720
|
+
}
|