isaacscript-common 6.6.5 → 6.7.0

package/src/features/pause.ts

@@ -5,7 +5,7 @@ import {
   ModCallback,
 } from "isaac-typescript-definitions";
 import { logError } from "../functions/log";
-import { useActiveItemTemp } from "../functions/player";
+import { useActiveItemTemp } from "../functions/players";
 import { disableAllInputsExceptFor, enableAllInputs } from "./disableInputs";
 import { saveDataManager } from "./saveDataManager/exports";
 

package/src/features/persistentEntities.ts

@@ -7,7 +7,7 @@ import { game } from "../cachedClasses";
 import { ModUpgraded } from "../classes/ModUpgraded";
 import { ModCallbackCustom } from "../enums/ModCallbackCustom";
 import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
-import { spawn } from "../functions/entity";
+import { spawn } from "../functions/entities";
 import { getRoomListIndex } from "../functions/roomData";
 import { saveDataManager } from "./saveDataManager/exports";
 

package/src/features/preventCollectibleRotation.ts

@@ -10,7 +10,7 @@ import {
 import { game } from "../cachedClasses";
 import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
 import { setCollectibleSubType } from "../functions/collectibles";
-import { getEntityID } from "../functions/entity";
+import { getEntityID } from "../functions/entities";
 import { isCollectible } from "../functions/pickupVariants";
 import { saveDataManager } from "./saveDataManager/exports";
 

package/src/features/saveDataManager/exports.ts

@@ -169,8 +169,11 @@ export function saveDataManagerSave(): void {
   forceSaveDataManagerSave();
 }
 
-declare let g: LuaTable<string, SaveData>; // Globals
-declare let gd: LuaTable<string, SaveData>; // Globals defaults
+/** "g" stands for "globals". */
+declare let g: LuaTable<string, SaveData>; // eslint-disable-line @typescript-eslint/no-unused-vars
+
+/** "gd" stands for "globals defaults". */
+declare let gd: LuaTable<string, SaveData>; // eslint-disable-line @typescript-eslint/no-unused-vars
 
 /**
  * - Sets the global variable of "g" equal to all of the save data variables for this mod.
@@ -182,8 +185,8 @@ declare let gd: LuaTable<string, SaveData>; // Globals defaults
 export function saveDataManagerSetGlobal(): void {
   errorIfFeaturesNotInitialized(SAVE_DATA_MANAGER_FEATURE_NAME);
 
-  g = saveDataMap; // eslint-disable-line @typescript-eslint/no-unused-vars
-  gd = saveDataDefaultsMap; // eslint-disable-line @typescript-eslint/no-unused-vars
+  g = saveDataMap;
+  gd = saveDataDefaultsMap;
 }
 
 /**

package/src/features/sirenHelpers.ts

@@ -4,7 +4,7 @@ import {
   ModCallback,
 } from "isaac-typescript-definitions";
 import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
-import { getEntities } from "../functions/entity";
+import { getEntities } from "../functions/entities";
 import { saveDataManager } from "./saveDataManager/exports";
 
 const FEATURE_NAME = "sirenHelpers";

package/src/functions/ambush.ts

@@ -1,7 +1,7 @@
 import { SackSubType } from "isaac-typescript-definitions";
 import { runNextGameFrame } from "../features/runInNFrames";
-import { removeEntities } from "./entity";
-import { getCoins, spawnSackWithSeed } from "./pickups";
+import { removeEntities } from "./entities";
+import { getCoins, spawnSackWithSeed } from "./pickupsSpecific";
 
 /** Hard-coding this makes it easier to clean up the pickups afterwards. */
 const SACK_SEED_THAT_SPAWNS_TWO_COINS = 6 as Seed;

package/src/functions/{boss.ts → bosses.ts}

@@ -10,8 +10,8 @@ import {
   STAGE_TO_STAGE_TYPE_TO_BOSS_SET_MAP,
 } from "../sets/bossSets";
 import { SIN_ENTITY_TYPES_SET } from "../sets/sinEntityTypesSet";
-import { getNPCs, spawnNPC } from "./entitySpecific";
-import { getAliveNPCs } from "./npc";
+import { getNPCs, spawnNPC } from "./entitiesSpecific";
+import { getAliveNPCs } from "./npcs";
 import { isRNG } from "./rng";
 import { copySet } from "./set";
 import { repeat } from "./utils";
@@ -31,19 +31,22 @@ const DEFAULT_BOSS_MULTI_SEGMENTS = 4;
  *
  * This function will not include bosses on an internal blacklist, such as Death's scythes or Big
  * Horn holes.
+ *
+ * @param entityType Optional. If specified, will only get the bosses that match the type. Default
+ *                   is -1, which matches every type.
+ * @param variant Optional. If specified, will only get the bosses that match the variant. Default
+ *                is -1, which matches every variant.
+ * @param subType Optional. If specified, will only get the bosses that match the sub-type. Default
+ *                is -1, which matches every sub-type.
+ * @param ignoreFriendly Optional. Default is false.
  */
 export function getAliveBosses(
-  matchingEntityType?: EntityType,
-  matchingVariant?: int,
-  matchingSubType?: int,
+  entityType: EntityType = -1,
+  variant = -1,
+  subType = -1,
   ignoreFriendly = false,
 ): EntityNPC[] {
-  const aliveNPCs = getAliveNPCs(
-    matchingEntityType,
-    matchingVariant,
-    matchingSubType,
-    ignoreFriendly,
-  );
+  const aliveNPCs = getAliveNPCs(entityType, variant, subType, ignoreFriendly);
   return aliveNPCs.filter((aliveNPC) => aliveNPC.IsBoss());
 }
 
@@ -83,19 +86,24 @@ export function getBossSet(
   return copySet(bossSet);
 }
 
-/** Helper function to get all of the bosses in the room. */
+/**
+ * Helper function to get all of the bosses in the room.
+ *
+ * @param entityType Optional. If specified, will only get the bosses that match the type. Default
+ *                   is -1, which matches every type.
+ * @param variant Optional. If specified, will only get the bosses that match the variant. Default
+ *                is -1, which matches every variant.
+ * @param subType Optional. If specified, will only get the bosses that match the sub-type. Default
+ *                is -1, which matches every sub-type.
+ * @param ignoreFriendly Optional. Default is false.
+ */
 export function getBosses(
-  matchingEntityType?: EntityType,
-  matchingVariant?: int,
-  matchingSubType?: int,
+  entityType?: EntityType,
+  variant?: int,
+  subType?: int,
   ignoreFriendly = false,
 ): EntityNPC[] {
-  const npcs = getNPCs(
-    matchingEntityType,
-    matchingVariant,
-    matchingSubType,
-    ignoreFriendly,
-  );
+  const npcs = getNPCs(entityType, variant, subType, ignoreFriendly);
   return npcs.filter((npc) => npc.IsBoss());
 }
 

package/src/functions/collectibleTag.ts

@@ -3,7 +3,7 @@ import { itemConfig } from "../cachedClasses";
 import { getCollectibleArray } from "./collectibleSet";
 import { getEnumValues } from "./enums";
 import { getFlagName } from "./flag";
-import { getPlayerCollectibleCount } from "./player";
+import { getPlayerCollectibleCount } from "./players";
 import { copySet } from "./set";
 
 const TAG_TO_COLLECTIBLE_TYPES_MAP = new Map<

package/src/functions/collectibles.ts

@@ -27,10 +27,10 @@ import {
 } from "../maps/collectibleNameMap";
 import { SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES_SET } from "../sets/singleUseActiveCollectibleTypesSet";
 import { CollectibleIndex } from "../types/CollectibleIndex";
-import { getEntityID } from "./entity";
+import { getEntityID } from "./entities";
 import { isCollectible } from "./pickupVariants";
 import { getRoomListIndex } from "./roomData";
-import { clearSprite, spriteEquals } from "./sprite";
+import { clearSprite, spriteEquals } from "./sprites";
 import { irange } from "./utils";
 
 const COLLECTIBLE_SPRITE_LAYER = 1;

package/src/functions/{entity.ts → entities.ts}

@@ -13,10 +13,10 @@ import { isPrimitive } from "./types";
  * `Isaac.CountEntities` method to avoid having to specify a spawner and to handle ignoring charmed
  * enemies.
  *
- * @param entityType Default is -1. -1 matches every entity type.
- * @param variant Default is -1. -1 matches every variant.
- * @param subType Default is -1. -1 matches every sub-type.
- * @param ignoreFriendly Default is false.
+ * @param entityType Optional. Default is -1, which matches every entity type.
+ * @param variant Optional. Default is -1, which matches every variant.
+ * @param subType Optional. Default is -1, which matches every sub-type.
+ * @param ignoreFriendly Optional. Default is false.
  */
 export function countEntities(
   entityType: EntityType = -1,
@@ -43,10 +43,10 @@ export function countEntities(
  * Helper function to check if one or more of a specific kind of entity is present in the current
  * room. It uses the `countEntities` helper function to determine this.
  *
- * @param entityType Default is -1. -1 matches every entity type.
- * @param variant Default is -1. -1 matches every variant.
- * @param subType Default is -1. -1 matches every sub-type.
- * @param ignoreFriendly Default is false.
+ * @param entityType Optional. Default is -1, which matches every entity type.
+ * @param variant Optional. Default is -1, which matches every variant.
+ * @param subType Optional. Default is -1, which matches every sub-type.
+ * @param ignoreFriendly Optional. Default is false.
  */
 export function doesEntityExist(
   entityType: EntityType = -1,
@@ -99,28 +99,29 @@ export function getClosestEntityTo<T extends AnyEntity>(
  * For example:
  *
  * ```ts
- * // Make all of the entities in the room invisible
+ * // Make all of the entities in the room invisible.
  * for (const entity of getEntities()) {
  *   entity.Visible = false;
  * }
  * ```
  *
- * @param entityType Optional. If specified, will only return NPCs that match this entity type.
- * @param variant Optional. If specified, will only return NPCs that match this variant. Default is
- *                -1. -1 matches every variant.
- * @param subType Optional. If specified, will only return NPCs that match this sub-type. Default is
- *                -1. -1 matches every sub-type.
+ * @param entityType Optional. If specified, will only get the entities that match the type. Default
+ *                   is -1, which matches every type.
+ * @param variant Optional. If specified, will only get the entities that match the variant. Default
+ *                is -1, which matches every variant.
+ * @param subType Optional. If specified, will only get the entities that match the sub-type.
+ *                Default is -1, which matches every sub-type.
  * @param ignoreFriendly Optional. If set to true, it will exclude friendly NPCs from being
- *                       returned. Default is false. Will only be taken into account if
- *                       `matchingEntityType` is specified.
+ *                       returned. Default is false. Will only be taken into account if the
+ *                       `entityType` is specified.
  */
 export function getEntities(
-  entityType?: EntityType,
+  entityType: EntityType = -1,
   variant = -1,
   subType = -1,
   ignoreFriendly = false,
 ): Entity[] {
-  if (entityType === undefined) {
+  if ((entityType as int) === -1) {
     return Isaac.GetRoomEntities();
   }
 
@@ -317,8 +318,9 @@ export function parseEntityTypeVariantString(
  * Helper function to remove all of the matching entities in the room.
  *
  * @param entityType The entity type to match.
- * @param entityVariant Optional. The variant to match. Default is -1. -1 matches every variant.
- * @param entitySubType Optional. The sub-type to match. Default is -1. -1 matches every sub-type.
+ * @param entityVariant Optional. The variant to match. Default is -1, which matches every variant.
+ * @param entitySubType Optional. The sub-type to match. Default is -1, which matches every
+ *                      sub-type.
  * @param cap Optional. If specified, will only remove the given amount of collectibles.
  * @returns An array of the entities that were removed.
  */
@@ -353,7 +355,7 @@ export function removeEntities<T extends AnyEntity>(
 
     entitiesRemoved.push(entity);
     if (cap !== undefined && entitiesRemoved.length >= cap) {
-      return entitiesRemoved;
+      break;
     }
   }