isaacscript-common 21.9.0 → 23.0.0

package/dist/src/functions/players.lua

@@ -7,7 +7,6 @@ local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
 local ____exports = {}
-local isTaintedModded
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local ActiveSlot = ____isaac_2Dtypescript_2Ddefinitions.ActiveSlot
 local Challenge = ____isaac_2Dtypescript_2Ddefinitions.Challenge
@@ -60,16 +59,20 @@ end
 function ____exports.isModdedPlayer(self, player)
     return not ____exports.isVanillaPlayer(nil, player)
 end
-function isTaintedModded(self, player)
-    local character = player:GetPlayerType()
-    local name = player:GetName()
-    local taintedCharacter = Isaac.GetPlayerTypeByName(name, true)
-    return character == taintedCharacter
-end
 function ____exports.isVanillaPlayer(self, player)
     local character = player:GetPlayerType()
     return isVanillaCharacter(nil, character)
 end
+--- Helper function to add one or more collectibles to a player.
+-- 
+-- This function is variadic, meaning that you can supply as many collectible types as you want to
+-- add.
+function ____exports.addCollectible(self, player, ...)
+    local collectibleTypes = {...}
+    for ____, collectibleType in ipairs(collectibleTypes) do
+        player:AddCollectible(collectibleType)
+    end
+end
 function ____exports.addCollectibleCostume(self, player, collectibleType)
     local itemConfigItem = itemConfig:GetCollectible(collectibleType)
     if itemConfigItem == nil then
@@ -383,6 +386,28 @@ function ____exports.getTotalPlayerCollectibles(self, collectibleType)
     )
     return sumArray(nil, numCollectiblesArray)
 end
+--- Helper function to check to see if a player has one or more collectibles.
+-- 
+-- This function is variadic, meaning that you can supply as many collectible types as you want to
+-- check for. Returns true if the player has any of the supplied collectible types.
+function ____exports.hasCollectible(self, player, ...)
+    local collectibleTypes = {...}
+    return __TS__ArraySome(
+        collectibleTypes,
+        function(____, collectibleType) return player:HasCollectible(collectibleType) end
+    )
+end
+--- Helper function to check to see if a player has one or more transformations.
+-- 
+-- This function is variadic, meaning that you can supply as many transformations as you want to
+-- check for. Returns true if the player has any of the supplied transformations.
+function ____exports.hasForm(self, player, ...)
+    local playerForms = {...}
+    return __TS__ArraySome(
+        playerForms,
+        function(____, playerForm) return player:HasPlayerForm(playerForm) end
+    )
+end
 --- After touching a white fire, a player will turn into The Lost until they clear a room.
 function ____exports.hasLostCurse(self, player)
     local effects = player:GetEffects()
@@ -459,6 +484,12 @@ function ____exports.isLost(self, player)
     local character = player:GetPlayerType()
     return character == PlayerType.LOST or character == PlayerType.LOST_B
 end
+local function isTaintedModded(self, player)
+    local character = player:GetPlayerType()
+    local name = player:GetName()
+    local taintedCharacter = Isaac.GetPlayerTypeByName(name, true)
+    return character == taintedCharacter
+end
 --- Helper function for determining if a player is able to turn their head by pressing the shooting
 -- buttons.
 -- 
@@ -482,38 +513,6 @@ function ____exports.isTaintedLazarus(self, player)
     local character = player:GetPlayerType()
     return character == PlayerType.LAZARUS_B or character == PlayerType.LAZARUS_2_B
 end
---- Helper function to add one or more collectibles to a player.
--- 
--- This function is variadic, meaning that you can supply as many collectible types as you want to
--- add.
-function ____exports.playerAddCollectible(self, player, ...)
-    local collectibleTypes = {...}
-    for ____, collectibleType in ipairs(collectibleTypes) do
-        player:AddCollectible(collectibleType)
-    end
-end
---- Helper function to check to see if a player has one or more collectibles.
--- 
--- This function is variadic, meaning that you can supply as many collectible types as you want to
--- check for. Returns true if the player has any of the supplied collectible types.
-function ____exports.playerHasCollectible(self, player, ...)
-    local collectibleTypes = {...}
-    return __TS__ArraySome(
-        collectibleTypes,
-        function(____, collectibleType) return player:HasCollectible(collectibleType) end
-    )
-end
---- Helper function to check to see if a player has one or more transformations.
--- 
--- This function is variadic, meaning that you can supply as many transformations as you want to
--- check for. Returns true if the player has any of the supplied transformations.
-function ____exports.playerHasForm(self, player, ...)
-    local playerForms = {...}
-    return __TS__ArraySome(
-        playerForms,
-        function(____, playerForm) return player:HasPlayerForm(playerForm) end
-    )
-end
 --- Helper function to remove all of the active items from a player. This includes the Schoolbag item
 -- and any pocket actives.
 function ____exports.removeAllActiveItems(self, player)
@@ -523,13 +522,13 @@ function ____exports.removeAllActiveItems(self, player)
             if collectibleType == CollectibleType.NULL then
                 goto __continue93
             end
-            local hasCollectible
+            local stillHasCollectible
             repeat
                 do
                     player:RemoveCollectible(collectibleType)
-                    hasCollectible = player:HasCollectible(collectibleType)
+                    stillHasCollectible = player:HasCollectible(collectibleType)
                 end
-            until not hasCollectible
+            until not stillHasCollectible
         end
         ::__continue93::
     end
@@ -556,6 +555,16 @@ function ____exports.removeAllPlayerTrinkets(self, player)
         ::__continue98::
     end
 end
+--- Helper function to remove one or more collectibles to a player.
+-- 
+-- This function is variadic, meaning that you can supply as many collectible types as you want to
+-- remove.
+function ____exports.removeCollectible(self, player, ...)
+    local collectibleTypes = {...}
+    for ____, collectibleType in ipairs(collectibleTypes) do
+        player:RemoveCollectible(collectibleType)
+    end
+end
 --- Helper function to remove a collectible costume from a player. Use this helper function to avoid
 -- having to request the collectible from the item config.
 function ____exports.removeCollectibleCostume(self, player, collectibleType)
@@ -634,9 +643,9 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
         itemPool:RemoveCollectible(collectibleType)
     end
     repeat
-        local ____switch117 = activeSlot
-        local ____cond117 = ____switch117 == ActiveSlot.PRIMARY
-        if ____cond117 then
+        local ____switch120 = activeSlot
+        local ____cond120 = ____switch120 == ActiveSlot.PRIMARY
+        if ____cond120 then
             do
                 if primaryCollectibleType ~= CollectibleType.NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -645,8 +654,8 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond117 = ____cond117 or ____switch117 == ActiveSlot.SECONDARY
-        if ____cond117 then
+        ____cond120 = ____cond120 or ____switch120 == ActiveSlot.SECONDARY
+        if ____cond120 then
             do
                 if primaryCollectibleType ~= CollectibleType.NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -661,16 +670,16 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond117 = ____cond117 or ____switch117 == ActiveSlot.POCKET
-        if ____cond117 then
+        ____cond120 = ____cond120 or ____switch120 == ActiveSlot.POCKET
+        if ____cond120 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 player:SetActiveCharge(charge, activeSlot)
                 break
             end
         end
-        ____cond117 = ____cond117 or ____switch117 == ActiveSlot.POCKET_SINGLE_USE
-        if ____cond117 then
+        ____cond120 = ____cond120 or ____switch120 == ActiveSlot.POCKET_SINGLE_USE
+        if ____cond120 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 break

package/dist/src/functions/positionVelocity.d.ts

@@ -23,7 +23,7 @@ export declare function anyPlayerCloserThan(position: Vector, distance: float):
  * @param minimumDistance Optional. If specified, will ensure that the randomly generated position
  *                        is equal to or greater than the distance provided.
  */
-export declare function findFreePosition(startingPosition: Vector, avoidActiveEntities?: boolean, minimumDistance?: float): Vector;
+export declare function findFreePosition(startingPosition: Vector, avoidActiveEntities?: boolean, minimumDistance?: float): Readonly<Vector>;
 /**
  * Helper function to get a map containing the positions of every entity in the current room.
  *

package/dist/src/functions/positionVelocity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"positionVelocity.d.ts","sourceRoot":"","sources":["../../../src/functions/positionVelocity.ts"],"names":[],"mappings":";;;;AAaA,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,MAAM,EAAE,EAClB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,GAAG,GACZ,OAAO,CAIT;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,KAAK,GACd,OAAO,CAKT;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAC9B,gBAAgB,EAAE,MAAM,EACxB,mBAAmB,UAAQ,EAC3B,eAAe,CAAC,EAAE,KAAK,GACtB,MAAM,CA4CR;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAY5E;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAY7E;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAChC,eAAe,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,EACrC,QAAQ,CAAC,EAAE,MAAM,EAAE,GAClB,IAAI,CAYN;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CACjC,gBAAgB,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,EACtC,QAAQ,CAAC,EAAE,MAAM,EAAE,GAClB,IAAI,CAYN"}
+{"version":3,"file":"positionVelocity.d.ts","sourceRoot":"","sources":["../../../src/functions/positionVelocity.ts"],"names":[],"mappings":";;;;AAaA,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,MAAM,EAAE,EAClB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,GAAG,GACZ,OAAO,CAIT;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,KAAK,GACd,OAAO,CAKT;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAC9B,gBAAgB,EAAE,MAAM,EACxB,mBAAmB,UAAQ,EAC3B,eAAe,CAAC,EAAE,KAAK,GACtB,QAAQ,CAAC,MAAM,CAAC,CA4ClB;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAY5E;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAY7E;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAChC,eAAe,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,EACrC,QAAQ,CAAC,EAAE,MAAM,EAAE,GAClB,IAAI,CAYN;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CACjC,gBAAgB,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,EACtC,QAAQ,CAAC,EAAE,MAAM,EAAE,GAClB,IAAI,CAYN"}

package/dist/src/functions/roomGrid.d.ts

@@ -12,20 +12,20 @@ import { RoomShape } from "isaac-typescript-definitions";
  *
  * For example, the coordinates of (0, 0) are equal to `Vector(80, 160)`.
  */
-export declare function gridCoordinatesToWorldPosition(x: int, y: int): Vector;
+export declare function gridCoordinatesToWorldPosition(x: int, y: int): Readonly<Vector>;
 /**
  * Helper function to convert a grid index to a grid position.
  *
  * For example, in a 1x1 room, grid index 0 is equal to "Vector(-1, -1) and grid index 16 is equal
  * to "Vector(0, 0)".
  */
-export declare function gridIndexToGridPosition(gridIndex: int, roomShape: RoomShape): Vector;
+export declare function gridIndexToGridPosition(gridIndex: int, roomShape: RoomShape): Readonly<Vector>;
 /**
  * Helper function to convert a grid position `Vector` to a world position `Vector`.
  *
  * For example, the coordinates of (0, 0) are equal to `Vector(80, 160)`.
  */
-export declare function gridPositionToWorldPosition(gridPosition: Vector): Vector;
+export declare function gridPositionToWorldPosition(gridPosition: Vector): Readonly<Vector>;
 /**
  * Test if a grid position is actually in the given `RoomShape`.
  *
@@ -37,7 +37,7 @@ export declare function isValidGridPosition(gridPosition: Vector, roomShape: Roo
  *
  * In this context, the grid position of the top-left wall is "Vector(-1, -1)".
  */
-export declare function worldPositionToGridPosition(worldPos: Vector): Vector;
+export declare function worldPositionToGridPosition(worldPos: Vector): Readonly<Vector>;
 /**
  * Helper function to convert a world position `Vector` to a grid position `Vector`.
  *
@@ -45,5 +45,5 @@ export declare function worldPositionToGridPosition(worldPos: Vector): Vector;
  *
  * This is similar to the `worldPositionToGridPosition` function, but the values are not rounded.
  */
-export declare function worldPositionToGridPositionFast(worldPos: Vector): Vector;
+export declare function worldPositionToGridPositionFast(worldPos: Vector): Readonly<Vector>;
 //# sourceMappingURL=roomGrid.d.ts.map

package/dist/src/functions/roomGrid.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"roomGrid.d.ts","sourceRoot":"","sources":["../../../src/functions/roomGrid.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAUzD;;;;GAIG;AACH,wBAAgB,8BAA8B,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,GAAG,MAAM,CAGrE;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,SAAS,EAAE,GAAG,EACd,SAAS,EAAE,SAAS,GACnB,MAAM,CAMR;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAKxE;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,SAAS,GACnB,OAAO,CAIT;AA0BD;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAIpE;AAED;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAIxE"}
+{"version":3,"file":"roomGrid.d.ts","sourceRoot":"","sources":["../../../src/functions/roomGrid.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAUzD;;;;GAIG;AACH,wBAAgB,8BAA8B,CAC5C,CAAC,EAAE,GAAG,EACN,CAAC,EAAE,GAAG,GACL,QAAQ,CAAC,MAAM,CAAC,CAGlB;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,SAAS,EAAE,GAAG,EACd,SAAS,EAAE,SAAS,GACnB,QAAQ,CAAC,MAAM,CAAC,CAMlB;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CACzC,YAAY,EAAE,MAAM,GACnB,QAAQ,CAAC,MAAM,CAAC,CAKlB;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,SAAS,GACnB,OAAO,CAIT;AA0BD;;;;GAIG;AACH,wBAAgB,2BAA2B,CACzC,QAAQ,EAAE,MAAM,GACf,QAAQ,CAAC,MAAM,CAAC,CAIlB;AAED;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAC7C,QAAQ,EAAE,MAAM,GACf,QAAQ,CAAC,MAAM,CAAC,CAIlB"}

package/dist/src/functions/ui.d.ts

@@ -11,7 +11,7 @@
  * - If the user does not have a HUD offset configured, this function will return `Vector(0, 0)`.
  * - If the user has a HUD offset of 1.0 configured, this function will return `Vector(20, 12)`.
  */
-export declare function getHUDOffsetVector(): Vector;
+export declare function getHUDOffsetVector(): Readonly<Vector>;
 /**
  * Returns how many hearts are in the heart UI row. If the player has more than 6 hearts, this
  * function will return 6.
@@ -23,13 +23,13 @@ export declare function getHeartRowLength(player: EntityPlayer): int;
  * combination with the `getHUDOffsetVector` helper function.
  */
 export declare function getHeartsUIWidth(): int;
-export declare function getScreenBottomCenterPos(): Vector;
-export declare function getScreenBottomLeftPos(): Vector;
-export declare function getScreenBottomRightPos(): Vector;
-export declare function getScreenCenterPos(): Vector;
-export declare function getScreenTopCenterPos(): Vector;
-export declare function getScreenTopLeftPos(): Vector;
-export declare function getScreenTopRightPos(): Vector;
+export declare function getScreenBottomCenterPos(): Readonly<Vector>;
+export declare function getScreenBottomLeftPos(): Readonly<Vector>;
+export declare function getScreenBottomRightPos(): Readonly<Vector>;
+export declare function getScreenCenterPos(): Readonly<Vector>;
+export declare function getScreenTopCenterPos(): Readonly<Vector>;
+export declare function getScreenTopLeftPos(): Readonly<Vector>;
+export declare function getScreenTopRightPos(): Readonly<Vector>;
 /**
  * Get how many hearts are currently being shown on the hearts UI.
  *

package/dist/src/functions/ui.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ui.d.ts","sourceRoot":"","sources":["../../../src/functions/ui.ts"],"names":[],"mappings":";;;AAKA;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,IAAI,MAAM,CAmB3C;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,CAU3D;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,IAAI,GAAG,CAgCtC;AAED,wBAAgB,wBAAwB,IAAI,MAAM,CAGjD;AAED,wBAAgB,sBAAsB,IAAI,MAAM,CAG/C;AAED,wBAAgB,uBAAuB,IAAI,MAAM,CAKhD;AAED,wBAAgB,kBAAkB,IAAI,MAAM,CAG3C;AAED,wBAAgB,qBAAqB,IAAI,MAAM,CAG9C;AAED,wBAAgB,mBAAmB,IAAI,MAAM,CAE5C;AAED,wBAAgB,oBAAoB,IAAI,MAAM,CAG7C;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,CAa1D"}
+{"version":3,"file":"ui.d.ts","sourceRoot":"","sources":["../../../src/functions/ui.ts"],"names":[],"mappings":";;;AAKA;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,IAAI,QAAQ,CAAC,MAAM,CAAC,CAmBrD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,CAU3D;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,IAAI,GAAG,CAgCtC;AAED,wBAAgB,wBAAwB,IAAI,QAAQ,CAAC,MAAM,CAAC,CAG3D;AAED,wBAAgB,sBAAsB,IAAI,QAAQ,CAAC,MAAM,CAAC,CAGzD;AAED,wBAAgB,uBAAuB,IAAI,QAAQ,CAAC,MAAM,CAAC,CAK1D;AAED,wBAAgB,kBAAkB,IAAI,QAAQ,CAAC,MAAM,CAAC,CAGrD;AAED,wBAAgB,qBAAqB,IAAI,QAAQ,CAAC,MAAM,CAAC,CAGxD;AAED,wBAAgB,mBAAmB,IAAI,QAAQ,CAAC,MAAM,CAAC,CAEtD;AAED,wBAAgB,oBAAoB,IAAI,QAAQ,CAAC,MAAM,CAAC,CAGvD;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,CAa1D"}

package/dist/src/functions/vector.d.ts

@@ -33,7 +33,7 @@ export declare function doesVectorHaveLength(vector: Vector, threshold?: number)
  * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
  *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
  */
-export declare function getRandomVector(seedOrRNG?: Seed | RNG): Vector;
+export declare function getRandomVector(seedOrRNG?: Seed | RNG): Readonly<Vector>;
 /**
  * Used to determine is the given table is a serialized `Vector` object created by the `deepCopy`
  * function.

package/dist/src/functions/vector.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vector.d.ts","sourceRoot":"","sources":["../../../src/functions/vector.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,yBAAyB,EACzB,SAAS,EACV,MAAM,8BAA8B,CAAC;AAatC,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACvD,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;IACzC,QAAQ,CAAC,MAAM,EAAE,yBAAyB,CAAC,MAAM,CAAC;CACnD,CAAC;AAKF,0DAA0D;AAC1D,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAQjD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,CAqBlE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,MAAM,EACd,SAAS,SAAO,GACf,OAAO,CAET;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,MAAM,CAOR;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,gBAAgB,CAM5B;AAED,gFAAgF;AAChF,wBAAgB,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,MAAM,CAE1D;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAWhE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAEtE;AAED,sEAAsE;AACtE,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAG3D;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,UAAQ,GAAG,MAAM,CAIpE"}
+{"version":3,"file":"vector.d.ts","sourceRoot":"","sources":["../../../src/functions/vector.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,yBAAyB,EACzB,SAAS,EACV,MAAM,8BAA8B,CAAC;AAatC,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACvD,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;IACzC,QAAQ,CAAC,MAAM,EAAE,yBAAyB,CAAC,MAAM,CAAC;CACnD,CAAC;AAKF,0DAA0D;AAC1D,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAQjD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,CAqBlE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,MAAM,EACd,SAAS,SAAO,GACf,OAAO,CAET;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,QAAQ,CAAC,MAAM,CAAC,CAOlB;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,gBAAgB,CAM5B;AAED,gFAAgF;AAChF,wBAAgB,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,MAAM,CAE1D;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAWhE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAEtE;AAED,sEAAsE;AACtE,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAG3D;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,UAAQ,GAAG,MAAM,CAIpE"}

package/dist/src/objects/characterStartingCollectibles.d.ts

@@ -0,0 +1,46 @@
+import { CollectibleType } from "isaac-typescript-definitions";
+export declare const CHARACTER_STARTING_COLLECTIBLES: {
+    readonly [-1]: readonly [];
+    readonly 0: readonly [CollectibleType.D6];
+    readonly 1: readonly [CollectibleType.YUM_HEART];
+    readonly 2: readonly [CollectibleType.LUCKY_FOOT];
+    readonly 3: readonly [CollectibleType.BOOK_OF_BELIAL];
+    readonly 4: readonly [CollectibleType.POOP];
+    readonly 5: readonly [CollectibleType.DEAD_BIRD, CollectibleType.WHORE_OF_BABYLON, CollectibleType.RAZOR_BLADE];
+    readonly 6: readonly [CollectibleType.BLOODY_LUST];
+    readonly 7: readonly [];
+    readonly 8: readonly [CollectibleType.ANEMIC];
+    readonly 9: readonly [];
+    readonly 10: readonly [CollectibleType.ETERNAL_D6];
+    readonly 11: readonly [CollectibleType.ANEMIC];
+    readonly 12: readonly [];
+    readonly 13: readonly [CollectibleType.BOX_OF_FRIENDS, CollectibleType.CAMBION_CONCEPTION];
+    readonly 14: readonly [CollectibleType.WOODEN_NICKEL];
+    readonly 15: readonly [CollectibleType.VOID];
+    readonly 16: readonly [];
+    readonly 17: readonly [];
+    readonly 18: readonly [CollectibleType.BOOK_OF_VIRTUES];
+    readonly 19: readonly [];
+    readonly 20: readonly [];
+    readonly 21: readonly [];
+    readonly 22: readonly [CollectibleType.YUM_HEART];
+    readonly 23: readonly [CollectibleType.BAG_OF_CRAFTING];
+    readonly 24: readonly [CollectibleType.DARK_ARTS];
+    readonly 25: readonly [CollectibleType.HOLD];
+    readonly 26: readonly [CollectibleType.SUMPTORIUM];
+    readonly 27: readonly [];
+    readonly 28: readonly [];
+    readonly 29: readonly [CollectibleType.FLIP];
+    readonly 30: readonly [];
+    readonly 31: readonly [];
+    readonly 32: readonly [];
+    readonly 33: readonly [];
+    readonly 34: readonly [CollectibleType.ABYSS];
+    readonly 35: readonly [];
+    readonly 36: readonly [CollectibleType.LEMEGETON];
+    readonly 37: readonly [CollectibleType.ANIMA_SOLA];
+    readonly 38: readonly [CollectibleType.FLIP];
+    readonly 39: readonly [CollectibleType.ANIMA_SOLA];
+    readonly 40: readonly [];
+};
+//# sourceMappingURL=characterStartingCollectibles.d.ts.map

package/dist/src/objects/characterStartingCollectibles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"characterStartingCollectibles.d.ts","sourceRoot":"","sources":["../../../src/objects/characterStartingCollectibles.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAc,MAAM,8BAA8B,CAAC;AAE3E,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6IuB,CAAC"}

package/dist/src/objects/characterStartingCollectibles.lua

@@ -0,0 +1,49 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+____exports.CHARACTER_STARTING_COLLECTIBLES = {
+    [PlayerType.POSSESSOR] = {},
+    [PlayerType.ISAAC] = {CollectibleType.D6},
+    [PlayerType.MAGDALENE] = {CollectibleType.YUM_HEART},
+    [PlayerType.CAIN] = {CollectibleType.LUCKY_FOOT},
+    [PlayerType.JUDAS] = {CollectibleType.BOOK_OF_BELIAL},
+    [PlayerType.BLUE_BABY] = {CollectibleType.POOP},
+    [PlayerType.EVE] = {CollectibleType.DEAD_BIRD, CollectibleType.WHORE_OF_BABYLON, CollectibleType.RAZOR_BLADE},
+    [PlayerType.SAMSON] = {CollectibleType.BLOODY_LUST},
+    [PlayerType.AZAZEL] = {},
+    [PlayerType.LAZARUS] = {CollectibleType.ANEMIC},
+    [PlayerType.EDEN] = {},
+    [PlayerType.LOST] = {CollectibleType.ETERNAL_D6},
+    [PlayerType.LAZARUS_2] = {CollectibleType.ANEMIC},
+    [PlayerType.DARK_JUDAS] = {},
+    [PlayerType.LILITH] = {CollectibleType.BOX_OF_FRIENDS, CollectibleType.CAMBION_CONCEPTION},
+    [PlayerType.KEEPER] = {CollectibleType.WOODEN_NICKEL},
+    [PlayerType.APOLLYON] = {CollectibleType.VOID},
+    [PlayerType.FORGOTTEN] = {},
+    [PlayerType.SOUL] = {},
+    [PlayerType.BETHANY] = {CollectibleType.BOOK_OF_VIRTUES},
+    [PlayerType.JACOB] = {},
+    [PlayerType.ESAU] = {},
+    [PlayerType.ISAAC_B] = {},
+    [PlayerType.MAGDALENE_B] = {CollectibleType.YUM_HEART},
+    [PlayerType.CAIN_B] = {CollectibleType.BAG_OF_CRAFTING},
+    [PlayerType.JUDAS_B] = {CollectibleType.DARK_ARTS},
+    [PlayerType.BLUE_BABY_B] = {CollectibleType.HOLD},
+    [PlayerType.EVE_B] = {CollectibleType.SUMPTORIUM},
+    [PlayerType.SAMSON_B] = {},
+    [PlayerType.AZAZEL_B] = {},
+    [PlayerType.LAZARUS_B] = {CollectibleType.FLIP},
+    [PlayerType.EDEN_B] = {},
+    [PlayerType.LOST_B] = {},
+    [PlayerType.LILITH_B] = {},
+    [PlayerType.KEEPER_B] = {},
+    [PlayerType.APOLLYON_B] = {CollectibleType.ABYSS},
+    [PlayerType.FORGOTTEN_B] = {},
+    [PlayerType.BETHANY_B] = {CollectibleType.LEMEGETON},
+    [PlayerType.JACOB_B] = {CollectibleType.ANIMA_SOLA},
+    [PlayerType.LAZARUS_2_B] = {CollectibleType.FLIP},
+    [PlayerType.JACOB_2_B] = {CollectibleType.ANIMA_SOLA},
+    [PlayerType.SOUL_B] = {}
+}
+return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "21.9.0",
+  "version": "23.0.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/functions/characters.ts

@@ -1,7 +1,8 @@
-import { PlayerType } from "isaac-typescript-definitions";
+import { CollectibleType, PlayerType } from "isaac-typescript-definitions";
 import { LAST_VANILLA_CHARACTER } from "../core/constantsFirstLast";
 import { CHARACTER_DAMAGE_MULTIPLIERS } from "../objects/characterDamageMultipliers";
 import { CHARACTER_NAMES } from "../objects/characterNames";
+import { CHARACTER_STARTING_COLLECTIBLES } from "../objects/characterStartingCollectibles";
 import { CHARACTERS_THAT_START_WITH_AN_ACTIVE_ITEM_SET } from "../sets/charactersThatStartWithAnActiveItemSet";
 import { CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART_SET } from "../sets/charactersWithBlackHeartFromEternalHeartSet";
 import { CHARACTERS_WITH_FREE_DEVIL_DEALS_SET } from "../sets/charactersWithFreeDevilDealsSet";
@@ -134,6 +135,18 @@ export function getCharacterName(character: PlayerType): string {
   return CHARACTER_NAMES[character];
 }
 
+/**
+ * Helper function to get the collectibles that are granted to a particular character at the
+ * beginning of a run.
+ *
+ * Note that this will return an empty array for Eden and Tainted Eden.
+ */
+export function getCharacterStartingItems(
+  character: PlayerType,
+): readonly CollectibleType[] {
+  return CHARACTER_STARTING_COLLECTIBLES[character];
+}
+
 export function isFlyingCharacter(player: EntityPlayer): boolean {
   const character = player.GetPlayerType();
   return FLYING_CHARACTERS.has(character);

package/src/functions/color.ts

@@ -87,7 +87,7 @@ export function deserializeColor(color: SerializedColor): Color {
 export function getRandomColor(
   seedOrRNG: Seed | RNG = getRandomSeed(),
   alpha = 1,
-): Color {
+): Readonly<Color> {
   const rng = isRNG(seedOrRNG) ? seedOrRNG : newRNG(seedOrRNG);
 
   const r = getRandom(rng);

package/src/functions/hex.ts

@@ -8,7 +8,7 @@ const HEX_STRING_LENGTH = 6;
  * @param hexString A hex string like "#ffffff" or "ffffff". (The "#" character is optional.)
  * @param alpha Optional. Range is from 0 to 1. Default is 1. (The same as the `Color` constructor.)
  */
-export function hexToColor(hexString: string, alpha = 1.0): Color {
+export function hexToColor(hexString: string, alpha = 1.0): Readonly<Color> {
   const [r, g, b] = hexToRGB(hexString);
 
   // Color values should be between 0 and 1.
@@ -22,7 +22,7 @@ export function hexToColor(hexString: string, alpha = 1.0): Color {
  * @param hexString A hex string like "#ffffff" or "ffffff". (The "#" character is optional.)
  * @param alpha Range is from 0 to 1. Default is 1.
  */
-export function hexToKColor(hexString: string, alpha = 1.0): KColor {
+export function hexToKColor(hexString: string, alpha = 1.0): Readonly<KColor> {
   const [r, g, b] = hexToRGB(hexString);
 
   // KColor values should be between 0 and 1.

package/src/functions/isaacAPIClass.ts

@@ -57,7 +57,7 @@ export function isEntity(variable: unknown): variable is Entity {
   return getIsaacAPIClassName(variable) === "Entity";
 }
 
-/** Helper function to detect if a variable is of type `EntityEffect`. */
+/** Helper function to detect if a variable is of type `EntityFamiliar`. */
 export function isFamiliar(variable: unknown): variable is EntityFamiliar {
   return getIsaacAPIClassName(variable) === "EntityEffect";
 }

package/src/functions/kColor.ts

@@ -76,7 +76,7 @@ export function deserializeKColor(kColor: SerializedKColor): KColor {
 export function getRandomKColor(
   seedOrRNG: Seed | RNG = getRandomSeed(),
   alpha = 1,
-): KColor {
+): Readonly<KColor> {
   const rng = isRNG(seedOrRNG) ? seedOrRNG : newRNG(seedOrRNG);
 
   const r = getRandom(rng);

package/src/functions/log.ts

@@ -1,3 +1,5 @@
+import { isNumber } from "./types";
+
 /**
  * Helper function to get the name and the line number of the current calling function.
  *
@@ -53,9 +55,13 @@ export function getParentFunctionDescription(
  */
 export function log(
   this: void,
-  msg: string,
+  msg: string | number,
   includeParentFunction = true,
 ): void {
+  if (isNumber(msg)) {
+    msg = msg.toString();
+  }
+
   const parentFunctionDescription = includeParentFunction
     ? getParentFunctionDescription()
     : undefined;