isaacscript-common 1.2.7 → 1.2.11

package/dist/features/saveDataManager/exports.d.ts

@@ -50,12 +50,17 @@ import { SaveData } from "../../types/SaveData";
  * }
  * ```
  *
- * - Save data is loaded from disk in the MC_POST_PLAYER_INIT callback
- * (i.e. the first callback that can possibly run).
+ * - Save data is loaded from disk in the MC_POST_PLAYER_INIT callback (i.e. the first callback that
+ * can possibly run).
  * - Save data is recorded to disk in the MC_PRE_GAME_EXIT callback.
  *
  * Note that before using the save data manager, you must call the [[`upgradeMod`]] function.
  *
+ * If you want the save data manager to load data before the MC_POST_PLAYER_INIT callback (i.e. in
+ * the main menu), then you should explicitly call the [[`saveDataManagerLoad`]] function. (The save
+ * data manager cannot do this on its own because it cannot know when your mod features are finished
+ * initializing.)
+ *
  * Finally, some features may have variables that need to be automatically reset per run/level, but
  * not saved to disk on game exit. (For example, if they contain functions or other non-serializable
  * data.) For these cases, set a special key of "dontSave" alongside "run", "level", and so forth.
@@ -65,8 +70,8 @@ import { SaveData } from "../../types/SaveData";
  * @param saveData An object that corresponds to the `SaveData` interface. The object is
  * conventionally called "v" for brevity (which is short for "local variables").
  * @param conditionalFunc An optional function to run upon saving this key to disk. If the function
- * is false, the key will not be written to disk. This allows mod features to avoid cluttering the
- * "save#.dat" file with unnecessary keys.
+ * returns false, the key will not be written to disk. This allows mod features to avoid cluttering
+ * the "save#.dat" file with unnecessary keys.
  */
 export declare function saveDataManager(key: string, saveData: SaveData, conditionalFunc?: () => boolean): void;
 /**
@@ -75,6 +80,14 @@ export declare function saveDataManager(key: string, saveData: SaveData, conditi
  * of its variables to disk immediately.
  */
 export declare function saveDataManagerSave(): void;
+/**
+ * The save data manager will automatically load variables from disk at the appropriate times (i.e.
+ * when a new run is started). Use this function to explicitly force the save data manager to load
+ * all of its variables from disk immediately.
+ *
+ * Note that doing this will overwrite current data, which can potentially result in lost state.
+ */
+export declare function saveDataManagerLoad(): void;
 /**
  * Sets the global variable of "g" equal to all of the save data variables for this mod.
  * Sets the global variable of "gd" equal to all of the save data default variables for this mod.

package/dist/features/saveDataManager/exports.lua

@@ -10,6 +10,7 @@ local deepCopy = ____deepCopy.deepCopy
 local SerializationType = ____deepCopy.SerializationType
 local ____main = require("features.saveDataManager.main")
 local FEATURE_NAME = ____main.FEATURE_NAME
+local forceSaveDataManagerLoad = ____main.forceSaveDataManagerLoad
 local forceSaveDataManagerSave = ____main.forceSaveDataManagerSave
 local isSaveDataManagerInitialized = ____main.isSaveDataManagerInitialized
 local ____maps = require("features.saveDataManager.maps")
@@ -48,6 +49,13 @@ function ____exports.saveDataManagerSave(self)
     end
     forceSaveDataManagerSave(nil)
 end
+function ____exports.saveDataManagerLoad(self)
+    if not isSaveDataManagerInitialized(nil) then
+        local msg = getUpgradeErrorMsg(nil, FEATURE_NAME)
+        error(msg)
+    end
+    forceSaveDataManagerLoad(nil)
+end
 function ____exports.saveDataManagerSetGlobal(self)
     g = saveDataMap
     gd = saveDataDefaultsMap

package/dist/features/saveDataManager/main.lua

@@ -109,4 +109,10 @@ function ____exports.forceSaveDataManagerSave(self)
     end
     saveToDisk(nil, mod, saveDataMap, saveDataConditionalFuncMap)
 end
+function ____exports.forceSaveDataManagerLoad(self)
+    if mod == nil then
+        return
+    end
+    loadFromDisk(nil, mod, saveDataMap)
+end
 return ____exports

package/dist/functions/collectibleSet.lua

@@ -5,8 +5,8 @@ local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local ____collectibles = require("functions.collectibles")
 local getMaxCollectibleID = ____collectibles.getMaxCollectibleID
-local ____util = require("functions.util")
-local copySet = ____util.copySet
+local ____set = require("functions.set")
+local copySet = ____set.copySet
 local COLLECTIBLE_SET = __TS__New(Set)
 local function initCollectibleSet(self)
     local itemConfig = Isaac.GetItemConfig()

package/dist/functions/globals.lua

@@ -8,9 +8,10 @@ local ____exports = {}
 local twoDimensionalSort
 local ____log = require("functions.log")
 local log = ____log.log
+local ____set = require("functions.set")
+local addSetsToSet = ____set.addSetsToSet
+local copySet = ____set.copySet
 local ____util = require("functions.util")
-local addSetsToSet = ____util.addSetsToSet
-local copySet = ____util.copySet
 local isLuaDebugEnabled = ____util.isLuaDebugEnabled
 function twoDimensionalSort(self, a, b)
     if a[1] == b[1] then

package/dist/functions/player.d.ts

@@ -131,6 +131,12 @@ export declare function getPlayerIndexVanilla(playerToFind: EntityPlayer): int |
  * Does not account for Broken Hearts; use the `getPlayerAvailableHeartSlots()` function for that.
  */
 export declare function getPlayerMaxHeartContainers(player: EntityPlayer): int;
+/**
+ * Helper function to get the proper name of the player. Use this instead of the
+ * `EntityPlayer.GetName` method because it accounts for Blue Baby, Lazarus II, and Tainted
+ * characters.
+ */
+export declare function getPlayerName(player: EntityPlayer): string;
 /**
  * Returns the combined value of all of the player's red hearts, soul/black hearts, and bone hearts,
  * minus the value of the player's rotten hearts.
@@ -207,6 +213,8 @@ export declare function isLost(player: EntityPlayer): boolean;
  * Deals. (e.g. The Lost, Tainted Lost, etc.)
  */
 export declare function canTakeFreeDevilDeals(player: EntityPlayer): boolean;
+/** Helper function for detecting if a player is one of the Tainted characters. */
+export declare function isTainted(player: EntityPlayer): boolean;
 /** Helper function for detecting when a player is Tainted Lazarus or Dead Tainted Lazarus. */
 export declare function isTaintedLazarus(player: EntityPlayer): boolean;
 export declare function removeCollectibleCostume(player: EntityPlayer, collectibleType: CollectibleType | int): void;

package/dist/functions/player.lua

@@ -9,7 +9,7 @@ local __TS__Iterator = ____lualib.__TS__Iterator
 local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
-local EXCLUDED_CHARACTERS
+local getAdjustedPlayerName, EXCLUDED_CHARACTERS
 local ____constants = require("constants")
 local CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART = ____constants.CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART
 local CHARACTERS_WITH_FREE_DEVIL_DEALS = ____constants.CHARACTERS_WITH_FREE_DEVIL_DEALS
@@ -30,6 +30,7 @@ local ____collectibleSet = require("functions.collectibleSet")
 local getCollectibleSet = ____collectibleSet.getCollectibleSet
 local ____util = require("functions.util")
 local ensureAllCases = ____util.ensureAllCases
+local trimPrefix = ____util.trimPrefix
 function ____exports.getCharacterMaxHeartContainers(self, character)
     if character == PlayerType.PLAYER_KEEPER then
         return 3
@@ -66,6 +67,29 @@ function ____exports.getPlayerMaxHeartContainers(self, player)
     end
     return maxHeartContainers
 end
+function getAdjustedPlayerName(self, player)
+    local character = player:GetPlayerType()
+    repeat
+        local ____switch71 = character
+        local ____cond71 = ____switch71 == PlayerType.PLAYER_BLUEBABY or ____switch71 == PlayerType.PLAYER_BLUEBABY_B
+        if ____cond71 then
+            do
+                return "Blue Baby"
+            end
+        end
+        ____cond71 = ____cond71 or ____switch71 == PlayerType.PLAYER_LAZARUS2
+        if ____cond71 then
+            do
+                return "Lazarus II"
+            end
+        end
+        do
+            do
+                return player:GetName()
+            end
+        end
+    until true
+end
 function ____exports.getPlayers(self, performExclusions)
     if performExclusions == nil then
         performExclusions = false
@@ -78,18 +102,18 @@ function ____exports.getPlayers(self, performExclusions)
             do
                 local player = Isaac.GetPlayer(i)
                 if player == nil then
-                    goto __continue70
+                    goto __continue77
                 end
                 if ____exports.isChildPlayer(nil, player) then
-                    goto __continue70
+                    goto __continue77
                 end
                 local character = player:GetPlayerType()
                 if performExclusions and EXCLUDED_CHARACTERS:has(character) then
-                    goto __continue70
+                    goto __continue77
                 end
                 __TS__ArrayPush(players, player)
             end
-            ::__continue70::
+            ::__continue77::
             i = i + 1
         end
     end
@@ -98,6 +122,10 @@ end
 function ____exports.isChildPlayer(self, player)
     return player.Parent ~= nil
 end
+function ____exports.isTainted(self, player)
+    local character = player:GetPlayerType()
+    return character >= PlayerType.PLAYER_ISAAC_B
+end
 EXCLUDED_CHARACTERS = __TS__New(Set, {PlayerType.PLAYER_ESAU, PlayerType.PLAYER_THESOUL_B})
 function ____exports.addCollectibleCostume(self, player, collectibleType)
     local itemConfig = Isaac.GetItemConfig()
@@ -307,6 +335,14 @@ function ____exports.getPlayerIndexVanilla(self, playerToFind)
     end
     return nil
 end
+function ____exports.getPlayerName(self, player)
+    local adjustedName = getAdjustedPlayerName(nil, player)
+    if not ____exports.isTainted(nil, player) then
+        return adjustedName
+    end
+    local baseName = trimPrefix(nil, adjustedName, "The ")
+    return "Tainted " .. baseName
+end
 function ____exports.getPlayerNumHitsRemaining(self, player)
     local hearts = player:GetHearts()
     local soulHearts = player:GetSoulHearts()
@@ -463,9 +499,9 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
         itemPool:RemoveCollectible(collectibleType)
     end
     repeat
-        local ____switch109 = activeSlot
-        local ____cond109 = ____switch109 == ActiveSlot.SLOT_PRIMARY
-        if ____cond109 then
+        local ____switch117 = activeSlot
+        local ____cond117 = ____switch117 == ActiveSlot.SLOT_PRIMARY
+        if ____cond117 then
             do
                 if primaryCollectibleType ~= CollectibleType.COLLECTIBLE_NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -474,8 +510,8 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond109 = ____cond109 or ____switch109 == ActiveSlot.SLOT_SECONDARY
-        if ____cond109 then
+        ____cond117 = ____cond117 or ____switch117 == ActiveSlot.SLOT_SECONDARY
+        if ____cond117 then
             do
                 if primaryCollectibleType ~= CollectibleType.COLLECTIBLE_NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -490,16 +526,16 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond109 = ____cond109 or ____switch109 == ActiveSlot.SLOT_POCKET
-        if ____cond109 then
+        ____cond117 = ____cond117 or ____switch117 == ActiveSlot.SLOT_POCKET
+        if ____cond117 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 player:SetActiveCharge(charge, activeSlot)
                 break
             end
         end
-        ____cond109 = ____cond109 or ____switch109 == ActiveSlot.SLOT_POCKET2
-        if ____cond109 then
+        ____cond117 = ____cond117 or ____switch117 == ActiveSlot.SLOT_POCKET2
+        if ____cond117 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 break

package/dist/functions/set.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Helper function to add all of the contents of one set to another set. The first set passed will
+ * be modified in place.
+ *
+ * This function is variadic, meaning that you can specify N sets to add to the first set.
+ */
+export declare function addSetsToSet<T>(mainSet: Set<T>, ...setsToAdd: Array<Set<T>>): void;
+/** Helper function to copy a set. (You can also use a Set constructor to accomplish this task.) */
+export declare function copySet<T>(oldSet: Set<T>): Set<T>;
+/**
+ * Helper function to create a new set that is the composition of two or more sets.
+ *
+ * This function is variadic, meaning that you can specify N sets.
+ */
+export declare function combineSets<T>(...sets: Array<Set<T>>): Set<T>;

package/dist/functions/set.lua

@@ -0,0 +1,32 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__Iterator = ____lualib.__TS__Iterator
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+function ____exports.addSetsToSet(self, mainSet, ...)
+    local setsToAdd = {...}
+    for ____, set in ipairs(setsToAdd) do
+        for ____, value in __TS__Iterator(set:values()) do
+            mainSet:add(value)
+        end
+    end
+end
+function ____exports.copySet(self, oldSet)
+    local newSet = __TS__New(Set)
+    for ____, value in __TS__Iterator(oldSet:values()) do
+        newSet:add(value)
+    end
+    return newSet
+end
+function ____exports.combineSets(self, ...)
+    local sets = {...}
+    local newSet = __TS__New(Set)
+    for ____, set in ipairs(sets) do
+        for ____, value in __TS__Iterator(set:values()) do
+            newSet:add(value)
+        end
+    end
+    return newSet
+end
+return ____exports

package/dist/functions/trinketSet.lua

@@ -3,10 +3,10 @@ local ____lualib = require("lualib_bundle")
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
+local ____set = require("functions.set")
+local copySet = ____set.copySet
 local ____trinkets = require("functions.trinkets")
 local getMaxTrinketID = ____trinkets.getMaxTrinketID
-local ____util = require("functions.util")
-local copySet = ____util.copySet
 local TRINKET_SET = __TS__New(Set)
 local function initTrinketSet(self)
     local itemConfig = Isaac.GetItemConfig()

package/dist/functions/util.d.ts

@@ -1,28 +1,10 @@
 /// <reference types="isaac-typescript-definitions" />
 /// <reference types="typescript-to-lua/language-extensions" />
-/**
- * Helper function to add all of the contents of one set to another set. The first set passed will
- * be modified in place.
- *
- * This function is variadic, meaning that you can specify N sets to add to the first set.
- */
-export declare function addSetsToSet<T>(mainSet: Set<T>, ...setsToAdd: Array<Set<T>>): void;
 /**
  * Using a Map constructor to copy a Map does not seem to work properly, so use this helper function
  * instead.
  */
 export declare function copyMap<K, V>(oldMap: Map<K, V>): Map<K, V>;
-/**
- * Using a Set constructor to copy a Set does not seem to work properly, so use this helper function
- * instead.
- */
-export declare function copySet<T>(oldSet: Set<T>): Set<T>;
-/**
- * Helper function to create a new set that is the composition of two or more sets.
- *
- * This function is variadic, meaning that you can specify N sets.
- */
-export declare function combineSets<T>(...sets: Array<Set<T>>): Set<T>;
 /**
  * Helper function to get type safety on a switch statement.
  * Very useful to be future-safe against people adding values to a type or an enum.
@@ -103,3 +85,5 @@ export declare function printConsole(msg: string): void;
  * `clear` method does not exist. Use this helper function as a drop-in replacement for this.
  */
 export declare function tableClear(table: LuaTable): void;
+/** Helper function to trim a prefix from a string, if it exists. Returns the trimmed string. */
+export declare function trimPrefix(string: string, prefix: string): string;

package/dist/functions/util.lua

@@ -1,23 +1,16 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____lualib = require("lualib_bundle")
-local Set = ____lualib.Set
-local __TS__Iterator = ____lualib.__TS__Iterator
 local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
+local __TS__Iterator = ____lualib.__TS__Iterator
 local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local __TS__ArraySort = ____lualib.__TS__ArraySort
 local __TS__StringReplace = ____lualib.__TS__StringReplace
 local __TS__StringSubstr = ____lualib.__TS__StringSubstr
+local __TS__StringStartsWith = ____lualib.__TS__StringStartsWith
+local __TS__StringSlice = ____lualib.__TS__StringSlice
 local ____exports = {}
 local HEX_STRING_LENGTH = 6
-function ____exports.addSetsToSet(self, mainSet, ...)
-    local setsToAdd = {...}
-    for ____, set in ipairs(setsToAdd) do
-        for ____, value in __TS__Iterator(set:values()) do
-            mainSet:add(value)
-        end
-    end
-end
 function ____exports.copyMap(self, oldMap)
     local newMap = __TS__New(Map)
     for ____, ____value in __TS__Iterator(oldMap:entries()) do
@@ -27,23 +20,6 @@ function ____exports.copyMap(self, oldMap)
     end
     return newMap
 end
-function ____exports.copySet(self, oldSet)
-    local newSet = __TS__New(Set)
-    for ____, value in __TS__Iterator(oldSet:values()) do
-        newSet:add(value)
-    end
-    return newSet
-end
-function ____exports.combineSets(self, ...)
-    local sets = {...}
-    local newSet = __TS__New(Set)
-    for ____, set in ipairs(sets) do
-        for ____, value in __TS__Iterator(set:values()) do
-            newSet:add(value)
-        end
-    end
-    return newSet
-end
 ____exports.ensureAllCases = function(____, obj) return obj end
 function ____exports.getEnumValues(self, transpiledEnum)
     local enumValues = {}
@@ -96,4 +72,10 @@ function ____exports.tableClear(self, ____table)
         ____table[key] = nil
     end
 end
+function ____exports.trimPrefix(self, ____string, prefix)
+    if not __TS__StringStartsWith(____string, prefix) then
+        return ____string
+    end
+    return __TS__StringSlice(____string, #prefix)
+end
 return ____exports

package/dist/index.d.ts

@@ -42,6 +42,7 @@ export * from "./functions/random";
 export * from "./functions/revive";
 export * from "./functions/rooms";
 export * from "./functions/seeds";
+export * from "./functions/set";
 export * from "./functions/spawnCollectible";
 export * from "./functions/sprite";
 export * from "./functions/stage";

package/dist/index.lua

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.7",
+  "version": "1.2.11",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -26,7 +26,7 @@
   ],
   "devDependencies": {
     "@zamiell/typescript-to-lua": "^1.4.0",
-    "isaac-typescript-definitions": "^1.0.335",
+    "isaac-typescript-definitions": "^1.0.336",
     "isaacscript-lint": "^1.0.79",
     "isaacscript-tsconfig": "^1.1.8",
     "typedoc": "^0.22.11",