isaacscript-common 87.9.7 → 87.10.0

package/dist/functions/logEntities.js

@@ -1,34 +1,24 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.logAllEntities = logAllEntities;
-exports.logAllGridEntities = logAllGridEntities;
-exports.logEntities = logEntities;
-exports.logEntity = logEntity;
-exports.logGridEntities = logGridEntities;
-exports.logGridEntity = logGridEntity;
-exports.logPtrHash = logPtrHash;
-exports.logPtrHashes = logPtrHashes;
-const isaac_typescript_definitions_1 = require("isaac-typescript-definitions");
-const ReadonlySet_1 = require("../types/ReadonlySet");
-const entities_1 = require("./entities");
-const gridEntities_1 = require("./gridEntities");
-const log_1 = require("./log");
-const IGNORE_EFFECT_VARIANTS = new ReadonlySet_1.ReadonlySet([
-    isaac_typescript_definitions_1.EffectVariant.BLOOD_EXPLOSION, // 2
-    isaac_typescript_definitions_1.EffectVariant.BLOOD_PARTICLE, // 5
-    isaac_typescript_definitions_1.EffectVariant.TINY_BUG, // 21
-    isaac_typescript_definitions_1.EffectVariant.TINY_FLY, // 33
-    isaac_typescript_definitions_1.EffectVariant.WATER_DROPLET, // 41
-    isaac_typescript_definitions_1.EffectVariant.WORM, // 63
-    isaac_typescript_definitions_1.EffectVariant.WALL_BUG, // 68
-    isaac_typescript_definitions_1.EffectVariant.FALLING_EMBER, // 87
-    isaac_typescript_definitions_1.EffectVariant.LIGHT, // 121
-    isaac_typescript_definitions_1.EffectVariant.MIST, // 138
-    isaac_typescript_definitions_1.EffectVariant.BACKDROP_DECORATION, // 140
-    isaac_typescript_definitions_1.EffectVariant.TADPOLE, // 158
+import { BombVariant, EffectVariant, EntityType, FamiliarVariant, GridEntityType, KnifeVariant, LaserVariant, PickupVariant, PlayerVariant, ProjectileVariant, TearVariant, } from "isaac-typescript-definitions";
+import { ReadonlySet } from "../types/ReadonlySet";
+import { getEntities, getEntityFromPtrHash, getEntityID } from "./entities";
+import { getGridEntities, getGridEntityID } from "./gridEntities";
+import { log } from "./log";
+const IGNORE_EFFECT_VARIANTS = new ReadonlySet([
+    EffectVariant.BLOOD_EXPLOSION, // 2
+    EffectVariant.BLOOD_PARTICLE, // 5
+    EffectVariant.TINY_BUG, // 21
+    EffectVariant.TINY_FLY, // 33
+    EffectVariant.WATER_DROPLET, // 41
+    EffectVariant.WORM, // 63
+    EffectVariant.WALL_BUG, // 68
+    EffectVariant.FALLING_EMBER, // 87
+    EffectVariant.LIGHT, // 121
+    EffectVariant.MIST, // 138
+    EffectVariant.BACKDROP_DECORATION, // 140
+    EffectVariant.TADPOLE, // 158
 ]);
 /** Helper function for printing out every entity (or filtered entity) in the current room. */
-function logAllEntities(includeBackgroundEffects, entityTypeFilter) {
+export function logAllEntities(includeBackgroundEffects, entityTypeFilter) {
     let msg = "Entities in the room";
     if (entityTypeFilter !== undefined) {
         msg += ` (filtered to entity type ${entityTypeFilter})`;
@@ -37,7 +27,7 @@ function logAllEntities(includeBackgroundEffects, entityTypeFilter) {
         msg += " (not including background effects)";
     }
     msg += ":\n";
-    const entities = (0, entities_1.getEntities)();
+    const entities = getEntities();
     let numMatchedEntities = 0;
     for (const [i, entity] of entities.entries()) {
         // If a filter was specified, exclude all entities outside of the filter.
@@ -59,7 +49,7 @@ function logAllEntities(includeBackgroundEffects, entityTypeFilter) {
     msg += `${text}\n`;
     // We must log each line because otherwise the message can get truncated.
     for (const line of msg.trim().split("\n")) {
-        (0, log_1.log)(line);
+        log(line);
     }
 }
 /**
@@ -69,7 +59,7 @@ function logAllEntities(includeBackgroundEffects, entityTypeFilter) {
  * @param gridEntityTypeFilter Optional. If specified, will only log the given `GridEntityType`.
  *                             Default is undefined.
  */
-function logAllGridEntities(includeWalls = false, gridEntityTypeFilter) {
+export function logAllGridEntities(includeWalls = false, gridEntityTypeFilter) {
     let msg = "Grid entities in the room";
     if (gridEntityTypeFilter !== undefined) {
         msg += ` (filtered to grid entity type ${gridEntityTypeFilter})`;
@@ -78,7 +68,7 @@ function logAllGridEntities(includeWalls = false, gridEntityTypeFilter) {
         msg += " (not including walls)";
     }
     msg += ":\n";
-    const gridEntities = (0, gridEntities_1.getGridEntities)();
+    const gridEntities = getGridEntities();
     let numMatchedEntities = 0;
     for (const gridEntity of gridEntities) {
         const gridEntityIndex = gridEntity.GetGridIndex();
@@ -89,8 +79,8 @@ function logAllGridEntities(includeWalls = false, gridEntityTypeFilter) {
             continue;
         }
         if (!includeWalls
-            && gridEntityType === isaac_typescript_definitions_1.GridEntityType.WALL
-            && gridEntityTypeFilter !== isaac_typescript_definitions_1.GridEntityType.WALL) {
+            && gridEntityType === GridEntityType.WALL
+            && gridEntityTypeFilter !== GridEntityType.WALL) {
             continue;
         }
         msg += getGridEntityLogLine(gridEntity, gridEntityIndex);
@@ -102,40 +92,40 @@ function logAllGridEntities(includeWalls = false, gridEntityTypeFilter) {
             : `(${numMatchedEntities} total grid ${numMatchedEntities === 1 ? "entity" : "entities"})\n`;
     // We must log each line because otherwise the message can get truncated.
     for (const line of msg.trim().split("\n")) {
-        (0, log_1.log)(line);
+        log(line);
     }
 }
 /** Helper function for logging an array of specific entities. */
-function logEntities(entities) {
+export function logEntities(entities) {
     for (const entity of entities) {
         logEntity(entity);
     }
 }
 /** Helper function to log information about a specific entity. */
-function logEntity(entity) {
+export function logEntity(entity) {
     const msg = getEntityLogLine(entity);
-    (0, log_1.log)(msg);
+    log(msg);
 }
 /** Helper function for logging an array of specific grid entities. */
-function logGridEntities(gridEntities) {
+export function logGridEntities(gridEntities) {
     for (const gridEntity of gridEntities) {
         logGridEntity(gridEntity);
     }
 }
 /** Helper function for log information about a specific grid entity. */
-function logGridEntity(gridEntity) {
+export function logGridEntity(gridEntity) {
     const msg = getGridEntityLogLine(gridEntity);
-    (0, log_1.log)(msg);
+    log(msg);
 }
 /**
  * Helper function to log information about the entity that corresponding to a pointer hash. (Only
  * use this when debugging, since retrieving the corresponding entity is expensive.)
  */
-function logPtrHash(ptrHash) {
-    (0, log_1.log)(`PtrHash: ${ptrHash}`);
-    const entity = (0, entities_1.getEntityFromPtrHash)(ptrHash);
+export function logPtrHash(ptrHash) {
+    log(`PtrHash: ${ptrHash}`);
+    const entity = getEntityFromPtrHash(ptrHash);
     if (entity === undefined) {
-        (0, log_1.log)("No corresponding entity found.");
+        log("No corresponding entity found.");
     }
     else {
         logEntity(entity);
@@ -145,24 +135,24 @@ function logPtrHash(ptrHash) {
  * Helper function to log information about the entity that corresponding to one or more pointer
  * hashes. (Only use this when debugging, since retrieving the corresponding entity is expensive.)
  */
-function logPtrHashes(ptrHashes) {
+export function logPtrHashes(ptrHashes) {
     for (const ptrHash of ptrHashes) {
         logPtrHash(ptrHash);
     }
 }
 function getBombVariantName(bomb) {
     // Handle modded entities.
-    const enumName = isaac_typescript_definitions_1.BombVariant[bomb.Variant];
+    const enumName = BombVariant[bomb.Variant];
     return enumName === undefined ? "unknown" : `BombVariant.${enumName}`;
 }
 function getEffectVariantName(effect) {
     // Handle modded entities.
-    const enumName = isaac_typescript_definitions_1.EffectVariant[effect.Variant];
+    const enumName = EffectVariant[effect.Variant];
     return enumName === undefined ? "unknown" : `EffectVariant.${enumName}`;
 }
 function getEntityLogLine(entity, num) {
     let msg = num === undefined ? "" : `${num}) `;
-    msg += (0, entities_1.getEntityID)(entity);
+    msg += getEntityID(entity);
     const bomb = entity.ToBomb();
     if (bomb !== undefined) {
         msg += ` (bomb - ${getBombVariantName(bomb)})`;
@@ -225,18 +215,18 @@ function getEntityLogLine(entity, num) {
 }
 function getEntityTypeName(npc) {
     // Handle modded entities.
-    const enumName = isaac_typescript_definitions_1.EntityType[npc.Type];
+    const enumName = EntityType[npc.Type];
     return enumName === undefined ? "unknown" : `EntityType.${enumName}`;
 }
 function getFamiliarVariantName(familiar) {
     // Handle modded entities.
-    const enumName = isaac_typescript_definitions_1.FamiliarVariant[familiar.Variant];
+    const enumName = FamiliarVariant[familiar.Variant];
     return enumName === undefined ? "unknown" : `FamiliarVariant.${enumName}`;
 }
 function getGridEntityLogLine(gridEntity, num) {
     const gridEntityDesc = gridEntity.GetSaveState();
     let msg = num === undefined ? "" : `${num}) `;
-    msg += (0, gridEntities_1.getGridEntityID)(gridEntity);
+    msg += getGridEntityID(gridEntity);
     const door = gridEntity.ToDoor();
     if (door !== undefined) {
         msg += " (door)";
@@ -280,31 +270,31 @@ function getGridEntityLogLine(gridEntity, num) {
 }
 function getKnifeVariantName(knife) {
     // Handle modded entities.
-    const enumName = isaac_typescript_definitions_1.KnifeVariant[knife.Variant];
+    const enumName = KnifeVariant[knife.Variant];
     return enumName === undefined ? "unknown" : `KnifeVariant.${enumName}`;
 }
 function getLaserVariantName(laser) {
     // Handle modded entities.
-    const enumName = isaac_typescript_definitions_1.LaserVariant[laser.Variant];
+    const enumName = LaserVariant[laser.Variant];
     return enumName === undefined ? "unknown" : `LaserVariant.${enumName}`;
 }
 function getPickupVariantName(pickup) {
     // Handle modded entities.
-    const enumName = isaac_typescript_definitions_1.PickupVariant[pickup.Variant];
+    const enumName = PickupVariant[pickup.Variant];
     return enumName === undefined ? "unknown" : `PickupVariant.${enumName}`;
 }
 function getPlayerVariantName(player) {
     // Handle modded entities.
-    const enumName = isaac_typescript_definitions_1.PlayerVariant[player.Variant];
+    const enumName = PlayerVariant[player.Variant];
     return enumName === undefined ? "unknown" : `PlayerVariant.${enumName}`;
 }
 function getProjectileVariantName(projectile) {
     // Handle modded entities.
-    const enumName = isaac_typescript_definitions_1.ProjectileVariant[projectile.Variant];
+    const enumName = ProjectileVariant[projectile.Variant];
     return enumName === undefined ? "unknown" : `ProjectileVariant.${enumName}`;
 }
 function getTearVariantName(tear) {
     // Handle modded entities.
-    const enumName = isaac_typescript_definitions_1.TearVariant[tear.Variant];
+    const enumName = TearVariant[tear.Variant];
     return enumName === undefined ? "unknown" : `TearVariant.${enumName}`;
 }