isaacscript-common 1.2.270 → 1.2.273

package/dist/constants.d.ts

@@ -120,9 +120,9 @@ export declare const UI_HEART_WIDTH = 12;
  * This is a safer version of the `Vector.One` constant. (Other mods can mutate this vector, so it
  * is not safe to use.)
  */
-export declare const VectorOne: ReadonlyVector;
+export declare const VectorOne: Readonly<Vector>;
 /**
  * This is a safer version of the `Vector.Zero` constant. (Other mods can mutate this vector, so it
  * is not safe to use.)
  */
-export declare const VectorZero: ReadonlyVector;
+export declare const VectorZero: Readonly<Vector>;

package/dist/functions/boss.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="isaac-typescript-definitions" />
+import { EntityTypeNonNPC } from "../types/EntityTypeNonNPC";
 /**
  * Helper function to get all of the non-dead bosses in the room.
  *
@@ -37,3 +38,19 @@ export declare function getBosses(matchingEntityType?: EntityType | int, matchin
 export declare function getCombinedBossSet(stage: int): Set<string> | undefined;
 /** Helper function to check if the provided NPC is a Sin miniboss, such as Sloth or Lust. */
 export declare function isSin(npc: EntityNPC): boolean;
+/**
+ * Helper function to spawn a boss.
+ *
+ * Use this function instead of `spawnNPC` since it handles automatically spawning multiple segments
+ * for multi-segment bosses.
+ *
+ * By default, this will spawn Chub (and his variants) with 3 segments and other multi-segment
+ * bosses with 4 segments. You can customize this via the "numSegments" argument.
+ */
+export declare function spawnBoss<T extends number>(entityType: T extends EntityTypeNonNPC ? never : T, variant: int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined, numSegments?: int): EntityNPC;
+/**
+ * Helper function to spawn a boss with a specific seed.
+ *
+ * For more information, see the documentation for the `spawnBoss` function.
+ */
+export declare function spawnBossWithSeed(entityType: EntityType | int, variant: int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined, numSegments?: int): EntityNPC;

package/dist/functions/boss.lua

@@ -1,6 +1,10 @@
 local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
 local ____bossSets = require("sets.bossSets")
 local ALL_BOSSES_SET = ____bossSets.ALL_BOSSES_SET
 local STAGE_TO_COMBINED_BOSS_SET_MAP = ____bossSets.STAGE_TO_COMBINED_BOSS_SET_MAP
@@ -9,10 +13,14 @@ 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 ____set = require("functions.set")
 local copySet = ____set.copySet
+local ____utils = require("functions.utils")
+local ____repeat = ____utils["repeat"]
+local BOSSES_THAT_REQUIRE_MULTIPLE_SPAWNS = __TS__New(Set, {EntityType.ENTITY_LARRYJR, EntityType.ENTITY_CHUB, EntityType.ENTITY_TURDLET})
 function ____exports.getAliveBosses(self, matchingEntityType, matchingVariant, matchingSubType, ignoreFriendly)
     if ignoreFriendly == nil then
         ignoreFriendly = false
@@ -69,4 +77,66 @@ end
 function ____exports.isSin(self, npc)
     return SIN_ENTITY_TYPES_SET:has(npc.Type)
 end
+function ____exports.spawnBoss(self, entityType, variant, subType, position, velocity, spawner, seed, numSegments)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    if seed == nil then
+        seed = nil
+    end
+    local npc = spawnNPC(
+        nil,
+        entityType,
+        variant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+    if BOSSES_THAT_REQUIRE_MULTIPLE_SPAWNS:has(entityType) then
+        local numSegmentsDefined = numSegments == nil and 4 or numSegments
+        local numSegmentsToUse = entityType == EntityType.ENTITY_CHUB and 3 or numSegmentsDefined
+        local remainingSegmentsToSpawn = numSegmentsToUse - 1
+        ____repeat(
+            nil,
+            remainingSegmentsToSpawn,
+            function()
+                spawnNPC(
+                    nil,
+                    entityType,
+                    variant,
+                    subType,
+                    position,
+                    velocity,
+                    spawner,
+                    seed
+                )
+            end
+        )
+    end
+    return npc
+end
+function ____exports.spawnBossWithSeed(self, entityType, variant, subType, position, seed, velocity, spawner, numSegments)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnBoss(
+        nil,
+        entityType,
+        variant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed,
+        numSegments
+    )
+end
 return ____exports

package/dist/functions/entity.d.ts

@@ -67,6 +67,24 @@ export declare function isEntityMoving(entity: Entity, threshold?: number): bool
  * apply to non-story bosses, like Vanishing Twin. Also see the `STORY_BOSSES` constant.
  */
 export declare function isStoryBoss(entityType: EntityType | int): boolean;
+/**
+ * Helper function to parse a string that contains an entity type, a variant, and a sub-type,
+ * separated by periods.
+ *
+ * For example, passing "45.0.1" would return an array of [45, 0, 1].
+ *
+ * Returns undefined if the string cannot be parsed.
+ */
+export declare function parseEntityID(entityID: string): [entityType: EntityType | int, variant: int, subType: int] | undefined;
+/**
+ * Helper function to parse a string that contains an entity type and a variant separated by a
+ * period.
+ *
+ * For example, passing "45.0" would return an array of [45, 0].
+ *
+ * Returns undefined if the string cannot be parsed.
+ */
+export declare function parseEntityTypeVariantString(entityTypeVariantString: string): [entityType: EntityType | int, variant: int] | undefined;
 /**
  * Helper function to remove all of the matching entities in the room.
  *

package/dist/functions/entity.lua

@@ -2,6 +2,7 @@ local ____lualib = require("lualib_bundle")
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local __TS__StringSplit = ____lualib.__TS__StringSplit
 local ____exports = {}
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
@@ -107,6 +108,42 @@ end
 function ____exports.isStoryBoss(self, entityType)
     return STORY_BOSSES_SET:has(entityType)
 end
+function ____exports.parseEntityID(self, entityID)
+    local entityIDArray = __TS__StringSplit(entityID, ".")
+    if #entityIDArray ~= 3 then
+        return nil
+    end
+    local entityTypeString, variantString, subTypeString = table.unpack(entityIDArray)
+    local entityType = tonumber(entityTypeString)
+    if entityType == nil then
+        return nil
+    end
+    local variant = tonumber(variantString)
+    if variant == nil then
+        return nil
+    end
+    local subType = tonumber(subTypeString)
+    if subType == nil then
+        return nil
+    end
+    return {entityType, variant, subType}
+end
+function ____exports.parseEntityTypeVariantString(self, entityTypeVariantString)
+    local entityTypeVariantArray = __TS__StringSplit(entityTypeVariantString, ".")
+    if #entityTypeVariantArray ~= 2 then
+        return nil
+    end
+    local entityTypeString, variantString = table.unpack(entityTypeVariantArray)
+    local entityType = tonumber(entityTypeString)
+    if entityType == nil then
+        return nil
+    end
+    local variant = tonumber(variantString)
+    if variant == nil then
+        return nil
+    end
+    return {entityType, variant}
+end
 function ____exports.removeAllMatchingEntities(self, entityType, entityVariant, entitySubType, cap)
     if entityVariant == nil then
         entityVariant = -1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.270",
+  "version": "1.2.273",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -25,7 +25,7 @@
     "dist/**/*.d.ts"
   ],
   "devDependencies": {
-    "isaac-typescript-definitions": "^1.0.391",
+    "isaac-typescript-definitions": "^1.0.392",
     "isaacscript-lint": "^1.0.99",
     "isaacscript-tsconfig": "^1.1.8",
     "typedoc": "^0.22.15",