isaacscript-common 6.20.2 → 6.22.1

package/src/functions/logEntities.ts

@@ -0,0 +1,276 @@
+import {
+  EffectVariant,
+  EntityType,
+  GridEntityType,
+} from "isaac-typescript-definitions";
+import { getEntities, getEntityID } from "./entities";
+import { getGridEntities, getGridEntityID } from "./gridEntities";
+import { log } from "./log";
+
+const IGNORE_EFFECT_VARIANTS: ReadonlySet<EffectVariant> = new Set([
+  EffectVariant.BLOOD_EXPLOSION, // 2
+  EffectVariant.BLOOD_PARTICLE, // 5
+  EffectVariant.TINY_BUG, // 21
+  EffectVariant.TINY_FLY, // 33
+  EffectVariant.WATER_DROPLET, // 41
+  EffectVariant.WALL_BUG, // 68
+  EffectVariant.FALLING_EMBER, // 87
+  EffectVariant.LIGHT, // 121
+  EffectVariant.TADPOLE, // 158
+]);
+
+/** Helper function for printing out every entity (or filtered entity) in the current room. */
+export function logAllEntities(
+  this: void,
+  includeBackgroundEffects: boolean,
+  entityTypeFilter?: EntityType,
+): void {
+  let msg = "Entities in the room";
+  if (entityTypeFilter !== undefined) {
+    msg += ` (filtered to entity type ${entityTypeFilter})`;
+  } else if (!includeBackgroundEffects) {
+    msg += " (not including background effects)";
+  }
+  msg += ":\n";
+
+  const entities = getEntities();
+  let numMatchedEntities = 0;
+  entities.forEach((entity, i) => {
+    // If a filter was specified, exclude all entities outside of the filter.
+    if (entityTypeFilter !== undefined && entity.Type !== entityTypeFilter) {
+      return;
+    }
+
+    const effect = entity.ToEffect();
+    if (
+      !includeBackgroundEffects &&
+      effect !== undefined &&
+      IGNORE_EFFECT_VARIANTS.has(effect.Variant)
+    ) {
+      return;
+    }
+
+    msg += getEntityLogLine(entity, i + 1);
+    numMatchedEntities++;
+  });
+
+  if (numMatchedEntities === 0) {
+    msg += "(no entities matched)\n";
+  } else {
+    msg += `(${numMatchedEntities} total ${
+      numMatchedEntities === 1 ? "entity" : "entities"
+    })\n`;
+  }
+
+  log(msg);
+}
+
+/**
+ * Helper function for printing out every grid entity (or filtered grid entity) in the current room.
+ */
+export function logAllGridEntities(
+  this: void,
+  includeWalls: boolean,
+  gridEntityTypeFilter?: GridEntityType,
+): void {
+  let msg = "Grid entities in the room";
+  if (gridEntityTypeFilter !== undefined) {
+    msg += ` (filtered to grid entity type ${gridEntityTypeFilter})`;
+  } else if (!includeWalls) {
+    msg += " (not including walls)";
+  }
+  msg += ":\n";
+
+  const gridEntities = getGridEntities();
+  let numMatchedEntities = 0;
+  gridEntities.forEach((gridEntity) => {
+    const gridEntityIndex = gridEntity.GetGridIndex();
+    const gridEntityType = gridEntity.GetType();
+
+    // If a filter was specified, exclude all entities outside of the filter.
+    if (
+      gridEntityTypeFilter !== undefined &&
+      gridEntityType !== gridEntityTypeFilter
+    ) {
+      return;
+    }
+
+    if (
+      !includeWalls &&
+      gridEntityType === GridEntityType.WALL &&
+      gridEntityTypeFilter !== GridEntityType.WALL
+    ) {
+      return;
+    }
+
+    msg += getGridEntityLogLine(gridEntity, gridEntityIndex);
+
+    numMatchedEntities++;
+  });
+
+  if (numMatchedEntities === 0) {
+    msg += "(no grid entities matched)\n";
+  } else {
+    msg += `(${numMatchedEntities} total grid ${
+      numMatchedEntities === 1 ? "entity" : "entities"
+    })\n`;
+  }
+
+  log(msg);
+}
+
+/** Helper function for logging an array of specific entities. */
+export function logEntities(this: void, entities: Entity[]): void {
+  for (const entity of entities) {
+    logEntity(entity);
+  }
+}
+
+/** Helper function to log information about a specific entity. */
+export function logEntity(this: void, entity: Entity): void {
+  const msg = getEntityLogLine(entity);
+  log(msg);
+}
+
+function getEntityLogLine(entity: Entity, num?: int): string {
+  let msg = num === undefined ? "" : `${num}) `;
+
+  msg += getEntityID(entity);
+
+  const bomb = entity.ToBomb();
+  if (bomb !== undefined) {
+    msg += " (bomb)";
+  }
+
+  const effect = entity.ToEffect();
+  if (effect !== undefined) {
+    msg += ` (effect) (State: ${effect.State})`;
+  }
+
+  const familiar = entity.ToFamiliar();
+  if (familiar !== undefined) {
+    msg += ` (familiar) (State: ${familiar.State})`;
+  }
+
+  const knife = entity.ToKnife();
+  if (knife !== undefined) {
+    msg += " (knife)";
+  }
+
+  const laser = entity.ToLaser();
+  if (laser !== undefined) {
+    msg += " (laser)";
+  }
+
+  const npc = entity.ToNPC();
+  if (npc !== undefined) {
+    msg += ` (NPC) (State: ${npc.State})`;
+  }
+
+  const pickup = entity.ToPickup();
+  if (pickup !== undefined) {
+    msg += ` (pickup) (State: ${pickup.State})`;
+  }
+
+  const player = entity.ToPlayer();
+  if (player !== undefined) {
+    msg += " (player)";
+  }
+
+  const projectile = entity.ToProjectile();
+  if (projectile !== undefined) {
+    msg += " (projectile)";
+  }
+
+  const tear = entity.ToTear();
+  if (tear !== undefined) {
+    msg += " (tear)";
+  }
+
+  msg += "\n";
+  msg += `  - Index: ${entity.Index}\n`;
+  msg += `  - InitSeed: ${entity.InitSeed}\n`;
+  msg += `  - DropSeed: ${entity.DropSeed}\n`;
+  msg += `  - Position: (${entity.Position.X}, ${entity.Position.Y})\n`;
+  msg += `  - Velocity: (${entity.Velocity.X}, ${entity.Velocity.Y})\n`;
+  msg += `  - HP: ${entity.HitPoints} / ${entity.MaxHitPoints}\n`;
+  msg += `  - Parent: ${entity.Parent}\n`;
+  msg += `  - Child: ${entity.Child}\n`;
+  msg += `  - SpawnerEntity: ${entity.SpawnerEntity}\n`;
+  msg += `  - SpawnerType / SpawnerVariant: ${entity.SpawnerType}.${entity.SpawnerVariant}\n`;
+  if (npc !== undefined) {
+    msg += `  - CanShutDoors: ${npc.CanShutDoors}\n`;
+  }
+
+  return msg;
+}
+
+/** Helper function for logging an array of specific grid entities. */
+export function logGridEntities(this: void, gridEntities: GridEntity[]): void {
+  for (const gridEntity of gridEntities) {
+    logGridEntity(gridEntity);
+  }
+}
+
+/** Helper function for log information about a specific grid entity. */
+export function logGridEntity(this: void, gridEntity: GridEntity): void {
+  const msg = getGridEntityLogLine(gridEntity);
+  log(msg);
+}
+
+function getGridEntityLogLine(gridEntity: GridEntity, num?: int): string {
+  const gridEntityDesc = gridEntity.GetSaveState();
+
+  let msg = num === undefined ? "" : `${num}) `;
+
+  msg += getGridEntityID(gridEntity);
+
+  const door = gridEntity.ToDoor();
+  if (door !== undefined) {
+    msg += " (door)";
+  }
+
+  const pit = gridEntity.ToPit();
+  if (pit !== undefined) {
+    msg += " (pit)";
+  }
+
+  const poop = gridEntity.ToPoop();
+  if (poop !== undefined) {
+    msg += " (poop)";
+  }
+
+  const pressurePlate = gridEntity.ToPressurePlate();
+  if (pressurePlate !== undefined) {
+    msg += " (pressurePlate)";
+  }
+
+  const rock = gridEntity.ToRock();
+  if (rock !== undefined) {
+    msg += " (rock)";
+  }
+
+  const spikes = gridEntity.ToSpikes();
+  if (spikes !== undefined) {
+    msg += " (spikes)";
+  }
+
+  const tnt = gridEntity.ToTNT();
+  if (tnt !== undefined) {
+    msg += " (TNT)";
+  }
+
+  msg += `  - State: ${gridEntity.State}\n`;
+  msg += `  - VarData: ${gridEntity.VarData}\n`;
+  msg += `  - Position: (${gridEntity.Position.X}, ${gridEntity.Position.Y})\n`;
+  msg += `  - SpawnSeed: ${gridEntityDesc.SpawnSeed}\n`;
+  msg += `  - VariableSeed: ${gridEntityDesc.VariableSeed})\n`;
+  if (door !== undefined) {
+    msg += `  - Slot: ${door.Slot}\n`;
+    msg += `  - Direction: ${door.Direction}\n`;
+    msg += `  - TargetRoomIndex: ${door.TargetRoomIndex}\n`;
+    msg += `  - TargetRoomType: ${door.TargetRoomType}\n`;
+  }
+
+  return msg;
+}

package/src/functions/mergeTests.ts

@@ -5,6 +5,7 @@ import { deepCopy } from "./deepCopy";
 import { log } from "./log";
 import { isRNG, newRNG } from "./rng";
 import { isSerializedIsaacAPIClass } from "./serialization";
+import { printConsole } from "./utils";
 import { isVector, serializeVector } from "./vector";
 
 /**
@@ -28,7 +29,9 @@ export function runMergeTests(): void {
   oldTableHasRNG();
   oldTableHasRNGSerialized();
 
-  log("All merge tests passed!");
+  const successText = "All merge tests passed!";
+  log(successText);
+  printConsole(successText);
 }
 
 function oldTableHasUpdatedValue() {

package/src/functions/minimap.ts

@@ -1,5 +1,5 @@
 import { DisplayFlag, DisplayFlagZero } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
+import { game } from "../core/cachedClasses";
 import { getRoomDescriptor } from "./roomData";
 import { getRoomsInGrid } from "./rooms";
 

package/src/functions/nextStage.ts

@@ -4,7 +4,7 @@ import {
   LevelStage,
   StageType,
 } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
+import { game } from "../core/cachedClasses";
 import { hasVisitedStage } from "../features/stageHistory";
 import { areFeaturesInitialized } from "../featuresInitialized";
 import { getRoomGridIndex } from "./roomData";

package/src/functions/npcs.ts

@@ -15,7 +15,7 @@ import {
   RaglingVariant,
   VisVariant,
 } from "isaac-typescript-definitions";
-import { EGGY_STATE_FRAME_OF_FINAL_SPIDER } from "../constants";
+import { EGGY_STATE_FRAME_OF_FINAL_SPIDER } from "../core/constants";
 import { getNPCs } from "./entitiesSpecific";
 
 /**

package/src/functions/pickupsSpecific.ts

@@ -11,7 +11,7 @@ import {
   SackSubType,
   TrinketType,
 } from "isaac-typescript-definitions";
-import { VectorZero } from "../constants";
+import { VectorZero } from "../core/constants";
 import { getPickups, removeAllPickups, spawnPickup } from "./entitiesSpecific";
 
 /**

package/src/functions/pills.ts

@@ -4,7 +4,7 @@ import {
   PillColor,
   PillEffect,
 } from "isaac-typescript-definitions";
-import { itemConfig } from "../cachedClasses";
+import { itemConfig } from "../core/cachedClasses";
 import {
   FIRST_HORSE_PILL_COLOR,
   FIRST_MODDED_PILL_EFFECT,
@@ -14,7 +14,7 @@ import {
   LAST_NORMAL_PILL_COLOR,
   LAST_PILL_EFFECT,
   LAST_VANILLA_PILL_EFFECT,
-} from "../constantsFirstLast";
+} from "../core/constantsFirstLast";
 import { FALSE_PHD_PILL_CONVERSIONS } from "../maps/falsePHDPillConversions";
 import { PHD_PILL_CONVERSIONS } from "../maps/PHDPillConversions";
 import {

package/src/functions/playerCenter.ts

@@ -1,9 +1,9 @@
 import { Direction } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
+import { game } from "../core/cachedClasses";
 import {
   NEW_FLOOR_STARTING_POSITION_GREED_MODE,
   NEW_FLOOR_STARTING_POSITION_NORMAL_MODE,
-} from "../constants";
+} from "../core/constants";
 import { getPlayerFamiliars } from "./familiars";
 import { getCircleDiscretizedPoints } from "./math";
 import { getAllPlayers } from "./playerIndex";

package/src/functions/playerHealth.ts

@@ -4,7 +4,7 @@ import {
   HeartSubType,
   PlayerType,
 } from "isaac-typescript-definitions";
-import { MAX_PLAYER_HEART_CONTAINERS } from "../constants";
+import { MAX_PLAYER_HEART_CONTAINERS } from "../core/constants";
 import { HealthType } from "../enums/HealthType";
 import { PlayerHealth, SoulHeartType } from "../interfaces/PlayerHealth";
 import { getTotalCharge } from "./charge";

package/src/functions/playerIndex.ts

@@ -1,5 +1,5 @@
 import { CollectibleType, PlayerType } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
+import { game } from "../core/cachedClasses";
 import { PlayerIndex } from "../types/PlayerIndex";
 
 const DEFAULT_COLLECTIBLE_TYPE = CollectibleType.SAD_ONION;

package/src/functions/players.ts

@@ -9,7 +9,7 @@ import {
   PlayerType,
   TrinketType,
 } from "isaac-typescript-definitions";
-import { game, itemConfig } from "../cachedClasses";
+import { game, itemConfig } from "../core/cachedClasses";
 import { HealthType } from "../enums/HealthType";
 import { getLastElement, sumArray } from "./array";
 import { countSetBits, getKBitOfN, getNumBitsOfN } from "./bitwise";

package/src/functions/positionVelocity.ts

@@ -2,8 +2,8 @@ import {
   EffectVariant,
   HeavenLightDoorSubType,
 } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
-import { DISTANCE_OF_GRID_TILE } from "../constants";
+import { game } from "../core/cachedClasses";
+import { DISTANCE_OF_GRID_TILE } from "../core/constants";
 import { getEntities } from "./entities";
 import { getEffects } from "./entitiesSpecific";
 import { getPlayers } from "./playerIndex";

package/src/functions/pressurePlate.ts

@@ -2,7 +2,7 @@ import {
   PressurePlateState,
   PressurePlateVariant,
 } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
+import { game } from "../core/cachedClasses";
 import { getPressurePlates } from "./gridEntitiesSpecific";
 
 /**

package/src/functions/reorderedCallbacks.ts

@@ -0,0 +1,46 @@
+import { LevelStage, StageType } from "isaac-typescript-definitions";
+import {
+  forceNewLevelCallbackInternal,
+  forceNewRoomCallbackInternal,
+  reorderedCallbacksSetStageInternal,
+} from "../callbacks/reorderedCallbacks";
+
+/**
+ * This is a utility function for users of the `ModCallbackCustom.POST_NEW_LEVEL_REORDERED` custom
+ * callback.
+ *
+ * If some specific cases, mods can change the current level during run initialization on the 0th
+ * frame. However, due to how the callback reordering works, the custom `POST_NEW_LEVEL` callback
+ * will never fire on the 0th frame. To get around this, call this function before changing levels
+ * to temporarily force the callback to fire.
+ */
+export function forceNewLevelCallback(): void {
+  forceNewLevelCallbackInternal();
+}
+
+/**
+ * This is a utility function for users of the `ModCallbackCustom.POST_NEW_ROOM_REORDERED` custom
+ * callback.
+ *
+ * If some specific cases, mods can change the current room during run initialization on the 0th
+ * frame. However, due to how the callback reordering works, the custom `POST_NEW_ROOM` callback
+ * will never fire on the 0th frame. To get around this, call this function before changing rooms to
+ * temporarily force the callback to fire.
+ */
+export function forceNewRoomCallback(): void {
+  forceNewRoomCallbackInternal();
+}
+
+/**
+ * Helper function to manually set the variable that the reordered callback logic uses to track the
+ * current stage and stage type.
+ *
+ * This is useful because if the stage is changed with the `Game.SetStage` method, the reordered
+ * callbacks will stop working.
+ */
+export function reorderedCallbacksSetStage(
+  stage: LevelStage,
+  stageType: StageType,
+): void {
+  reorderedCallbacksSetStageInternal(stage, stageType);
+}

package/src/functions/revive.ts

@@ -5,11 +5,11 @@ import {
   PlayerType,
   TrinketType,
 } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
+import { game } from "../core/cachedClasses";
 import {
   MAX_TAINTED_SAMSON_BERSERK_CHARGE,
   TAINTED_SAMSON_BERSERK_CHARGE_FROM_TAKING_DAMAGE,
-} from "../constants";
+} from "../core/constants";
 import { getCharacterDeathAnimationName } from "./characters";
 import {
   getPlayerMaxHeartContainers,

package/src/functions/rng.ts

@@ -1,4 +1,4 @@
-import { game } from "../cachedClasses";
+import { game } from "../core/cachedClasses";
 import { SerializationBrand } from "../enums/private/SerializationBrand";
 import { isaacAPIClassEquals, isIsaacAPIClassOfType } from "./isaacAPIClass";
 import { getNumbersFromTable, tableHasKeys } from "./table";