isaacscript-common 1.2.174 → 1.2.175

package/dist/functions/trinketGive.lua

@@ -6,6 +6,33 @@ local ____player = require("functions.player")
 local useActiveItemTemp = ____player.useActiveItemTemp
 local ____utils = require("functions.utils")
 local ____repeat = ____utils["repeat"]
+function ____exports.giveTrinketsBack(self, player, trinketSituation)
+    if trinketSituation == nil then
+        return
+    end
+    local trinket1 = player:GetTrinket(0)
+    local trinket2 = player:GetTrinket(1)
+    if trinket1 ~= TrinketType.TRINKET_NULL then
+        player:TryRemoveTrinket(trinket1)
+    end
+    if trinket2 ~= TrinketType.TRINKET_NULL then
+        player:TryRemoveTrinket(trinket2)
+    end
+    ____repeat(
+        nil,
+        trinketSituation.numSmeltedTrinkets,
+        function()
+            player:AddTrinket(trinketSituation.trinketTypeRemoved, false)
+            useActiveItemTemp(nil, player, CollectibleType.COLLECTIBLE_SMELTER)
+        end
+    )
+    if trinketSituation.trinket1 ~= TrinketType.TRINKET_NULL then
+        player:AddTrinket(trinketSituation.trinket1, false)
+    end
+    if trinketSituation.trinket2 ~= TrinketType.TRINKET_NULL then
+        player:AddTrinket(trinketSituation.trinket2, false)
+    end
+end
 function ____exports.temporarilyRemoveTrinket(self, player, trinketType)
     if not player:HasTrinket(trinketType) then
         return nil
@@ -42,31 +69,4 @@ function ____exports.temporarilyRemoveTrinkets(self, player)
     end
     return {trinketTypeRemoved = TrinketType.TRINKET_NULL, trinket1 = trinket1, trinket2 = trinket2, numSmeltedTrinkets = 0}
 end
-function ____exports.giveTrinketsBack(self, player, trinketSituation)
-    if trinketSituation == nil then
-        return
-    end
-    local trinket1 = player:GetTrinket(0)
-    local trinket2 = player:GetTrinket(1)
-    if trinket1 ~= TrinketType.TRINKET_NULL then
-        player:TryRemoveTrinket(trinket1)
-    end
-    if trinket2 ~= TrinketType.TRINKET_NULL then
-        player:TryRemoveTrinket(trinket2)
-    end
-    ____repeat(
-        nil,
-        trinketSituation.numSmeltedTrinkets,
-        function()
-            player:AddTrinket(trinketSituation.trinketTypeRemoved, false)
-            useActiveItemTemp(nil, player, CollectibleType.COLLECTIBLE_SMELTER)
-        end
-    )
-    if trinketSituation.trinket1 ~= TrinketType.TRINKET_NULL then
-        player:AddTrinket(trinketSituation.trinket1, false)
-    end
-    if trinketSituation.trinket2 ~= TrinketType.TRINKET_NULL then
-        player:AddTrinket(trinketSituation.trinket2, false)
-    end
-end
 return ____exports

package/dist/functions/trinkets.d.ts

@@ -18,8 +18,6 @@ export declare function getMaxTrinketType(): int;
  * ```
  */
 export declare function getOpenTrinketSlot(player: EntityPlayer): int | undefined;
-/** Helper function to get all of the trinket entities in the room. */
-export declare function getTrinkets(matchingSubType?: number): EntityPickup[];
 /**
  * Helper function to get the in-game description for a trinket. Returns "Unknown" if the provided
  * trinket type was not valid.
@@ -36,6 +34,8 @@ export declare function getTrinketDescription(trinketType: TrinketType | int): s
  * ```
  */
 export declare function getTrinketName(trinketType: TrinketType | int): string;
+/** Helper function to get all of the trinket entities in the room. */
+export declare function getTrinkets(matchingSubType?: number): EntityPickup[];
 /**
  * Returns whether or not the player can hold an additional trinket, beyond what they are currently
  * carrying. This takes into account items that modify the max number of trinkets, like Mom's Purse.

package/dist/functions/trinkets.lua

@@ -42,12 +42,6 @@ function ____exports.getOpenTrinketSlot(self, player)
     end
     return error("The player has an unknown number of trinket slots: " .. tostring(maxTrinkets))
 end
-function ____exports.getTrinkets(self, matchingSubType)
-    if matchingSubType == nil then
-        matchingSubType = -1
-    end
-    return getPickups(nil, PickupVariant.PICKUP_TRINKET, matchingSubType)
-end
 function ____exports.getTrinketDescription(self, trinketType)
     local trinketDescription = TRINKET_DESCRIPTION_MAP:get(trinketType)
     if trinketDescription ~= nil then
@@ -70,6 +64,12 @@ function ____exports.getTrinketName(self, trinketType)
     end
     return DEFAULT_TRINKET_NAME
 end
+function ____exports.getTrinkets(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, PickupVariant.PICKUP_TRINKET, matchingSubType)
+end
 function ____exports.hasOpenTrinketSlot(self, player)
     local character = player:GetPlayerType()
     if character == PlayerType.PLAYER_THESOUL_B then

package/dist/functions/ui.d.ts

@@ -1,15 +1,4 @@
 /// <reference types="isaac-typescript-definitions" />
-/**
- * Helper function to get the width of the first player's hearts on the UI. This is useful for
- * drawing UI elements to the right of where the player's hearts are. Make sure to use this in
- * combination with the the `getHUDOffsetVector` helper function.
- */
-export declare function getHeartsUIWidth(): int;
-/**
- * Returns how many hearts are in the heart UI row. If the player has more than 6 hearts, this
- * function will return 6.
- */
-export declare function getHeartRowLength(player: EntityPlayer): int;
 /**
  * In the options menu, players have the ability to set a HUD offset. However, mods do not have
  * access to this value. To get around this, Mod Config Menu provides a separate HUD offset setting
@@ -21,11 +10,22 @@ export declare function getHeartRowLength(player: EntityPlayer): int;
  * a HUD offset that should be added to the position of a UI element.
  */
 export declare function getHUDOffsetVector(): Vector;
-export declare function getScreenTopLeftPos(): Vector;
-export declare function getScreenTopRightPos(): Vector;
+/**
+ * Returns how many hearts are in the heart UI row. If the player has more than 6 hearts, this
+ * function will return 6.
+ */
+export declare function getHeartRowLength(player: EntityPlayer): int;
+/**
+ * Helper function to get the width of the first player's hearts on the UI. This is useful for
+ * drawing UI elements to the right of where the player's hearts are. Make sure to use this in
+ * combination with the the `getHUDOffsetVector` helper function.
+ */
+export declare function getHeartsUIWidth(): int;
 export declare function getScreenBottomLeftPos(): Vector;
 export declare function getScreenBottomRightPos(): Vector;
 export declare function getScreenCenterPos(): Vector;
+export declare function getScreenTopLeftPos(): Vector;
+export declare function getScreenTopRightPos(): Vector;
 /**
  * Get how many hearts are currently being shown on the hearts UI.
  *

package/dist/functions/ui.lua

@@ -4,6 +4,27 @@ local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local ____constants = require("constants")
 local UI_HEART_WIDTH = ____constants.UI_HEART_WIDTH
+function ____exports.getScreenBottomRightPos(self)
+    local screenWidth = Isaac.GetScreenWidth()
+    local screenHeight = Isaac.GetScreenHeight()
+    return Vector(screenWidth, screenHeight)
+end
+function ____exports.getHUDOffsetVector(self)
+    local defaultVector = Vector.Zero
+    local hudOffset = math.floor(Options.HUDOffset * 10)
+    if hudOffset < 1 or hudOffset > 10 then
+        return defaultVector
+    end
+    local x = hudOffset * 2
+    local y = hudOffset
+    if y >= 4 then
+        y = y + 1
+    end
+    if y >= 9 then
+        y = y + 1
+    end
+    return Vector(x, y)
+end
 function ____exports.getHeartRowLength(self, player)
     local maxHearts = player:GetMaxHearts()
     local soulHearts = player:GetSoulHearts()
@@ -12,11 +33,6 @@ function ____exports.getHeartRowLength(self, player)
     local heartRowLength = combinedHearts / 2
     return math.min(heartRowLength, 6)
 end
-function ____exports.getScreenBottomRightPos(self)
-    local screenWidth = Isaac.GetScreenWidth()
-    local screenHeight = Isaac.GetScreenHeight()
-    return Vector(screenWidth, screenHeight)
-end
 function ____exports.getHeartsUIWidth(self)
     local level = game:GetLevel()
     local curses = level:GetCurses()
@@ -45,29 +61,6 @@ function ____exports.getHeartsUIWidth(self)
     end
     return width
 end
-function ____exports.getHUDOffsetVector(self)
-    local defaultVector = Vector.Zero
-    local hudOffset = math.floor(Options.HUDOffset * 10)
-    if hudOffset < 1 or hudOffset > 10 then
-        return defaultVector
-    end
-    local x = hudOffset * 2
-    local y = hudOffset
-    if y >= 4 then
-        y = y + 1
-    end
-    if y >= 9 then
-        y = y + 1
-    end
-    return Vector(x, y)
-end
-function ____exports.getScreenTopLeftPos(self)
-    return Vector.Zero
-end
-function ____exports.getScreenTopRightPos(self)
-    local bottomRight = ____exports.getScreenBottomRightPos(nil)
-    return Vector(bottomRight.X, 0)
-end
 function ____exports.getScreenBottomLeftPos(self)
     local bottomRight = ____exports.getScreenBottomRightPos(nil)
     return Vector(0, bottomRight.Y)
@@ -76,6 +69,13 @@ function ____exports.getScreenCenterPos(self)
     local bottomRight = ____exports.getScreenBottomRightPos(nil)
     return bottomRight / 2
 end
+function ____exports.getScreenTopLeftPos(self)
+    return Vector.Zero
+end
+function ____exports.getScreenTopRightPos(self)
+    local bottomRight = ____exports.getScreenBottomRightPos(nil)
+    return Vector(bottomRight.X, 0)
+end
 function ____exports.getVisibleHearts(self, player)
     local effectiveMaxHearts = player:GetEffectiveMaxHearts()
     local soulHearts = player:GetSoulHearts()

package/dist/functions/utils.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="typescript-to-lua/language-extensions" />
 /// <reference types="isaac-typescript-definitions" />
 /**
  * Helper function to get type safety on a switch statement.
@@ -53,6 +54,11 @@ export declare const ensureAllCases: (obj: never) => never;
  * `pairs` or `Object.values`.
  */
 export declare function getEnumValues<T>(transpiledEnum: T): Array<T[keyof T]>;
+/**
+ * Helper function to log what is happening in functions that recursively move through nested data
+ * structures.
+ */
+export declare function getTraversalDescription(key: AnyNotNil, traversalDescription: string): string;
 /**
  * Converts a hex string like "#33aa33" to a KColor object.
  *

package/dist/functions/utils.lua

@@ -17,6 +17,13 @@ function ____exports.getEnumValues(self, transpiledEnum)
     __TS__ArraySort(enumValues)
     return enumValues
 end
+function ____exports.getTraversalDescription(self, key, traversalDescription)
+    if traversalDescription ~= "" then
+        traversalDescription = traversalDescription .. " --> "
+    end
+    traversalDescription = traversalDescription .. tostring(key)
+    return traversalDescription
+end
 function ____exports.hexToKColor(self, hexString, alpha)
     hexString = __TS__StringReplace(hexString, "#", "")
     if #hexString ~= HEX_STRING_LENGTH then

package/dist/functions/vector.d.ts

@@ -1,5 +1,7 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="typescript-to-lua/language-extensions" />
 export declare function copyVector(vector: Vector): Vector;
+export declare function deserializeVector(vectorTable: LuaTable): Vector;
 export declare function directionToVector(direction: Direction): Vector;
 /**
  * Helper function to get a new vector of length 1. Using this is safer than using the `Vector.One`

package/dist/functions/vector.lua

@@ -5,6 +5,19 @@ local DIRECTION_TO_VECTOR = ____directionToVector.DIRECTION_TO_VECTOR
 function ____exports.copyVector(self, vector)
     return Vector(vector.X, vector.Y)
 end
+function ____exports.deserializeVector(self, vectorTable)
+    local xString = vectorTable.X
+    local x = tonumber(xString)
+    if x == nil then
+        error("Failed to read the X value of a serialized vector.")
+    end
+    local yString = vectorTable.Y
+    local y = tonumber(yString)
+    if y == nil then
+        error("Failed to read the Y value of a serialized vector.")
+    end
+    return Vector(x, y)
+end
 function ____exports.directionToVector(self, direction)
     return DIRECTION_TO_VECTOR[direction]
 end

package/dist/index.d.ts

@@ -64,6 +64,7 @@ export * from "./functions/pocketItems";
 export * from "./functions/positionVelocity";
 export * from "./functions/random";
 export * from "./functions/revive";
+export * from "./functions/roomData";
 export * from "./functions/rooms";
 export * from "./functions/run";
 export * from "./functions/seeds";
@@ -90,6 +91,7 @@ export * from "./maps/roomTypeMap";
 export * from "./objects/directionNames";
 export * from "./types/AddCallbackParametersCustom";
 export * from "./types/AnyEntity";
+export * from "./types/CollectibleIndex";
 export * from "./types/JSONDoor";
 export * from "./types/JSONEntity";
 export * from "./types/JSONRoom";

package/dist/index.lua

@@ -514,6 +514,14 @@ do
         end
     end
 end
+do
+    local ____export = require("functions.roomData")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("functions.rooms")
     for ____exportKey, ____exportValue in pairs(____export) do

package/dist/maps/roomShapeToTopLeftWallGridIndexMap.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="isaac-typescript-definitions" />
+export declare const DEFAULT_TOP_LEFT_WALL_GRID_INDEX = 0;
 /**
  * Only used for special room shapes where the top left wall grid index is not equal to
  * `DEFAULT_TOP_LEFT_WALL_GRID_INDEX`.
  */
 export declare const ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP: ReadonlyMap<RoomShape, int>;
-export declare const DEFAULT_TOP_LEFT_WALL_GRID_INDEX = 0;

package/dist/maps/roomShapeToTopLeftWallGridIndexMap.lua

@@ -3,6 +3,7 @@ local ____lualib = require("lualib_bundle")
 local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
+____exports.DEFAULT_TOP_LEFT_WALL_GRID_INDEX = 0
 ____exports.ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP = __TS__New(Map, {
     {RoomShape.ROOMSHAPE_IH, 30},
     {RoomShape.ROOMSHAPE_IV, 4},
@@ -10,5 +11,4 @@ ____exports.ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP = __TS__New(Map, {
     {RoomShape.ROOMSHAPE_IIH, 56},
     {RoomShape.ROOMSHAPE_LTL, 13}
 })
-____exports.DEFAULT_TOP_LEFT_WALL_GRID_INDEX = 0
 return ____exports

package/dist/types/CollectibleIndex.d.ts

@@ -0,0 +1,15 @@
+/**
+ * CollectibleIndex is a specific type of string; see the documentation for the
+ * [[`getCollectibleIndex`]] function. Mods can signify that data structures handle collectibles by
+ * using this type.
+ *
+ * Example:
+ * ```
+ * const collectiblesNameMap = new Map<CollectibleIndex, string>();
+ * ```
+ *
+ * This type is branded for extra type safety.
+ */
+export declare type CollectibleIndex = string & {
+    __collectibleIndexBrand: unknown;
+};

package/dist/types/CollectibleIndex.lua

@@ -0,0 +1,3 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+return ____exports

package/dist/upgradeMod.lua

@@ -77,6 +77,8 @@ local ____roomClearChange = require("callbacks.roomClearChange")
 local roomClearChangeCallbackInit = ____roomClearChange.roomClearChangeCallbackInit
 local ____ModUpgraded = require("classes.ModUpgraded")
 local ModUpgraded = ____ModUpgraded.ModUpgraded
+local ____collectiblesSeen = require("features.collectiblesSeen")
+local collectiblesSeenInit = ____collectiblesSeen.collectiblesSeenInit
 local ____deployJSONRoom = require("features.deployJSONRoom")
 local deployJSONRoomInit = ____deployJSONRoom.deployJSONRoomInit
 local ____disableInputs = require("features.disableInputs")
@@ -155,6 +157,7 @@ function initFeatures(self, mod)
     isPonyActiveInit(nil, mod)
     playerInventoryInit(nil, mod)
     taintedLazarusPlayersInit(nil, mod)
+    collectiblesSeenInit(nil, mod)
 end
 function ____exports.upgradeMod(self, modVanilla, verbose)
     if verbose == nil then

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.174",
+  "version": "1.2.175",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -26,7 +26,7 @@
   ],
   "devDependencies": {
     "isaac-typescript-definitions": "^1.0.371",
-    "isaacscript-lint": "^1.0.91",
+    "isaacscript-lint": "^1.0.93",
     "isaacscript-tsconfig": "^1.1.8",
     "typedoc": "^0.22.13",
     "typescript": "4.6.2",