isaacscript-common 6.6.5 → 6.7.0

package/dist/functions/{boss.lua → bosses.lua}

@@ -15,11 +15,11 @@ local STAGE_TO_COMBINED_BOSS_SET_MAP = ____bossSets.STAGE_TO_COMBINED_BOSS_SET_M
 local STAGE_TO_STAGE_TYPE_TO_BOSS_SET_MAP = ____bossSets.STAGE_TO_STAGE_TYPE_TO_BOSS_SET_MAP
 local ____sinEntityTypesSet = require("sets.sinEntityTypesSet")
 local SIN_ENTITY_TYPES_SET = ____sinEntityTypesSet.SIN_ENTITY_TYPES_SET
-local ____entitySpecific = require("functions.entitySpecific")
-local getNPCs = ____entitySpecific.getNPCs
-local spawnNPC = ____entitySpecific.spawnNPC
-local ____npc = require("functions.npc")
-local getAliveNPCs = ____npc.getAliveNPCs
+local ____entitiesSpecific = require("functions.entitiesSpecific")
+local getNPCs = ____entitiesSpecific.getNPCs
+local spawnNPC = ____entitiesSpecific.spawnNPC
+local ____npcs = require("functions.npcs")
+local getAliveNPCs = ____npcs.getAliveNPCs
 local ____rng = require("functions.rng")
 local isRNG = ____rng.isRNG
 local ____set = require("functions.set")
@@ -69,15 +69,32 @@ DEFAULT_BOSS_MULTI_SEGMENTS = 4
 -- 
 -- This function will not include bosses on an internal blacklist, such as Death's scythes or Big
 -- Horn holes.
-function ____exports.getAliveBosses(self, matchingEntityType, matchingVariant, matchingSubType, ignoreFriendly)
+-- 
+-- @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.
+function ____exports.getAliveBosses(self, entityType, variant, subType, ignoreFriendly)
+    if entityType == nil then
+        entityType = -1
+    end
+    if variant == nil then
+        variant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
     if ignoreFriendly == nil then
         ignoreFriendly = false
     end
     local aliveNPCs = getAliveNPCs(
         nil,
-        matchingEntityType,
-        matchingVariant,
-        matchingSubType,
+        entityType,
+        variant,
+        subType,
         ignoreFriendly
     )
     return __TS__ArrayFilter(
@@ -111,15 +128,23 @@ function ____exports.getBossSet(self, stage, stageType)
     return copySet(nil, bossSet)
 end
 --- Helper function to get all of the bosses in the room.
-function ____exports.getBosses(self, matchingEntityType, matchingVariant, matchingSubType, ignoreFriendly)
+-- 
+-- @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.
+function ____exports.getBosses(self, entityType, variant, subType, ignoreFriendly)
     if ignoreFriendly == nil then
         ignoreFriendly = false
     end
     local npcs = getNPCs(
         nil,
-        matchingEntityType,
-        matchingVariant,
-        matchingSubType,
+        entityType,
+        variant,
+        subType,
         ignoreFriendly
     )
     return __TS__ArrayFilter(

package/dist/functions/collectibleTag.lua

@@ -14,8 +14,8 @@ local ____enums = require("functions.enums")
 local getEnumValues = ____enums.getEnumValues
 local ____flag = require("functions.flag")
 local getFlagName = ____flag.getFlagName
-local ____player = require("functions.player")
-local getPlayerCollectibleCount = ____player.getPlayerCollectibleCount
+local ____players = require("functions.players")
+local getPlayerCollectibleCount = ____players.getPlayerCollectibleCount
 local ____set = require("functions.set")
 local copySet = ____set.copySet
 function ____exports.collectibleHasTag(self, collectibleType, tag)

package/dist/functions/collectibles.lua

@@ -27,15 +27,15 @@ local COLLECTIBLE_NAME_MAP = ____collectibleNameMap.COLLECTIBLE_NAME_MAP
 local DEFAULT_COLLECTIBLE_NAME = ____collectibleNameMap.DEFAULT_COLLECTIBLE_NAME
 local ____singleUseActiveCollectibleTypesSet = require("sets.singleUseActiveCollectibleTypesSet")
 local SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES_SET = ____singleUseActiveCollectibleTypesSet.SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES_SET
-local ____entity = require("functions.entity")
-local getEntityID = ____entity.getEntityID
+local ____entities = require("functions.entities")
+local getEntityID = ____entities.getEntityID
 local ____pickupVariants = require("functions.pickupVariants")
 local isCollectible = ____pickupVariants.isCollectible
 local ____roomData = require("functions.roomData")
 local getRoomListIndex = ____roomData.getRoomListIndex
-local ____sprite = require("functions.sprite")
-local clearSprite = ____sprite.clearSprite
-local spriteEquals = ____sprite.spriteEquals
+local ____sprites = require("functions.sprites")
+local clearSprite = ____sprites.clearSprite
+local spriteEquals = ____sprites.spriteEquals
 local ____utils = require("functions.utils")
 local irange = ____utils.irange
 function initQuestionMarkSprite(self)

package/dist/functions/{entity.d.ts → entities.d.ts}

@@ -6,20 +6,20 @@ import { AnyEntity } from "../types/AnyEntity";
  * `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 declare function countEntities(entityType?: EntityType, variant?: number, subType?: number, ignoreFriendly?: boolean): int;
 /**
  * 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 declare function doesEntityExist(entityType?: EntityType, variant?: number, subType?: number, ignoreFriendly?: boolean): boolean;
 /**
@@ -46,20 +46,21 @@ export declare function getClosestEntityTo<T extends AnyEntity>(referenceEntity:
  * 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 declare function getEntities(entityType?: EntityType, variant?: number, subType?: number, ignoreFriendly?: boolean): Entity[];
 /**
@@ -117,8 +118,9 @@ export declare function parseEntityTypeVariantString(entityTypeVariantString: st
  * 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.
  */
@@ -153,4 +155,4 @@ export declare function spawn(entityType: EntityType, variant: int, subType: int
  * need to specify the velocity or spawner.
  */
 export declare function spawnWithSeed(entityType: EntityType, variant: int, subType: int, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): Entity;
-//# sourceMappingURL=entity.d.ts.map
+//# sourceMappingURL=entities.d.ts.map

package/dist/functions/entities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../src/functions/entities.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAI1D,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAM/C;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAC3B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,GAAG,CAcL;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,OAAO,CAGT;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,SAAS,EACpD,eAAe,EAAE,MAAM,EACvB,QAAQ,EAAE,CAAC,EAAE,GACZ,CAAC,GAAG,SAAS,CAaf;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,WAAW,CACzB,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,MAAM,EAAE,CAMV;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,GACb,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,CA8B7C;AAwBD,8FAA8F;AAC9F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAElD;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,GACX,MAAM,CAER;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,SAAS,EACxD,WAAW,EAAE,CAAC,EAAE,EAChB,WAAW,EAAE,CAAC,EAAE,GACf,CAAC,EAAE,CAWL;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,SAAO,GAAG,OAAO,CAExE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAE3D;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,MAAM,GACf,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,SAAS,CAwBlE;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAC1C,uBAAuB,EAAE,MAAM,GAC9B,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,SAAS,CAmBpD;AAED;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CACvC,UAAU,EAAE,UAAU,EACtB,aAAa,SAAK,EAClB,aAAa,SAAK,EAClB,GAAG,GAAE,GAAG,GAAG,SAAqB,GAC/B,MAAM,EAAE,CAGV;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,SAAS,EAChD,QAAQ,EAAE,CAAC,EAAE,EACb,GAAG,CAAC,EAAE,GAAG,GACR,CAAC,EAAE,CAgBL;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAgB9D;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CASzD;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CACnB,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,EAChB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,GAC5C,MAAM,CAsCR;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,IAAI,GAAG,GAAG,EACrB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,GACtC,MAAM,CAUR"}

package/dist/functions/{entity.lua → entities.lua}

@@ -47,7 +47,7 @@ function ____exports.removeEntities(self, entities, cap)
         entity:Remove()
         entitiesRemoved[#entitiesRemoved + 1] = entity
         if cap ~= nil and #entitiesRemoved >= cap then
-            return entitiesRemoved
+            break
         end
     end
     return entitiesRemoved
@@ -56,10 +56,10 @@ end
 -- `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.
 function ____exports.countEntities(self, entityType, variant, subType, ignoreFriendly)
     if entityType == nil then
         entityType = -1
@@ -88,10 +88,10 @@ end
 --- 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.
 function ____exports.doesEntityExist(self, entityType, variant, subType, ignoreFriendly)
     if entityType == nil then
         entityType = -1
@@ -146,21 +146,25 @@ end
 -- 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.
 function ____exports.getEntities(self, entityType, variant, subType, ignoreFriendly)
+    if entityType == nil then
+        entityType = -1
+    end
     if variant == nil then
         variant = -1
     end
@@ -170,7 +174,7 @@ function ____exports.getEntities(self, entityType, variant, subType, ignoreFrien
     if ignoreFriendly == nil then
         ignoreFriendly = false
     end
-    if entityType == nil then
+    if entityType == -1 then
         return Isaac.GetRoomEntities()
     end
     return Isaac.FindByType(entityType, variant, subType, ignoreFriendly)
@@ -290,8 +294,9 @@ end
 --- 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.
 function ____exports.removeAllMatchingEntities(self, entityType, entityVariant, entitySubType, cap)