isaacscript-common 6.20.2 → 6.22.1

package/src/functions/doors.ts

@@ -8,7 +8,7 @@ import {
   RoomShape,
   RoomType,
 } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
+import { game } from "../core/cachedClasses";
 import {
   DEFAULT_DOOR_SLOT,
   DOOR_SLOT_FLAG_TO_DOOR_SLOT,
@@ -181,6 +181,12 @@ export function getOppositeDoorSlot(doorSlot: DoorSlot): DoorSlot | undefined {
   return OPPOSITE_DOOR_SLOTS[doorSlot];
 }
 
+/**
+ * Helper function to get the door that leads to the "secret exit" off-grid room that takes you to
+ * the Repentance floor.
+ *
+ * Returns undefined if the room has no Repentance doors.
+ */
 export function getRepentanceDoor(): GridEntityDoor | undefined {
   const doors = getDoors();
   return doors.find((door) => isRepentanceDoor(door));
@@ -330,6 +336,10 @@ export function isHiddenSecretRoomDoor(door: GridEntityDoor): boolean {
   return isSecretRoomDoor(door) && animation === "Hidden";
 }
 
+/**
+ * Helper function to check if the provided door leads to the "secret exit" off-grid room that takes
+ * you to the Repentance floor.
+ */
 export function isRepentanceDoor(door: GridEntityDoor): boolean {
   // eslint-disable-next-line isaacscript/strict-enums
   return door.TargetRoomIndex === GridRoom.SECRET_EXIT;

package/src/functions/entities.ts

@@ -1,6 +1,6 @@
 import { EntityType } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
-import { VectorZero } from "../constants";
+import { game } from "../core/cachedClasses";
+import { VectorZero } from "../core/constants";
 import { STORY_BOSSES_SET } from "../sets/storyBossesSet";
 import { AnyEntity } from "../types/AnyEntity";
 import { getIsaacAPIClassName } from "./isaacAPIClass";

package/src/functions/entitiesSpecific.ts

@@ -10,7 +10,7 @@ import {
   SlotVariant,
   TearVariant,
 } from "isaac-typescript-definitions";
-import { VectorZero } from "../constants";
+import { VectorZero } from "../core/constants";
 import { getEntities, removeEntities, spawn } from "./entities";
 
 /**

package/src/functions/familiars.ts

@@ -1,5 +1,5 @@
 import { CollectibleType, FamiliarVariant } from "isaac-typescript-definitions";
-import { itemConfig } from "../cachedClasses";
+import { itemConfig } from "../core/cachedClasses";
 import { FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET } from "../sets/familiarsThatShootPlayerTearsSet";
 import { getFamiliars } from "./entitiesSpecific";
 

package/src/functions/gridEntities.ts

@@ -7,8 +7,8 @@ import {
   StatueVariant,
   TrapdoorVariant,
 } 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 { GRID_ENTITY_TYPE_TO_BROKEN_STATE_MAP } from "../maps/gridEntityTypeToBrokenStateMap";
 import { GRID_ENTITY_XML_MAP } from "../maps/gridEntityXMLMap";
 import {

package/src/functions/index.ts

@@ -0,0 +1,99 @@
+/* eslint-disable sort-exports/sort-exports */
+
+export * from "./ambush";
+export * from "./array";
+export * from "./benchmark";
+export * from "./bitwise";
+export * from "./bombs";
+export * from "./bosses";
+export * from "./cacheFlag";
+export * from "./cards";
+export * from "./challenges";
+export * from "./characters";
+export * from "./charge";
+export * from "./chargeBar";
+export * from "./collectibleCacheFlag";
+export * from "./collectibles";
+export * from "./collectibleSet";
+export * from "./collectibleTag";
+export * from "./color";
+export * from "./curses";
+export * from "./debug";
+export * from "./deepCopy";
+export * from "./deepCopyTests";
+export * from "./dimensions";
+export * from "./direction";
+export * from "./doors";
+export * from "./easing";
+export * from "./eden";
+export * from "./effects";
+export * from "./entities";
+export * from "./entitiesSpecific";
+export * from "./entityTypes";
+export * from "./enums";
+export * from "./familiars";
+export * from "./flag";
+export * from "./flying";
+export * from "./globals";
+export * from "./gridEntities";
+export * from "./gridEntitiesSpecific";
+export * from "./input";
+export * from "./isaacAPIClass";
+export * from "./itemPool";
+export * from "./jsonHelpers";
+export * from "./jsonRoom";
+export * from "./kColor";
+export * from "./language";
+export * from "./level";
+export * from "./levelGrid";
+export * from "./log";
+export * from "./logEntities";
+export * from "./map";
+export * from "./math";
+export * from "./mergeTests";
+export * from "./minimap";
+export * from "./nextStage";
+export * from "./npcs";
+export * from "./pickups";
+export * from "./pickupsSpecific";
+export * from "./pickupVariants";
+export * from "./pills";
+export * from "./playerCenter";
+export * from "./playerDataStructures";
+export * from "./playerHealth";
+export * from "./playerIndex";
+export * from "./players";
+export * from "./pocketItems";
+export * from "./positionVelocity";
+export * from "./pressurePlate";
+export * from "./projectiles";
+export * from "./random";
+export * from "./reorderedCallbacks";
+export * from "./revive";
+export * from "./rng";
+export * from "./rockAlt";
+export * from "./roomData";
+export * from "./roomGrid";
+export * from "./rooms";
+export * from "./roomShape";
+export * from "./run";
+export * from "./saveFile";
+export * from "./seeds";
+export * from "./serialization";
+export * from "./set";
+export * from "./sound";
+export * from "./spawnCollectible";
+export * from "./sprites";
+export * from "./stage";
+export * from "./string";
+export * from "./table";
+export * from "./tears";
+export * from "./transformations";
+export * from "./trinketCacheFlag";
+export * from "./trinketGive";
+export * from "./trinkets";
+export * from "./tstlClass";
+export * from "./types";
+export * from "./ui";
+export * from "./utils";
+export * from "./vector";

package/src/functions/indexTypeDoc.ts

@@ -0,0 +1,99 @@
+/* eslint-disable sort-exports/sort-exports */
+
+export * as Ambush from "./ambush";
+export * as Array from "./array";
+export * as Benchmark from "./benchmark";
+export * as Bitwise from "./bitwise";
+export * as Bombs from "./bombs";
+export * as Bosses from "./bosses";
+export * as CacheFlag from "./cacheFlag";
+export * as Cards from "./cards";
+export * as Challenges from "./challenges";
+export * as Characters from "./characters";
+export * as Charge from "./charge";
+export * as ChargeBar from "./chargeBar";
+export * as CollectibleCacheFlag from "./collectibleCacheFlag";
+export * as Collectibles from "./collectibles";
+export * as CollectibleSet from "./collectibleSet";
+export * as CollectibleTag from "./collectibleTag";
+export * as Color from "./color";
+export * as Curses from "./curses";
+export * as Debug from "./debug";
+export * as DeepCopy from "./deepCopy";
+export * as DeepCopyTests from "./deepCopyTests";
+export * as Dimensions from "./dimensions";
+export * as Direction from "./direction";
+export * as Doors from "./doors";
+export * as Easing from "./easing";
+export * as Eden from "./eden";
+export * as Effects from "./effects";
+export * as Entities from "./entities";
+export * as EntitiesSpecific from "./entitiesSpecific";
+export * as EntityTypes from "./entityTypes";
+export * as Enums from "./enums";
+export * as Familiars from "./familiars";
+export * as Flag from "./flag";
+export * as Flying from "./flying";
+export * as Globals from "./globals";
+export * as GridEntities from "./gridEntities";
+export * as GridEntitiesSpecific from "./gridEntitiesSpecific";
+export * as Input from "./input";
+export * as IsaacAPIClass from "./isaacAPIClass";
+export * as ItemPool from "./itemPool";
+export * as JSONHelpers from "./jsonHelpers";
+export * as JSONRoom from "./jsonRoom";
+export * as KColor from "./kColor";
+export * as Language from "./language";
+export * as Level from "./level";
+export * as LevelGrid from "./levelGrid";
+export * as Log from "./log";
+export * as LogEntities from "./logEntities";
+export * as Map from "./map";
+export * as Math from "./math";
+export * as MergeTests from "./mergeTests";
+export * as Minimap from "./minimap";
+export * as NextStage from "./nextStage";
+export * as NPCs from "./npcs";
+export * as Pickups from "./pickups";
+export * as PickupsSpecific from "./pickupsSpecific";
+export * as PickupVariants from "./pickupVariants";
+export * as Pills from "./pills";
+export * as PlayerCenter from "./playerCenter";
+export * as PlayerDataStructures from "./playerDataStructures";
+export * as PlayerHealth from "./playerHealth";
+export * as PlayerIndex from "./playerIndex";
+export * as Players from "./players";
+export * as PocketItems from "./pocketItems";
+export * as PositionVelocity from "./positionVelocity";
+export * as PressurePlate from "./pressurePlate";
+export * as Projectiles from "./projectiles";
+export * as Random from "./random";
+export * as ReorderedCallbacks from "./reorderedCallbacks";
+export * as Revive from "./revive";
+export * as RNG from "./rng";
+export * as RockAlt from "./rockAlt";
+export * as RoomData from "./roomData";
+export * as RoomGrid from "./roomGrid";
+export * as Rooms from "./rooms";
+export * as RoomShape from "./roomShape";
+export * as Run from "./run";
+export * as SaveFile from "./saveFile";
+export * as Seeds from "./seeds";
+export * as Serialization from "./serialization";
+export * as Set from "./set";
+export * as Sound from "./sound";
+export * as SpawnCollectible from "./spawnCollectible";
+export * as Sprites from "./sprites";
+export * as Stage from "./stage";
+export * as String from "./string";
+export * as Table from "./table";
+export * as Tears from "./tears";
+export * as Transformations from "./transformations";
+export * as TrinketCacheFlag from "./trinketCacheFlag";
+export * as TrinketGive from "./trinketGive";
+export * as Trinkets from "./trinkets";
+export * as TSTLClass from "./tstlClass";
+export * as Types from "./types";
+export * as UI from "./ui";
+export * as Utils from "./utils";
+export * as Vector from "./vector";

package/src/functions/itemPool.ts

@@ -5,7 +5,7 @@ import {
   PlayerType,
   TrinketType,
 } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
+import { game } from "../core/cachedClasses";
 import { PlayerIndex } from "../types/PlayerIndex";
 import { getCollectibleArray } from "./collectibleSet";
 import { collectibleHasTag } from "./collectibleTag";

package/src/functions/level.ts

@@ -1,5 +1,5 @@
 import { DoorSlot } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
+import { game } from "../core/cachedClasses";
 import { getEnumValues } from "./enums";
 import { isDoorSlotValidAtGridIndexForRedRoom } from "./levelGrid";
 import { getNumRooms, getRoomsInGrid } from "./rooms";

package/src/functions/levelGrid.ts

@@ -17,12 +17,12 @@ import {
   RoomShape,
   RoomType,
 } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
+import { game } from "../core/cachedClasses";
 import {
   ALL_DISPLAY_FLAGS,
   LEVEL_GRID_ROW_WIDTH,
   MAX_LEVEL_GRID_INDEX,
-} from "../constants";
+} from "../core/constants";
 import { ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA } from "../objects/roomShapeToDoorSlotsToGridIndexDelta";
 import { getRandomArrayElement } from "./array";
 import { doorSlotToDoorSlotFlag } from "./doors";

package/src/functions/log.ts

@@ -1,10 +1,7 @@
 import {
   DamageFlag,
-  EffectVariant,
   EntityFlag,
-  EntityType,
   GameStateFlag,
-  GridEntityType,
   GridRoom,
   HeartSubType,
   LevelStateFlag,
@@ -14,13 +11,12 @@ import {
   TearFlag,
   UseFlag,
 } from "isaac-typescript-definitions";
-import { game, sfxManager } from "../cachedClasses";
+import { game, sfxManager } from "../core/cachedClasses";
 import { arrayToString } from "./array";
 import { getCollectibleName } from "./collectibles";
-import { getEntities, getEntityID } from "./entities";
+import { getEntityID } from "./entities";
 import { getEnumEntries } from "./enums";
 import { hasFlag } from "./flag";
-import { getGridEntities, getGridEntityID } from "./gridEntities";
 import { getIsaacAPIClassName } from "./isaacAPIClass";
 import { getPlayerHealth } from "./playerHealth";
 import { getEffectsList, getPlayerName } from "./players";
@@ -32,18 +28,6 @@ import { isTable, isUserdata } from "./types";
 import { printConsole } from "./utils";
 import { vectorToString } from "./vector";
 
-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 to prefix the name of the function and the line number before a debug message.
  */
@@ -84,106 +68,6 @@ export function log(this: void, msg: string): void {
   Isaac.DebugString(debugMsg);
 }
 
-/** 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);
-}
-
 export function logArray<T>(this: void, array: T[] | readonly T[]): void {
   const arrayString = arrayToString(array);
   log(`Array: ${arrayString}`);
@@ -203,92 +87,6 @@ export function logDamageFlags(
   logFlags(flags, DamageFlag, "damage");
 }
 
-/** 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 printing out every entity flag that is turned on. Useful when debugging. */
 export function logEntityFlags(
   this: void,
@@ -363,76 +161,6 @@ export function logGameStateFlags(this: void): void {
   }
 }
 
-/** 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;
-}
-
 export function logKColor(this: void, kColor: KColor): void {
   log(
     `Color: R${kColor.Red}, G${kColor.Green}, B${kColor.Blue}, A${kColor.Alpha}`,
@@ -764,20 +492,14 @@ export function setLogFunctionsGlobal(): void {
   const globals = _G as Record<string, unknown>;
 
   globals["log"] = log;
-  globals["logAllEntities"] = logAllEntities;
-  globals["logAllGridEntities"] = logAllGridEntities;
   globals["logArray"] = logArray;
   globals["logColor"] = logColor;
   globals["logDamageFlags"] = logDamageFlags;
-  globals["logEntities"] = logEntities;
-  globals["logEntity"] = logEntity;
   globals["logEntityID"] = logEntityID;
   globals["logEntityFlags"] = logEntityFlags;
   globals["logError"] = logError;
   globals["logFlags"] = logFlags;
   globals["logGameStateFlags"] = logGameStateFlags;
-  globals["logGridEntities"] = logGridEntities;
-  globals["logGridEntity"] = logGridEntity;
   globals["logKColor"] = logKColor;
   globals["logLevelStateFlags"] = logLevelStateFlags;
   globals["logMap"] = logMap;